Beyond Frameworks

Beyond FrameworksUsing Frameworks WithoutBecoming A Hostage To Them Stuart Herbert stuart@stuartherbert.com - http://blog.stuartherbert.com/php/

About Stuart • Head of Engineering, Gradwell.com • Co-author, Zend Certiﬁcation Study Guide for PHP 4 • Open-source Contributor Since 1994Beyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

Contents How Frameworks 1 Have Held Us HostageBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

Contents Our Layered Architecture 2 For PHP ApplicationsBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

Contents What Makes 3 A Good Component?Beyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

Contents How Components 4 Are Helping GradwellBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

Questions At The End, PleaseBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

Questions For The Audience ...Beyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

http://ﬂic.kr/p/R33dr Who Uses A Framework?Beyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

http://ﬂic.kr/p/qq6F1 Who Develops Software Products?Beyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

1: Hostages To FrameworksBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

Stop Me If You’ve Heard This One Before ...Beyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

First generation apps are highly-coupled Neat until you attempt to untangle them! http://ﬂic.kr/p/7MmEivBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

Second generation app built on top of own framework Developers enjoyed building it But they hated completing it or maintaining it http://ﬂic.kr/p/4sK29VBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

So We Used A Popular Framework ...Beyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

... Or Two ...Beyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

Third generation app easy to extend ... after the steep learning curve http://ﬂic.kr/p/2k87DMBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

We couldn’t get the code out to re-use in other apps :( http://ﬂic.kr/p/7132WmBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

What The Architecture Should Look Like Framework Your Code PluginsBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

What Happened In Reality :( Framework Your Code PluginsBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

What Practical Challenges Does This Create?Beyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

How long would it take to upgrade your app to the next major version of the framework? Would you do the upgrade, or stick with the current framework version? http://ﬂic.kr/p/5Z6ArfBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

What would it take to switch your app to a different framework? Could you port your code, or would you be forced to rewrite all or most of it? http://ﬂic.kr/p/4Z8oZEBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

How would you re-use some of your app’s code in a different app? Especially if the other app doesn’t use the same framework? http://ﬂic.kr/p/85jzRABeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

How would you outsource some of your app development to teams around the world? How would you accept the work delivered back to you? http://ﬂic.kr/p/6GMfQcBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

We Need To Change This ... Framework Your Code PluginsBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

To What ...?Beyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

2: Layered ApproachBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

Let’s Take The Original Architecture ... Application Frameworks Your Code PluginsBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

... And Make The App As Thin As Possible Application Frameworks App Code PluginsBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

By Extracting Out ... Application Frameworks App Code Plugins Business LogicBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

By Extracting Out ... Application Frameworks App Code Plugins Business Logic Data ModelBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

By Extracting Out ... Application Frameworks App Code Plugins Business Logic Data Model UtilitiesBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

... Into Independent Libraries Of Code Application Frameworks App Code Plugins Components Business Logic Data Model UtilitiesBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

Use An Autoloader To Pull In These New Components Application Frameworks App Code Plugins Autoloader Components Business Logic Data Model UtilitiesBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

This Gives You A Larger Set Of Reusable Code Application Frameworks App Code Plugins Autoloader Components Business Logic Data Model UtilitiesBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

The Frameworked App Becomes A Thin Layer On Top Of Framework-agnostic Reusable ComponentsBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

Layered Architecture Application Frameworks App Code Plugins Autoloader Components Business Logic Data Model UtilitiesBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

Layered Architecture Application ComponentsBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

Why Components? • Completely independent of Business Logic the framework • Built & tested in isolation of your app code Data Model • Can be built by different teams • Don’t have to change when Utilities the framework changesBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

Why Components? • Reduces the Big Ball of Business Logic String Syndrome • Mindset change to light apps on top of rich service layer Data Model • Improves development in parallel of apps & services • Injects additional discipline Utilities into development teamsBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

Others Already Do ThisBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

http://ﬂic.kr/p/5oewwy Perl Has CPAN ModulesBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

http://ﬂic.kr/p/uyMuU Ruby Has GemsBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

What Makes A Good Component?Beyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

3: Good ComponentsBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

Component Standards • Common standards • Reusable by many • Interoperable • TrustableBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

Good Components ... • Autoload • Are well tested • Are well documented • Are easy to install • Don’t break backwards compatibility by surpriseBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

Keep Components Outside Of Your App Application Frameworks App Code Plugins Components Business Logic Data Model UtilitiesBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

Use An Autoloader To Pull In Components Application Frameworks App Code Plugins Autoloader Components Business Logic Data Model UtilitiesBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

Why Use An Autoloader? Application Frameworks App Code Plugins Autoloader Components Business Logic Data Model UtilitiesBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

Autoloading Makes Life Easy! Application Frameworks App Code Plugins Autoloader Components Business Logic Data Model UtilitiesBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

One True Autoloader • Who has heard of PSR0? • http://groups.google.com/group/php- standards/web/psr-0-ﬁnal-proposal • Backed by leading names in the community • Perfect for a component approachBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

PSR0 Autoloader • Namespace separators ‘’ become DIRECTORY_SEPARATOR • Underscore in class names ‘_’ become DIRECTORY_SEPARATOR • Top namespace is your organisation • Achieves 1:1 mapping from classname to ﬁlename on diskBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

Autoloader Examples • Phin_ProjectExtenderLibFileLoader -> Phin_Project/ExtenderLib/FileLoader.php • Phin_ProjectConsoleStd_Out -> Phin_Project/Console/Std/Out.phpBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

Autoloader Component • pear channel-discover pear.gradwell.com • pear install Gradwell/AutoloaderBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

Testing http://ﬂic.kr/p/3c2W8qBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

PHPUnit • De-facto standard for unit-testing PHP code • Supported by leading IDEs • Supported by CI environments • Perfect for use with componentsBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

Good Tests ... • Document supported behaviour • Have separate tests for reported bugs • Cover 100% of the component’s code • Ship with the componentBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

Getting PHPUnit • Visit www.phpunit.deBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

Documentation http://ﬂic.kr/p/6wuB99Beyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

The PHP Manual Is One Of PHP’s Killer FeaturesBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

Make Your Documentation At Least As Good!Beyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

Good Documentation • Explain how to load the component • Describe how you intend it to be used • Give several (non-trivial!) examples • Capture notes / FAQsBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

Write It Down ... • ... so you don’t have to remember • ... so you don’t have to keep explaining it to others • ... so you don’t have to read the source • ... so that others are more likely to reuse your effortsBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

Docbook a la PHPUnit www.phpunit.de/manual/3.5/en/Beyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

What About phpDoc? • Useful for IDE code auto-completion • Useful as a summary of a method’s purpose • Reference documentation, not a manualBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

Packaging & Installation http://ﬂic.kr/p/41vMUJBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

PEAR Installer • Love it or hate it, PEAR package format is a community-created solution • PEAR installer found on most computers • Supports installing both system-wide and into a sandbox • Simple to publish your own package repoBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

Pirum http://www.pirum-project.org/Beyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

Your Own PEAR Channel pear channel-discover pear.gradwell.comBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

Phix For Making Components github.com/Gradwell/phixBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

Backwards Compatible http://ﬂic.kr/p/5aK8jABeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

Why It Matters • Isolating code into components reduces amount of code that is affected by change • Backwards-compatibility breaks immediately negate that advantage • The more apps use a component, the worse the b/c breakage cost scalesBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

Transparent Versions • X.Y.Z scheme • X == Major version / API / ABI version • Y == Minor new features • Z == Bug ﬁxesBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

You Can Break B/C • Just don’t do it by surprise! • Don’t be afraid to increment X in X.Y.Z • Google Chrome is already on 10.y.z ... • ... and it hasn’t done it any harmBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

To Recap ...Beyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

Good Components ... • Autoload • Are well tested • Are well documented • Are easy to install • Don’t break backwards compatibility by surpriseBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

... If They ... • PSR0 - compliant autoloading • PHPUnit tests • Docbook manual • Packages installed via PEAR installer • Transparent version numbersBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

4: An ExampleBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

We Sell Broadband Via Our Sales Website ... Sales Website Sales Pitch Product Specs Availability CheckerBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

And Our Customer Control Panel Sales Website Control Panel Customer Sales Pitch Account Product Specs Invoicing Availability Availability Checker CheckerBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

The Control Panel Holds The Code Hostage The Sales Site Relies On An iFrame Sales Website Control Panel Customer Sales Pitch Account Product Specs Invoicing iFrame Availability Availability Checker CheckerBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

... And The Control Panel Talks To The Third Party Who Provides Our BroadbandSales Website Control Panel Third Party Customer Sales Pitch Provisioning Account Product Specs Invoicing Faults Availability iFrame Availability SOAP Availability Checker Checker CheckerBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

We Wanted To Sell Exciting New Broadband Products From An Alternative Third Party As WellSales Website Control Panel Third Party Customer Sales Pitch Provisioning Account Product Specs Invoicing Faults Availability iFrame Availability SOAP Availability Checker Checker CheckerBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

Changing The Control Panel Was Going To Be Expensive ...Sales Website Control Panel Third Party Customer Sales Pitch Provisioning Account Product Specs Invoicing Faults Availability iFrame Availability SOAP Availability Checker Checker CheckerBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

... But Was The Only Way To Change The Sales WebsiteSales Website Control Panel Third Party Customer Sales Pitch Provisioning Account Product Specs Invoicing Faults Availability iFrame Availability SOAP Availability Checker Checker CheckerBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

Problem Is ... We Are Due To Retire This Control PanelSales Website Control Panel Third Party Customer Sales Pitch Provisioning Account Product Specs Invoicing Faults Availability Availability Availability Checker Checker CheckerBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

We Separated Out The Business Logic Of The Availability CheckerSales Website Third Party Sales Pitch Provisioning Product Specs Faults Availability Availability SOAP Availability Checker Checker CheckerBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

Sales Can Now Improve Their Website Without Having To Rely On Control Panel’s RoadmapSales Website Control Panel Third Party Customer Sales Pitch Provisioning Account Product Specs Invoicing Faults Availability Availability SOAP Availability Checker Checker CheckerBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

Allowing Engineering To Retire This Version Of The Control PanelSales Website Control Panel Third Party Customer Sales Pitch Provisioning Account Product Specs Invoicing Faults Availability Availability Availability Checker Checker CheckerBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

And The New Control Panel Will Simply Re-use The Component Before LaunchSales Website Control Panel 2 Third Party Customer Sales Pitch Provisioning Account Product Specs Invoicing Faults Availability Availability Availability Checker Checker CheckerBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

Moving To Components • Our customer proﬁle has changed • We have outgrown our old applications • We are refactoring all of the needed logic from our old applications • Allows Sales and Engineering roadmaps to move without major log jams • Allows more features (especially internal ones) to be shared across more of our appsBeyond Frameworks Stuart Herbert - http://blog.stuartherbert.com/php/

Thanks For Your TimeFeedback welcome!I’d love to hear your stories Stuart Herbert stuart@stuartherbert.com - http://blog.stuartherbert.com/php/

This photo: http://ﬂic.kr/p/3PU451 Stuart Herbertstuart@stuartherbert.com - http://blog.stuartherbert.com/php/

http://blog.stuartherbert.com	1614
http://sasezaki.hatenablog.com	608
http://www.planet-php.net	191
http://planet-php.org	18
http://www.planet-php.org	12
http://static.slidesharecdn.com	6
http://phpeye.com	6
http://www.netvibes.com	3
http://www.phpeye.com	3
http://paper.li	2
http://www.hanrss.com	2
http://xss.yandex.net	2
http://srukwebdev01.totemic.local	1
http://webcache.googleusercontent.com	1
http://headlines.bistoure.com	1
http://planet-php.net	1
http://www.google.co.il	1
http://www.linkedin.com	1

Beyond Frameworks

by Stuart Herbert

Accessibility

Categories

Upload Details

Usage Rights

18 Embeds 2,473

Statistics