Download as ODP, PPTX
![Registry Example: Hat Storage 1 < ?php 2 3 class HatRegistry { 4 private $registry ; 5 6 public function __construct () { 7 $this -> registry = array (); 8 } 9 10 public function registerHat ( $key , $hat ) { 11 $this -> registry [ $key ] = $hat ; 12 } 13 14 public function fetchHat ( $key ) { 15 return $this -> registry [ $key ]; 16 } 17 }](https://image.slidesharecdn.com/bestpracticestekx-100518105730-phpapp01/85/Best-practices-tekx-99-320.jpg)
![Registry Example: Hat Storage 1 < ?php 2 3 class HatRegistry { 4 private $registry ; 5 6 public function __construct () { 7 $this -> registry = array (); 8 } 9 10 public function registerHat ( $key , $hat ) { 11 $this -> registry [ $key ] = $hat ; 12 } 13 14 public function fetchHat ( $key ) { 15 return $this -> registry [ $key ]; 16 } 17 }](https://image.slidesharecdn.com/bestpracticestekx-100518105730-phpapp01/75/Best-practices-tekx-99-2048.jpg)
More Related Content
Best practices tekx
- 1. Best Practices MatthewWeier O'Phinney Zend Framework Lorna Jane Mitchell Ibuildings @lornajane @weierophinney
- 2. The Plan SourceControl
- 3.
- 4.
- 5.
- 6.
- 7. Quality and ContinuousIntegration
- 8.
- 9.
- 10. Source Control FeaturesVersion history of all files
- 11.
- 12. Authoritative version ofa project
- 13.
- 14. Using Source ControlCreate a repository, add project
- 15.
- 16.
- 17. Update to getother changes
- 18.
- 19. svn log ------------------------------------------------------------------------r3 | lornajane | 2010-04-25 10:32:09 +0100 (Sun, 25 Apr 2010) | 1 line adding documentation notes ------------------------------------------------------------------------ r2 | lornajane | 2010-04-22 09:07:56 +0100 (Thu, 22 Apr 2010) | 1 line outlining source control and design patterns sections ------------------------------------------------------------------------ r1 | weierophinney | 2010-03-30 17:37:27 +0100 (Tue, 30 Mar 2010) | 1 line Added readme with outline ------------------------------------------------------------------------
- 20. svn diff Index:README.txt =================================================================== --- README.txt (revision 3) +++ README.txt (revision 4) @@ -31,12 +35,20 @@ to share ideas to raise profile to be told you're doing it wrong! + (pulling up examples off our own blogs, if connection allows) Testing (Matthew) QA tools and CI including code analysis, mess detection, etc (Lorna - QA tools; Matthew - CI) + Static analysis + code sniffer + demo examples, find a suitable small codebase (joindin?) + mess detector + demo examples + what else? + Deployment
- 21. Source Control ToolsSubversion (svn) http://subversion.apache.org/ Git (git) http://git-scm.com/ Bazaar (bzr) http://bazaar.canonical.com/ Mercurial (hg) http://mercurial.selenic.com/
- 22. Accessing Source ControlIDE Plugins
- 23.
- 24.
- 25.
- 26.
- 27. Centralised Source Controluser repo user user user
- 28. Centralised Source ControlSingle repo (repository)
- 29. Always commit tocentral
- 30.
- 31. Repository Structure (FeatureBranches)
- 32. Repository Structure (Long-LivedBranches)
- 33. Repository Structure (ReleaseBranches)
- 34. Distributed Source Controlrepo repo repo repo repo
- 35. Distributed Source ControlMany repos
- 36. Commit to localrepo
- 37. Share changes betweenanywhere
- 38.
- 39. The Changing LandscapeVery active development area
- 40. Today's conclusions notvalid for long!
- 41. Bridges git-svn http://www.kernel.org/pub/software/scm/git/docs/git-svn.htmlbzr-svn https://launchpad.net/bzr-svn Check out from SVN to local repo
- 42. Make as manychanges/branches as you like
- 43. Push back toSVN
- 44. Hosted Solutions GitHubhttp://github.com/ git Bitbucket http://bitbucket.org/ hg Google Code http://code.google.com/ svn, hg Launchpad https://launchpad.net/ bzr SourceForge http://sourceforge.net/ svn, bzr, hg, git (and cvs)
- 45. What If IDon't Have Source Control? Get some :)
- 46.
- 47. Use a hostedsolution
- 48. Resources Talks atTEK-X Subversion in a Distributed World, Lorna Mitchell
- 49. Getting Git, TravisSwicegood (who literally wrote the book)
- 50. Both Wednesday afternoonSubversion book http://svnbook.red-bean.com/ Comparison of tools http://en.wikipedia.org/wiki/Comparison_of_revision_control_software
- 51.
- 52. You don't havea standard when … You always reformat code you get from others
- 53. Code you wrote6 months ago looks different than what you wrote today
- 54. Modifying old codeoften introduces new syntax errors
- 55. Answer the followingquestions: Can you read your own code?
- 56. Can others readyour code?
- 57. Can you readother's code?
- 58. Can you switchbetween code bases easily?
- 59. Analogy "Elements ofStyle" :: Writing Coding Standard :: Development
- 60. In sum, codingstandards assist in: Maintainability
- 61.
- 62. How CS aidsmaintainability: Code is structured predictably
- 63. How CS aidscollaboration Any developer can pick up and easily read existing code
- 64. … which in turn means they can maintain it
- 65. … which de-centralizes who is responsible for the code
- 66. … which means issues and reature requests are resolved faster
- 67. It democratizes code maintenance
- 68. Two pillars ofa Coding Standard: Consistency of file system layout
- 69. Consistency of code layout
- 70. Ancillary goal: Consistencyin naming
- 71. Use Public StandardsNIH has no place with CS You and your project's needs are not unique
- 72. What if youneed to consume and potentially help maintain 3rd party libraries?
- 73. Benefit from collectiveknowledge and empirical discoveries
- 74. Need more reasons?Objectivity Choices are no longer based on subjective preferences, but on empirical experience. Requirement when hiring or outsourcing Easily judge the candidate's experience and code quality. Compatibility Use a standard that follows that of the libraries you use.
- 75. Choices Horde/PEAR/Zend FrameworkAlso: Solar, AdoDB, Doctrine 2, Symfony 2, and more... eZcomponents/ZetaComponents
- 76.
- 77. Example <?php /*** In Foo/Bar.php */ class Foo_Bar { const BAZ = 'baz' ; protected $_bat ; public $bas ; public function bazBat( $someVar ) { if ( $someVar ) { echo 'Found' ; } } }
- 78.
- 79. http://pear.php.net/manual/en/pear2cs.php Zend Frameworkhttp://framework.zend.com/manual/en/coding-standard.html
- 80.
- 81. A Design PatternIs ... NOT rocket science
- 82. A common wayto describe a common problem
- 83.
- 84. A problem andsolution which is repeated many times
- 85. Common across programminglanguages
- 86.
- 87. Some Common PatternsFactory
- 88.
- 89.
- 90.
- 91.
- 92. Factory Has methodsto create and return objects
- 93. May return differentobjects
- 94. May use complex(and maintainable) logic to work out what to do
- 95. Factory Example: HatTypes 1 < ?php 2 3 require_once ( 'hat.php' ); 4 5 class HatFactory { 6 public function getHat ( $type = 'woolly' ) { 7 // perform any logic you like here 8 return new Hat ( $type ); 9 } 10 } http://www.flickr.com/photos/91524358@N00/2260054061/
- 96. Registry Can bea singleton (but this is not a requirement!)
- 97. Register objects here,access from elsewhere
- 98. Often a factory/registrycombination
- 99. Registry Example: HatStorage 1 < ?php 2 3 class HatRegistry { 4 private $registry ; 5 6 public function __construct () { 7 $this -> registry = array (); 8 } 9 10 public function registerHat ( $key , $hat ) { 11 $this -> registry [ $key ] = $hat ; 12 } 13 14 public function fetchHat ( $key ) { 15 return $this -> registry [ $key ]; 16 } 17 }
- 100. Adapter Adapts a specific interface to fit something else; typically, to provide a common API to related classes/components that have divergent APIs.
- 101. Allows the classwrapped by the adapter to exist independently from the component consuming the adapter.
- 102. Adapter Example: SOAPto REST Real life example
- 103. Client project todeliver SOAP
- 104. PHP SOAP 1 < ?php 2 3 require_once ( 'lib/myClass.php' ); 4 5 $server = new SoapServer ( null , $options ); 6 $server -> setClass ( "MyClass" ); 7 $server -> handle ();
- 105. Adapter Example: SOAPto REST Real life example
- 106. Client project todeliver SOAP
- 107.
- 108.
- 109.
- 110. Adapter class tothe rescue!
- 111. Adapter Example: SOAPto REST myClass index.php
- 112. Adapter Example: SOAPto REST myClass index.php Adapter
- 113. Decorator Wraps anotherclass in order to modify its behavior
- 114. Target class doesn'tchange
- 115. Decorating class oftenimplements the same interface(s)
- 116. Can be visually decorative, not always
- 117. Decorator Example 1 < ?php 2 3 interface LabelInterface { 4 public function render (); 5 } 6 7 class BasicLabel implements LabelInterface { 8 public function render () { 9 return $this -> label ; 10 } 11 }
- 118. Decorator Example 13 abstract class LabelDecorator implements LabelInterface { 14 public function __construct ( LabelInterface $label ) { 15 $this -> label = $label ; 16 } 17 } 18 19 class LabelStarDecorator extends LabelDecorator { 20 public function render () { 21 return '** ' . $this -> label -> render () . ' **' ; 22 } 23 } 24 25 class LabelNewLineDecorator extends LabelDecorator { 26 public function render () { 27 return $this -> label -> render () . " \n " ; 28 } 29 } 30 31 class LabelHyphenDecorator extends LabelDecorator { 32 public function render () { 33 return str_replace ( ' ' , '-' , $this -> label -> render ()); 34 } 35 }
- 119. Decorator Example 1 < ?php 2 3 require_once ( 'Label.php' ); 4 5 $basic_label = new BasicLabel (); 6 $basic_label -> label = "Hello World" ; 7 echo $basic_label -> render (); 8 9 $label = new LabelNewLineDecorator ( new LabelStarDecorator ( $basic_label )); 10 $label = new LabelNewLineDecorator ( new LabelStarDecorator ( new LabelHyphenDecorator ( $basic_label ))); 11 $label = new LabelNewLineDecorator ( new LabelHyphenDecorator ( new LabelStarDecorator ( $basic_label )));
- 120. Observer Watches forchanges in another object
- 121. Responds to thosechanges
- 122. Target class isaware, notifies observing classes
- 123. Example: a mapshowing where event attendees are located - needs to update when list updates
- 124. Observer Example 3 class AttendeeList { 4 private $attendees ; 5 private $observers ; 6 7 public function addAttendee ( $id , $name ) { 8 $this -> attendees [ $id ] = $name ; 9 $this -> notify (); 10 } 11 12 public function removeAttendee ( $id ) { 13 unset ( $this -> attendees [ $id ]); 14 $this -> notify (); 15 } 16 17 public function notify () { 18 foreach ( $this -> observers as $ob ) { 19 $ob -> update ( $this ); 20 } 21 } 22 23 public function registerObserver ( $observer ) { 24 $this -> observers [] = $observer ; 25 } 26 }
- 125. Observer Example AttendeeListMap Invites ...
- 126. Resources Books Design Patterns: Elements of Reusable Object-Oriented Software by Erich Gamma, Richard Helm, Ralph Johnson and John Vlissides ("Gang of Four")
- 127. php|architect’s Guide toPHP Design Patterns by Jason Sweat
- 128. Patterns of EnterpriseApplication Architecture by Martin Fowler ("PoEAA") Jason Sweat speaking on Design Patterns (Friday morning at TEK-X)
- 129.
- 130.
- 131. API Docs Documentationgenerated from source code itself
- 132. Follows code structureclasses
- 133.
- 134.
- 135.
- 136.
- 137. PHPDocumentor PHPDocumentor http://www.phpdoc.org/Uses reflection
- 138. Comments for additionalinformation
- 139. Add descriptions tothe documentation
- 140. PHPDocumentor Comments 1 < ?php 2 3 class AttendeeList { 4 private $attendees ; 5 private $observers ; 6 7 /** 8 * Add an attendee to the list 9 * 10 * @param integer $id Attendee identifier/array index 11 * @param string $name Full name of the attendee 12 * @access public 13 * @return boolean If attendee was successfully added 14 */ 15 public function addAttendee ( $id , $name ) { 16 $this -> attendees [ $id ] = $name ; 17 $this -> notify (); 18 } 19 20 }
- 141. Generating PHPDoc OutputTwo main interfaces Command line, e.g. phpdoc -o HTML:frames:earthli -f sample1.php -t docs Web Interface IDE Plugins
- 142.
- 143. Come again? Narrativedocumentation for developers
- 144. Often describes architecture,theory, and design patterns used
- 145. Typically includes manyexample use cases
- 146. What should youuse? Wikis Easy for others to contribute
- 147. Typically un-distributable, nevermind offer in alternate formats
- 148.
- 149.
- 150. What should youuse? HTML Easy for people with any web background to contribute
- 151. Distributable, but difficultto offer in alternate formats
- 152.
- 153.
- 154. What should youuse? Docbook XML Reasonably easy for people with a web background to contribute; easier if you establish standards
- 155. Distributable, and trivialto offer in alternate formats (e.g., HTML, Windows Help files (CHM), PDF, man pages, etc.)
- 156.
- 157.
- 158. Docbook Example <?xml version = "1.0" encoding = "UTF-8" ?> <sect1 id = "some.component" > <title> Using Some Component </title> <para> This is a thorougly magical, catch-all component. <ulink url = "http://wikipedia.com/" > Wikipedia </ulink> may have more info. </para>
- 159. Docbook Example <example id = "some.component.example" > <title> Example </title> <programlisting lang = "php" > <![CDATA[ $foo = new Component(); ]] ></programlisting> </example>
- 160. Docbook Example <sect2 id = "some.component.more-info" > <title> More information </title> <itemizedlist> <listitem><para> Not much! </para></listitem> </itemizedlist> </sect2> </sect1>
- 161. Tools You WillNeed xsltproc http://xmlsoft.org/XSLT/xsltproc2.html PhD (PHP Documentor) http://doc.php.net/phd/docs/
- 162. Beyond API DocsTutorials
- 163.
- 164.
- 165.
- 166.
- 167.
- 168. Be a User-ContributorAnswer forum questions
- 169. Hang out onthe IRC channel
- 170. Help with officialproject documentation
- 171.
- 172.
- 173.
- 174. Why Test? Makesfuture maintenance of the code easier Defined expectations
- 175.
- 176. Identify early whenchanges in code break existing behaviors
- 177. Why Test? Quantifythe quality of your code Code coverage (not the best metric)
- 178. Self-documented behaviors viaunit tests
- 179. Why Test? Warmfuzzy feeling from seeing green
- 180. What testing isnot: Reloading
- 181. What testing isnot: var_dump()
- 182. Testing is … Reproducible
- 183. Testing is … Automatable
- 184. Good testing includes … Defined behaviors
- 185. Code examples ofuse cases
- 186.
- 187. Testing frameworks PHPTUsed by PHP project, some PEAR libraries SimpleTest JUnit style testing framework PHPUnit JUnit style testing framework; de facto standard
- 188. How to testCreate a test case class Usually named after the unit or class you're testing class Css2XpathTest extends PHPUnit_Framework_TestCase
- 189. How to testWhat is the behavior you're testing? State it in your native language "Should Allow Whitespace In Descendent Selector Expressions"
- 190. Create a methodnamed after the behavior public function testShouldAllowWhitespaceInDescendentSelectorExpressions()
- 191. Capture the codethat should create the behavior $test = Css2Xpath::transform('child > leaf');
- 192. Create assertions indicatingthe expected results $this->assertEquals("//child/leaf", $test);
- 193. How to testRun the tests Success? Move on to the next behavior
- 194. Failure? Check yourtest assumptions and assertions
- 195. Check your codeand correct it
- 196. Re-run the teststo verify
- 197. Other Testing TopicsTest Doubles Stubs Replacing an object with another so that the system under test can continue down a path.
- 198. Mock Objects Replacingan object with another and defining expectations for it.
- 199. Other Testing TopicsTest Coverage What lines were executed, and how many times?
- 200. Conditional tests Testingonly when certain environmental conditions are met.
- 201. Functional and Integrationtests Testing that the systems a unit interacts with all respond as expected.
- 202. Adding tests toexisting, untested projects Create tests: Whenever you introduce new features, for those features
- 203. Whenever you attemptto fix a bug Capture the desired behavior in a unit test
- 204. Fix the bugWhenever you refactor
- 205. Test-Driven Development Capturebehaviors individually and iteratively in unit tests
- 206. Write code tomake the tests pass
- 207. Allows for playingwith APIs before you've committed to coding them
- 208. Often hard toget into the rhythm; once you do, often hard to quit
- 209. Takeaways Testing iseasy class Css2XpathTest extends PHPUnit_Framework_TestCase { public function testShouldAllowWSInDescendentSctrExpressions() { $test = Css2Xpath::transform( 'child > leaf' ); $this ->assertEquals( "//child/leaf" , $test ); } }
- 210. Takeaways Test wheneveryou can -- preferably ALWAYS
- 211. Automate your testsuite (next topic!)
- 212.
- 213. Static Analysis Analysingcode without execution
- 214. Evaluating code propertiesand patterns
- 215. Common tools Linesof code ( http://github.com/sebastianbergmann/phploc )
- 216. Code sniffer (http://pear.php.net/PHP_CodeSniffer )
- 217. Mess detector (http://phpmd.org/ )
- 218. Lines of CodeBorn from PHPUnit
- 219. Available via PHPUnit'sPEAR channel
- 220. Shows lots ofstats about a codebase
- 221. Methods, lines permethod
- 222. Cyclomatic complexity: ameasure of branching points in code
- 223. E.g. when appliedto wordpress:
- 224. Lines of CodeExample * phploc 1.3.2 by Sebastian Bergmann. Directories: 29 Files: 295 Lines of Code (LOC): 138661 Cyclomatic Complexity / Lines of Code: 0.19 Comment Lines of Code (CLOC): 43498 Non-Comment Lines of Code (NCLOC): 95163 * example from http://techportal.ibuildings.com/2010/01/28/phploc-php-lines-of-code/
- 225. Lines of CodeExample Interfaces: 0 Classes: 168 Abstract: 0 (0.00%) Concrete: 168 (100.00%) Lines of Code / Number of Classes: 377 Methods: 1973 Scope: Non-Static: 1972 (99.95%) Static: 1 (0.05%) Visibility: Public: 1964 (99.54%) Non-Public: 9 (0.46%) Lines of Code / Number of Methods: 32 Cyclomatic Complexity / Number of Methods: 5.44 Functions: 1599 Constants: 272 Global constants: 272 Class constants: 0
- 226. Code Sniffer Associatedwith coding standards
- 227. Configurable "sniffs" tolook for different properties
- 228. Code Sniffer Example* 1 < ?php 2 3 class recipe 4 { 5 6 protected $_id ; 7 8 public $name ; 9 10 public $prep_time ; 11 12 function getIngredients () { 13 $ingredients = Ingredients :: fetchAllById ( $this -> _id ); 14 return $ingredients ; 15 } 16 } * example from http://techportal.ibuildings.com/2009/10/12/usphp_code_sniffer/
- 229. Code Sniffer ExampleFILE: /home/lorna/phpcs/recipe.php ------------------------------------------------------------------- FOUND 8 ERROR(S) AND 0 WARNING(S) AFFECTING 5 LINE(S) ------------------------------------------------------------------- 2 | ERROR | Missing file doc comment 3 | ERROR | Class name must begin with a capital letter 3 | ERROR | Missing class doc comment 6 | ERROR | Protected member variable "_id" must not be prefixed | | with an underscore 12 | ERROR | Missing function doc comment 12 | ERROR | Opening brace should be on a new line 13 | ERROR | Line indented incorrectly; expected at least 8 | | spaces, found 1 13 | ERROR | Spaces must be used to indent lines; tabs are not | | allowed ------------------------------------------------------------------- output of running recipe.php through PEAR sniffs
- 230. Mess Detector Usessome "rule of thumb" metrics
- 231. Tells you aboutthe codebase, at a macro level
- 232. Can catch longclass/method names and parametere lists
- 233.
- 234. classes with toomany public methods
- 235. other "bad smells"Under development
- 236.
- 237. Continu … what?Originally, automated build systems for compiled languages
- 238. Used in PHPto run unit tests, build documentation, etc.
- 239. Basically, any documentationor QA tool we've talked about can and should be automated
- 240. Basics System typicallymonitors commits Have a post-receive/commit hook trigger a build
- 241. Have cron/sleep processesthat periodically wake up and check for new commits A PHP Build … Runs tests,
- 242. Runs QA tools(mess detection, etc.),
- 243.
- 244. Solutions Ant: http://ant.apache.org/ Not CI by itself, but a build system <?xml version = "1.0" encoding = "UTF-8" ?> <project name = "zend_framework_current" default = "build" basedir = "." > <property name = "output.dir" value = "${basedir}/build" /> <target name = "build" depends = "clean, checkout, apidoc, test" /> <target name = "checkout" > <exec executable = "svn" dir = "${basedir}" > <arg line = "co http://framework.zend.com/svn/framework/branch/release-1.10 source" /> </exec> </target> <!-- ... --> </project>
- 245. Solutions Phing: http://phing.info/trac/ PHP Ant clone; again, not CI, but a build tool <?xml version = "1.0" encoding = "UTF-8" ?> <project name = "tekx" basedir = "." > <property file = "build.properties" /> <target name = "default" > <echo message = "Hello, attendees!" /> </target> </project>
- 246. Solutions CruiseControl: http://cruisecontrol.sourceforge.net/ Uses Ant under the hood <cruisecontrol> <project name = "zend_framework_current" <schedule interval = "86400" > <ant anthome = "apache-ant-1.7.0" buildfile = "projects/${proje </schedule> <modificationset quietperiod = "0" > <svn LocalWorkingCopy = "projects </modificationset>
- 247.
- 248. Solutions phpUnderControl: http://www.phpundercontrol.org/ Superset of CruiseControl with built-in support for PHPUnit, CodeSniffer, and more.
- 249. Solutions Hudson: http://hudson-ci.org/ Oracle OSS project, written in Java, under active development.
- 250. Also uses Antfor build configuration
- 251. PHPUnit support viaa generic xUnit plugin
- 252. Support for otherPHP tasks via a Phing plugin
- 253. Solutions Bamboo: http://www.atlassian.com/software/bamboo/ Commercial Java CI solution
- 254. Can use Antor Maven
- 255. Most PHP QAtools export logs to formats compatible with equivalent Java tools; Bamboo simply uses these logs.
- 256. Takeaways Automate yourQA tasks Find issues early
- 257. Fix them beforedeployment Use continuous integration solutions to perform the automation
- 258. Resources Sebastian Bergmann'stalk "The State of QA Tools in PHP"
- 259.
- 260.
- 261.
- 262. Why You NeedA Process Many steps for live deploy
- 263. Wrap into onestep, you won't miss anything
- 264. It'll be donethe same way by everyone
- 265. You can rollback (if you build that into your process)
- 266. Deployment Tools Hand-spunscripts
- 267. Phing http://phing.info/trac/ Capistrano(Ruby) http://www.capify.org/index.php/Capistrano
- 268.
- 269.
- 270.
- 271.