Merge branch 'feature/coding-standards'

AbstractFactory/AbstractFactory.php

@@ -28,6 +28,7 @@ abstract class AbstractFactory
      * Creates a text component
      * 
      * @param string $content
+     *
      * @return Text
      */
     abstract public function createText($content);
@@ -37,6 +38,7 @@ abstract class AbstractFactory
      * 
      * @param string $path
      * @param string $name
+     *
      * @return Picture
      */
     abstract public function createPicture($path, $name = '');

AbstractFactory/Html/Picture.php

@@ -11,7 +11,6 @@ use DesignPatterns\AbstractFactory\Picture as BasePicture;
  */
 class Picture extends BasePicture
 {
-
     /**
      * some crude rendering from HTML output
      *
@@ -19,7 +18,6 @@ class Picture extends BasePicture
      */
     public function render()
     {
-        return sprintf('<img src="%s" title="$s"/>', $this->_path, $this->_name);
+        return sprintf('<img src="%s" title="$s"/>', $this->path, $this->name);
     }
-
 }

AbstractFactory/Html/Text.php

@@ -11,7 +11,6 @@ use DesignPatterns\AbstractFactory\Text as BaseText;
  */
 class Text extends BaseText
 {
-
     /**
      * some crude rendering from HTML output
      *
@@ -19,7 +18,6 @@ class Text extends BaseText
      */
     public function render()
     {
-        return '<div>' . htmlspecialchars($this->_text) . '</div>';
+        return '<div>' . htmlspecialchars($this->text) . '</div>';
     }
-
 }

AbstractFactory/HtmlFactory.php

@@ -9,12 +9,12 @@ namespace DesignPatterns\AbstractFactory;
  */
 class HtmlFactory extends AbstractFactory
 {
-
     /**
      * Creates a picture component
      *
      * @param string $path
      * @param string $name
+     *
      * @return Html\Picture|Picture
      */
     public function createPicture($path, $name = '')
@@ -26,11 +26,11 @@ class HtmlFactory extends AbstractFactory
      * Creates a text component
      *
      * @param string $content
+     *
      * @return Html\Text|Text
      */
     public function createText($content)
     {
         return new Html\Text($content);
     }
-
 }

AbstractFactory/Json/Picture.php

@@ -11,7 +11,6 @@ use DesignPatterns\AbstractFactory\Picture as BasePicture;
  */
 class Picture extends BasePicture
 {
-
     /**
      * some crude rendering from JSON output
      *
@@ -19,7 +18,6 @@ class Picture extends BasePicture
      */
     public function render()
     {
-        return json_encode(array('title' => $this->_name, 'path' => $this->_path));
+        return json_encode(array('title' => $this->name, 'path' => $this->path));
     }
-
 }

AbstractFactory/Json/Text.php

@@ -11,7 +11,6 @@ use DesignPatterns\AbstractFactory\Text as BaseText;
  */
 class Text extends BaseText
 {
-
     /**
      * some crude rendering from JSON output
      *
@@ -19,7 +18,6 @@ class Text extends BaseText
      */
     public function render()
     {
-        return json_encode(array('content' => $this->_text));
+        return json_encode(array('content' => $this->text));
     }
-
 }

AbstractFactory/JsonFactory.php

@@ -16,6 +16,7 @@ class JsonFactory extends AbstractFactory
      *
      * @param string $path
      * @param string $name
+     *
      * @return Json\Picture|Picture
      */
     public function createPicture($path, $name = '')
@@ -23,16 +24,15 @@ class JsonFactory extends AbstractFactory
         return new Json\Picture($path, $name);
     }
 
-
     /**
      * Creates a text component
      *
      * @param string $content
+     *
      * @return Json\Text|Text
      */
     public function createText($content)
     {
         return new Json\Text($content);
     }
-
 }

AbstractFactory/MediaInterface.php

@@ -3,12 +3,12 @@
 namespace DesignPatterns\AbstractFactory;
 
 /**
- * Interface Media
+ * Interface MediaInterface
  *
  * This contract is not part of the pattern, in general case, each component
  * are not related
  */
-interface Media
+interface MediaInterface
 {
 
     /**
@@ -16,5 +16,5 @@ interface Media
      *
      * @return string
      */
-    function render();
+    public function render();
 }

AbstractFactory/Picture.php

@@ -5,7 +5,7 @@ namespace DesignPatterns\AbstractFactory;
 /**
  * Class Picture
  */
-abstract class Picture implements Media
+abstract class Picture implements MediaInterface
 {
 
     /**

AbstractFactory/Text.php

@@ -5,7 +5,7 @@ namespace DesignPatterns\AbstractFactory;
 /**
  * Class Text
  */
-abstract class Text implements Media
+abstract class Text implements MediaInterface
 {
     /**
      * @var string

Adapter/Book.php

@@ -1,9 +1,5 @@
 <?php
 
-/*
- * DesignPatternPHP
- */
-
 namespace DesignPatterns\Adapter;
 
 /**
@@ -11,15 +7,19 @@ namespace DesignPatterns\Adapter;
  */
 class Book implements PaperBookInterface
 {
-
+    /**
+     * {@inheritdoc}
+     */
     public function open()
     {
-        
+
     }
 
+    /**
+     * {@inheritdoc}
+     */
     public function turnPage()
     {
-        
-    }
 
-}
+    }
+}

Adapter/EBookAdapter.php

@@ -1,26 +1,26 @@
 <?php
 
-/*
- * DesignPatternPHP
- */
-
 namespace DesignPatterns\Adapter;
 
 /**
- * ElecBookAdapter is an adapter to fit an e-book like a paper book
+ * EBookAdapter is an adapter to fit an e-book like a paper book
  * 
  * This is the adapter here. Notice it implemennts PaperBookInterface,
  * therefore you don't have to change the code of the client which using paper book.
  */
-class ElecBookAdapter implements PaperBookInterface
+class EBookAdapter implements PaperBookInterface
 {
-
+    /**
+     * @var EBookInterface
+     */
     protected $eBook;
 
     /**
      * Notice the constructor, it "wraps" an electronic book
+     *
+     * @param EBookInterface $ebook
      */
-    public function __construct(ElecBookInterface $ebook)
+    public function __construct(EBookInterface $ebook)
     {
         $this->eBook = $ebook;
     }
@@ -33,9 +33,11 @@ class ElecBookAdapter implements PaperBookInterface
         $this->eBook->pressStart();
     }
 
+    /**
+     * turns pages
+     */
     public function turnPage()
     {
         $this->eBook->pressNext();
     }
-
+}
-}

Adapter/EBookInterface.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace DesignPatterns\Adapter;
+
+/**
+ * EBookInterface is a contract for an electronic book
+ */
+interface EBookInterface
+{
+    /**
+     * go to next page
+     *
+     * @return mixed
+     */
+    public function pressNext();
+
+    /**
+     * start the book
+     *
+     * @return mixed
+     */
+    public function pressStart();
+}

Adapter/ElecBookInterface.php

@@ -1,18 +0,0 @@
-<?php
-
-/*
- * DesignPatternPHP
- */
-
-namespace DesignPatterns\Adapter;
-
-/**
- * ElecBookInterface is a contract for an electronic book
- */
-interface ElecBookInterface
-{
-
-    function pressNext();
-
-    function pressStart();
-}

Adapter/Kindle.php

@@ -1,27 +1,25 @@
 <?php
 
-/*
- * DesignPatternPHP
- */
-
 namespace DesignPatterns\Adapter;
 
 /**
  * Kindle is a concrete electronic book
- *
- * @author flo
  */
-class Kindle implements ElecBookInterface
+class Kindle implements EBookInterface
 {
-
+    /**
+     * {@inheritdoc}
+     */
     public function pressNext()
     {
-        
+
     }
 
+    /**
+     * {@inheritdoc}
+     */
     public function pressStart()
     {
-        
-    }
 
-}
+    }
+}

Adapter/PaperBookInterface.php

@@ -1,9 +1,5 @@
 <?php
 
-/*
- * DesignPatternPHP
- */
-
 namespace DesignPatterns\Adapter;
 
 /**
@@ -11,8 +7,17 @@ namespace DesignPatterns\Adapter;
  */
 interface PaperBookInterface
 {
+    /**
+     * method to turn pages
+     *
+     * @return mixed
+     */
+    public function turnPage();
 
-    function turnPage();
+    /**
-
+     * method to open the book
-    function open();
+     *
-}
+     * @return mixed
+     */
+    public function open();
+}

Builder/BikeBuilder.php

@@ -1,43 +1,55 @@
 <?php
 
-/*
- * DesignPatternPHP
- */
-
 namespace DesignPatterns\Builder;
 
 /**
  * BikeBuilder builds bike
  */
-class BikeBuilder implements Builder
+class BikeBuilder implements BuilderInterface
 {
-
+    /**
+     * @var Parts\Bike
+     */
     protected $bike;
 
+    /**
+     * {@inheritdoc}
+     */
     public function addDoors()
     {
-        
+
     }
 
+    /**
+     * {@inheritdoc}
+     */
     public function addEngine()
     {
         $this->bike->setPart('engine', new Parts\Engine());
     }
 
+    /**
+     * {@inheritdoc}
+     */
     public function addWheel()
     {
         $this->bike->setPart('forwardWheel', new Parts\Wheel());
         $this->bike->setPart('rearWheel', new Parts\Wheel());
     }
 
+    /**
+     * {@inheritdoc}
+     */
     public function createVehicle()
     {
         $this->bike = new Parts\Bike();
     }
 
+    /**
+     * {@inheritdoc}
+     */
     public function getVehicle()
     {
         return $this->bike;
     }
-
+}
-}

Builder/BuilderInterface.php

@@ -1,9 +1,5 @@
 <?php
 
-/*
- * DesignPatternPHP
- */
-
 namespace DesignPatterns\Builder;
 
 /**
@@ -18,16 +14,30 @@ namespace DesignPatterns\Builder;
  * Note: Builders have often a fluent interface, see the mock builder of
  * PHPUnit for example.
  */
-interface Builder
+interface BuilderInterface
 {
+    /**
+     * @return mixed
+     */
+    public function createVehicle();
 
-    function createVehicle();
+    /**
+     * @return mixed
+     */
+    public function addWheel();
 
-    function addWheel();
+    /**
+     * @return mixed
+     */
+    public function addEngine();
 
-    function addEngine();
+    /**
+     * @return mixed
+     */
+    public function addDoors();
 
-    function addDoors();
+    /**
-
+     * @return mixed
-    function getVehicle();
+     */
-}
+    public function getVehicle();
+}

Builder/CarBuilder.php

@@ -1,30 +1,37 @@
 <?php
 
-/*
- * DesignPatternPHP
- */
-
 namespace DesignPatterns\Builder;
 
 /**
  * CarBuilder builds car
  */
-class CarBuilder implements Builder
+class CarBuilder implements BuilderInterface
 {
-
+    /**
+     * @var Parts\Car
+     */
     protected $car;
 
+    /**
+     * @return void
+     */
     public function addDoors()
     {
         $this->car->setPart('rightdoor', new Parts\Door());
         $this->car->setPart('leftDoor', new Parts\Door());
     }
 
+    /**
+     * @return void
+     */
     public function addEngine()
     {
         $this->car->setPart('engine', new Parts\Engine());
     }
 
+    /**
+     * @return void
+     */
     public function addWheel()
     {
         $this->car->setPart('wheelLF', new Parts\Wheel());
@@ -33,14 +40,19 @@ class CarBuilder implements Builder
         $this->car->setPart('wheelRR', new Parts\Wheel());
     }
 
+    /**
+     * @return void
+     */
     public function createVehicle()
     {
         $this->car = new Parts\Car();
     }
 
+    /**
+     * @return Parts\Car
+     */
     public function getVehicle()
     {
         return $this->car;
     }
-
+}
-}

Builder/Director.php

@@ -1,9 +1,5 @@
 <?php
 
-/*
- * DesignPatternPHP
- */
-
 namespace DesignPatterns\Builder;
 
 /**
@@ -18,8 +14,12 @@ class Director
 
     /**
      * The director don't know 'bout concrete part
+     *
+     * @param BuilderInterface $builder
+     *
+     * @return Parts\Vehicle
      */
-    public function build(Builder $builder)
+    public function build(BuilderInterface $builder)
     {
         $builder->createVehicle();
         $builder->addDoors();
@@ -28,5 +28,4 @@ class Director
 
         return $builder->getVehicle();
     }
-
+}
-}

Builder/Parts/Bike.php

@@ -1,9 +1,5 @@
 <?php
 
-/*
- * DesignPatternPHP
- */
-
 namespace DesignPatterns\Builder\Parts;
 
 /**
@@ -11,5 +7,5 @@ namespace DesignPatterns\Builder\Parts;
  */
 class Bike extends Vehicle
 {
-    
+
-}
+}

Builder/Parts/Car.php

@@ -1,9 +1,5 @@
 <?php
 
-/*
- * DesignPatternPHP
- */
-
 namespace DesignPatterns\Builder\Parts;
 
 /**
@@ -11,5 +7,5 @@ namespace DesignPatterns\Builder\Parts;
  */
 class Car extends Vehicle
 {
-    
+
-}
+}

Builder/Parts/Door.php

@@ -2,7 +2,10 @@
 
 namespace DesignPatterns\Builder\Parts;
 
+/**
+ * Class Door
+ */
 class Door
 {
-    
+
-}
+}

Builder/Parts/Engine.php

@@ -2,7 +2,10 @@
 
 namespace DesignPatterns\Builder\Parts;
 
+/**
+ * Class Engine
+ */
 class Engine
 {
-    
+
-}
+}

Builder/Parts/Vehicle.php

@@ -1,22 +1,23 @@
 <?php
 
-/*
- * DesignPatternPHP
- */
-
 namespace DesignPatterns\Builder\Parts;
 
 /**
- * Vehicle is a contract for a vehicle
+ * VehicleInterface is a contract for a vehicle
  */
 abstract class Vehicle
 {
-
+    /**
+     * @var array
+     */
     protected $data;
 
+    /**
+     * @param string $key
+     * @param mixed  $value
+     */
     public function setPart($key, $value)
     {
         $this->data[$key] = $value;
     }
-
+}
-}

Builder/Parts/Wheel.php

@@ -2,7 +2,10 @@
 
 namespace DesignPatterns\Builder\Parts;
 
+/**
+ * Class Wheel
+ */
 class Wheel
 {
-    
+
-}
+}

ChainOfResponsibilities/ChainOfResponsibilities.php

@@ -1,96 +0,0 @@
-<?php
-
-namespace DesignPatterns;
-
-/**
- * chain of responsibilities pattern
- *
- * Purpose:
- * to build a chain of objects to handle a call. if one object cannot handle a call, it delegates the call to the next
- * in the chain and so forth
- *
- * Examples:
- * - logging framework
- * - spam filter
- * - Caching: first object is an instance of e.g. a Memcached Interface, if that "misses" it delegates the call to the
- *   Database Interface
- * - Yii Framework: CFilterChain is a chain of controller action filters. the executing point is passed from one filter
- *   to the next along the chain, and only if all filters say "yes", the action can be invoked at last.
- *
- */
-
-// the idea is good but in general, the Handler component in this pattern 
-// is an abstract class which makes much more of the work
-interface KeyValueStorage
-{
-    public function get($key);
-}
-
-class SlowStorage implements KeyValueStorage
-{
-    protected $_data = array();
-
-    public function __construct($data = array())
-    {
-        $this->_data = $data;
-    }
-
-    /**
-     * this class has no next handler, so it MUST be able to handle all requests
-     *
-     * @param $key
-     * @return mixed
-     */
-    public function get($key)
-    {
-        return $this->_data[$key];
-    }
-}
-
-class FastStorage implements KeyValueStorage
-{
-    /**
-     * @var array
-     */
-    protected $_data;
-
-    /**
-     * the next handler in the chain
-     *
-     * @var \DesignPatterns\KeyValueStorage
-     */
-    protected $_nextHandler;
-
-    public function __construct(array $data, KeyValueStorage $nextHandler)
-    {
-        $this->_data = $data;
-        $this->_nextHandler = $nextHandler;
-    }
-
-    /**
-     * when this storage gets a "miss", search in next handler
-     *
-     * @param $key
-     * @return mixed
-     */
-    public function get($key)
-    {
-        if (true /* miss */) {
-            // delegate the call to the next handler in the chain
-            return $this->_nextHandler->get($key);
-        }
-    }
-}
-
-// BUILD THE STORAGES AND CHAIN
-
-$slowStorage = new SlowStorage(array('foo' => 'bar'));
-$fastStorage = new FastStorage(array('bar' => 'baz'), $slowStorage);
-
-$fastStorage->get('foo'); // will be handled by SlowStorage
-$fastStorage->get('bar'); // will be handled by FastStorage
-
-/**
- * In this example we could also add a abstract class and extend it to build Fast- and SlowStorage. That class would
- * then manage the chain and when the cache hits a "miss", it would check if there is a next handler
- */

ChainOfResponsibilities/Handler.php

@@ -1,9 +1,5 @@
 <?php
 
-/*
- * DesignPatternPHP
- */
-
 namespace DesignPatterns\ChainOfResponsibilities;
 
 /**
@@ -16,7 +12,9 @@ namespace DesignPatterns\ChainOfResponsibilities;
  */
 abstract class Handler
 {
-
+    /**
+     * @var Handler
+     */
     private $successor = null;
 
     /**
@@ -24,14 +22,16 @@ abstract class Handler
      * 
      * A prepend method could be done with the same spirit
      * 
-     * You could also send the successor in the contructor but in PHP it is a
+     * You could also send the successor in the constructor but in PHP it is a
      * bad idea because you have to remove the type-hint of the parameter because
      * the last handler has a null successor.
      * 
-     * And if you override the contructor, that Handler can no longer have a
+     * And if you override the constructor, that Handler can no longer have a
      * successor. One solution is to provide a NullObject (see pattern).
      * It is more preferable to keep the constructor "free" to inject services
      * you need with the DiC of symfony2 for example.
+     *
+     * @param Handler $handler
      */
     final public function append(Handler $handler)
     {
@@ -48,6 +48,10 @@ abstract class Handler
      * This approach by using a template method pattern ensures you that 
      * each subclass will not forget to call the successor. Beside, the returned
      * boolean value indicates you if the request have been processed or not.
+     *
+     * @param Request $req
+     *
+     * @return bool
      */
     final public function handle(Request $req)
     {
@@ -65,8 +69,10 @@ abstract class Handler
 
     /**
      * Each concrete handler has to implement the processing of the request
-     * 
+     *
+     * @param Request $req
+     *
      * @return bool true if the request has been processed
      */
     abstract protected function processing(Request $req);
-}
+}

ChainOfResponsibilities/README.md

@@ -0,0 +1,13 @@
+# chain of responsibilities
+
+## Purpose:
+
+To build a chain of objects to handle a call. if one object cannot handle a call, it delegates the call to the next
+in the chain and so forth
+
+## Examples:
+
+*  logging framework
+*  spam filter
+  Caching: first object is an instance of e.g. a Memcached Interface, if that "misses" it delegates the call to the database interface
+*  Yii Framework: CFilterChain is a chain of controller action filters. the executing point is passed from one filter to the next along the chain, and only if all filters say "yes", the action can be invoked at last.

ChainOfResponsibilities/Request.php

@@ -1,9 +1,5 @@
 <?php
 
-/*
- * DesignPatternPHP
- */
-
 namespace DesignPatterns\ChainOfResponsibilities;
 
 /**
@@ -20,4 +16,4 @@ namespace DesignPatterns\ChainOfResponsibilities;
 class Request
 {
     // getter and setter but I don't want to generate to much noise in handlers
-}
+}

ChainOfResponsibilities/Responsible/FastStorage.php

@@ -1,30 +1,34 @@
 <?php
 
-/*
- * DesignPatternPHP
- */
-
 namespace DesignPatterns\ChainOfResponsibilities\Responsible;
 
 use DesignPatterns\ChainOfResponsibilities\Handler;
 use DesignPatterns\ChainOfResponsibilities\Request;
 
+/**
+ * Class FastStorage
+ */
 class FastStorage extends Handler
 {
+    /**
+     * @var array
+     */
+    protected $data = array();
 
-    protected $_data = array();
+    /**
-
+     * @param array $data
+     */
     public function __construct($data = array())
     {
-        $this->_data = $data;
+        $this->data = $data;
     }
 
     protected function processing(Request $req)
     {
         if ('get' === $req->verb) {
-            if (array_key_exists($req->key, $this->_data)) {
+            if (array_key_exists($req->key, $this->data)) {
                 // the handler IS responsible and then processes the request
-                $req->response = $this->_data[$req->key];
+                $req->response = $this->data[$req->key];
                 // instead of returning true, I could return the value but it proves
                 // to be a bad idea. What if the value IS "false" ?
                 return true;
@@ -33,5 +37,4 @@ class FastStorage extends Handler
 
         return false;
     }
-
 }

ChainOfResponsibilities/Responsible/SlowStorage.php

@@ -1,9 +1,5 @@
 <?php
 
-/*
- * DesignPatternPHP
- */
-
 namespace DesignPatterns\ChainOfResponsibilities\Responsible;
 
 use DesignPatterns\ChainOfResponsibilities\Handler;
@@ -21,24 +17,29 @@ use DesignPatterns\ChainOfResponsibilities\Request;
  */
 class SlowStorage extends Handler
 {
+    /**
+     * @var array
+     */
+    protected $data = array();
 
-    protected $_data = array();
+    /**
-
+     * @param array $data
+     */
     public function __construct($data = array())
     {
-        $this->_data = $data;
+        $this->data = $data;
     }
 
     protected function processing(Request $req)
     {
         if ('get' === $req->verb) {
-            if (array_key_exists($req->key, $this->_data)) {
+            if (array_key_exists($req->key, $this->data)) {
-                $req->response = $this->_data[$req->key];
+                $req->response = $this->data[$req->key];
+
                 return true;
             }
         }
 
         return false;
     }
-
 }

Command/CommandInterface.php

@@ -23,9 +23,8 @@ namespace DesignPatterns\Command;
  *   can be implemented with the Command pattern (e.g. vagrant)
  *
  */
-interface Command
+interface CommandInterface
 {
-
     /**
      * this is the most important method in the Command pattern,
      * The Receiver goes in the constructor.

Command/HelloCommand.php

@@ -6,25 +6,31 @@ namespace DesignPatterns\Command;
  * This concrete command calls "print" on the Receiver, but an external
  * invoker just know he can call "execute" 
  */
-class HelloCommand implements Command
+class HelloCommand implements CommandInterface
 {
-
+    /**
+     * @var Receiver
+     */
     protected $output;
 
     /**
      * Each concrete command is builded with different receivers.
-     * Can be one, many, none or even other Command in parameters 
+     * Can be one, many, none or even other Command in parameters
+     *
+     * @param Receiver $console
      */
     public function __construct(Receiver $console)
     {
         $this->output = $console;
     }
 
+    /**
+     * execute and output "Hello World"
+     */
     public function execute()
     {
-        // sometimes, there is no receiver and this is the command which 
+        // sometimes, there is no receiver and this is the command which
         // does all the work
         $this->output->write('Hello World');
     }
-
+}
-}

Command/Invoker.php

@@ -1,9 +1,5 @@
 <?php
 
-/*
- * DesignPatternPHP
- */
-
 namespace DesignPatterns\Command;
 
 /**
@@ -12,23 +8,29 @@ namespace DesignPatterns\Command;
  */
 class Invoker
 {
-
+    /**
+     * @var CommandInterface
+     */
     protected $command;
 
     /**
      * In the invoker we find this kind of method for subscribing the command.
      * There can be also a stack, a list, a fixed set...
+     *
+     * @param CommandInterface $cmd
      */
-    public function setCommand(Command $cmd)
+    public function setCommand(CommandInterface $cmd)
     {
         $this->command = $cmd;
     }
 
+    /**
+     * executes the command
+     */
     public function run()
     {
         // here is a key feature of the invoker
         // the invoker is the same whatever is the command
         $this->command->execute();
     }
-
+}
-}

Command/Receiver.php

@@ -1,9 +1,5 @@
 <?php
 
-/*
- * DesignPatternPHP
- */
-
 namespace DesignPatterns\Command;
 
 /**
@@ -11,10 +7,11 @@ namespace DesignPatterns\Command;
  */
 class Receiver
 {
-
+    /**
+     * @param string $str
+     */
     public function write($str)
     {
         echo $str;
     }
-
+}
-}

Composite/Form.php

@@ -3,7 +3,7 @@
 namespace DesignPatterns\Composite;
 
 /**
- * composite pattern
+ * Composite pattern
  *
  * Purpose:
  * to treat a group of objects the same way as a single instance of the object
@@ -18,7 +18,10 @@ namespace DesignPatterns\Composite;
  */
 class Form extends FormElement
 {
-    protected $_elements;
+    /**
+     * @var array|FormElement[]
+     */
+    protected $elements;
 
     /**
      * runs through all elements and calls render() on them, then returns the complete representation
@@ -26,20 +29,26 @@ class Form extends FormElement
      *
      * from the outside, one will not see this and the form will act like a single object instance
      *
+     * @param int $indent
+     *
      * @return string
      */
     public function render($indent = 0)
     {
         $formCode = '';
-        foreach ($this->_elements as $element) {
+
+        foreach ($this->elements as $element) {
             $formCode .= $element->render($indent + 1) . PHP_EOL;
         }
 
         return $formCode;
     }
 
+    /**
+     * @param FormElement $element
+     */
     public function addElement(FormElement $element)
     {
-        $this->_elements[] = $element;
+        $this->elements[] = $element;
     }
 }

Composite/FormElement.php

@@ -2,7 +2,17 @@
 
 namespace DesignPatterns\Composite;
 
+/**
+ * Class FormElement
+ */
 abstract class FormElement
 {
+    /**
+     * renders the elements' code
+     *
+     * @param int $indent
+     *
+     * @return mixed
+     */
     abstract public function render($indent = 0);
 }

Composite/InputElement.php

@@ -2,8 +2,18 @@
 
 namespace DesignPatterns\Composite;
 
+/**
+ * Class InputElement
+ */
 class InputElement extends FormElement
 {
+    /**
+     * renders the input element HTML
+     *
+     * @param int $indent
+     *
+     * @return mixed|string
+     */
     public function render($indent = 0)
     {
         return str_repeat('  ', $indent) . '<input type="text" />';

Composite/TextElement.php

@@ -2,8 +2,18 @@
 
 namespace DesignPatterns\Composite;
 
+/**
+ * Class TextElement
+ */
 class TextElement extends FormElement
 {
+    /**
+     * renders the text element
+     *
+     * @param int $indent
+     *
+     * @return mixed|string
+     */
     public function render($indent = 0)
     {
         return str_repeat('  ', $indent) . 'this is a text element';

DataMapper/User.php

@@ -42,43 +42,48 @@ class User
     /**
      * @return int
      */
-    public function getUserId() {
+    public function getUserId()
-		return $this->userId;
+    {
-	}
+        return $this->userId;
+    }
 
     /**
      * @param int $userId
      */
-    public function setUserID($userId) {
+    public function setUserID($userId)
-		$this->userId = $userId;
+    {
-	}
+        $this->userId = $userId;
+    }
 
     /**
      * @return string
      */
-    public function getUsername() {
+    public function getUsername()
-		return $this->username;
+    {
-	}
+        return $this->username;
+    }
 
     /**
      * @param string $username
      */
-    public function setUsername($username) {
+    public function setUsername($username)
-		$this->username = $username;
+    {
-	}
+        $this->username = $username;
+    }
 
     /**
      * @return string
      */
-    public function getEmail() {
+    public function getEmail()
-		return $this->email;
+    {
-	}
+        return $this->email;
+    }
 
     /**
      * @param string $email
      */
-    public function setEmail($email) {
+    public function setEmail($email)
-		$this->email = $email;
+    {
-	}
+        $this->email = $email;
-
+    }
-}
+}

DataMapper/UserMapper.php

@@ -25,12 +25,14 @@ namespace DesignPatterns\DataMapper;
  */
 class UserMapper
 {
-
     /**
      * @var DBAL
      */
     protected $adapter;
 
+    /**
+     * @param DBAL $dbLayer
+     */
     public function __construct(DBAL $dbLayer)
     {
         $this->adapter = $dbLayer;
@@ -40,6 +42,7 @@ class UserMapper
      * saves a user object from memory to Database
      *
      * @param User $user
+     *
      * @return boolean
      */
     public function save(User $user)
@@ -55,9 +58,11 @@ class UserMapper
         if (null === ($id = $user->getUserId())) {
             unset($data['userid']);
             $this->adapter->insert($data);
+
             return true;
         } else {
             $this->adapter->update($data, array('userid = ?' => $id));
+
             return true;
         }
     }
@@ -66,13 +71,15 @@ class UserMapper
      * finds a user from Database based on ID and returns a User object located
      * in memory
      *
-     * @param $id
+     * @param int $id
+     *
      * @throws \InvalidArgumentException
      * @return User
      */
     public function findById($id)
     {
         $result = $this->adapter->find($id);
+
         if (0 == count($result)) {
             throw new \InvalidArgumentException("User #$id not found");
         }
@@ -104,7 +111,7 @@ class UserMapper
      *
      * @param array $row
      *
-     * @return \DesignPatterns\DataMapper\User
+     * @return User
      */
     protected function mapObject(array $row)
     {

Decorator/Decorator.php

@@ -16,24 +16,25 @@ namespace DesignPatterns\Decorator;
  */
 
 /**
- * the Deoorator MUST implement the Renderer contract, this is the key-feature
+ * the Deoorator MUST implement the RendererInterface contract, this is the key-feature
  * of this design pattern. If not, this is no longer a Decorator but just a dumb
  * wrapper.
  */
-abstract class Decorator implements Renderer
+abstract class Decorator implements RendererInterface
 {
-
+    /**
-    protected $_wrapped;
+     * @var RendererInterface
+     */
+    protected $wrapped;
 
     /**
      * You must type-hint the wrapped component :
      * It ensures you can call renderData() in the subclasses !
      * 
-     * @param Renderer $wrappable
+     * @param RendererInterface $wrappable
      */
-    public function __construct(Renderer $wrappable)
+    public function __construct(RendererInterface $wrappable)
     {
-        $this->_wrapped = $wrappable;
+        $this->wrapped = $wrappable;
     }
 }
-

Decorator/RenderInJson.php

@@ -2,13 +2,20 @@
 
 namespace DesignPatterns\Decorator;
 
+/**
+ * Class RenderInJson
+ */
 class RenderInJson extends Decorator
 {
-
+    /**
+     * render data as JSON
+     *
+     * @return mixed|string
+     */
     public function renderData()
     {
-        $output = $this->_wrapped->renderData();
+        $output = $this->wrapped->renderData();
+
         return json_encode($output);
     }
-
 }

Decorator/RenderInXml.php

@@ -2,19 +2,28 @@
 
 namespace DesignPatterns\Decorator;
 
+/**
+ * Class RenderInXml
+ */
 class RenderInXml extends Decorator
 {
-
+    /**
+     * render data as XML
+     *
+     * @return mixed|string
+     */
     public function renderData()
     {
-        $output = $this->_wrapped->renderData();
+        $output = $this->wrapped->renderData();
-        // do some fany conversion to xml from array ...
+
+        // do some fancy conversion to xml from array ...
+
         $doc = new \DOMDocument();
+
         foreach ($output as $key => $val) {
             $doc->appendChild($doc->createElement('foo', 'bar'));
         }
 
         return $doc->saveXML();
     }
-
 }

Decorator/Renderer.php

@@ -1,9 +0,0 @@
-<?php
-
-namespace DesignPatterns\Decorator;
-
-interface Renderer
-{
-
-    public function renderData();
-}

Decorator/RendererInterface.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace DesignPatterns\Decorator;
+
+/**
+ * Class RendererInterface
+ */
+interface RendererInterface
+{
+    /**
+     * render data
+     *
+     * @return mixed
+     */
+    public function renderData();
+}

Decorator/Webservice.php

@@ -2,19 +2,29 @@
 
 namespace DesignPatterns\Decorator;
 
-class Webservice implements Renderer
+/**
+ * Class Webservice
+ */
+class Webservice implements RendererInterface
 {
+    /**
+     * @var mixed
+     */
+    protected $data;
 
-    protected $_data;
+    /**
-
+     * @param mixed $data
+     */
     public function __construct($data)
     {
-        $this->_data = $data;
+        $this->data = $data;
     }
 
+    /**
+     * @return string
+     */
     public function renderData()
     {
-        return $this->_data;
+        return $this->data;
     }
-
 }

DependencyInjection/Configuration.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace DesignPatterns;
+namespace DesignPatterns\DependencyInjection;
 
 /**
  * Dependency Injection
@@ -18,15 +18,20 @@ namespace DesignPatterns;
  */
 class Configuration
 {
-    protected $_host;
+    /**
+     * @var string
+     */
+    protected $host;
 
     /**
      * @param string $host
+     *
      * @return Configuration
      */
     public function setHost($host)
     {
-        $this->_host = $host;
+        $this->host = $host;
+
         return $this; // for a fluent interface
     }
 
@@ -35,29 +40,6 @@ class Configuration
      */
     public function getHost()
     {
-        return $this->_host;
+        return $this->host;
-    }
-}
-
-class Connection
-{
-    protected $_configuration;
-
-    /**
-     * here, Configuration gets injected and Connection will get all that it needs from Configuration
-     * without DI, the configuration would be created directly in Connection, which is not very good
-     * for testing and extending Connection
-     *
-     * @param Configuration $config
-     */
-    public function __construct(Configuration $config)
-    {
-        $this->_configuration = $config;
-    }
-
-    public function connect()
-    {
-        $host = $this->_configuration->getHost();
-        // ...
     }
 }

DependencyInjection/Connection.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace DesignPatterns\DependencyInjection;
+
+/**
+ * Class Connection
+ */
+class Connection
+{
+    /**
+     * @var Configuration
+     */
+    protected $configuration;
+
+    /**
+     * here, Configuration gets injected and Connection will get all that it needs from Configuration
+     * without DI, the configuration would be created directly in Connection, which is not very good
+     * for testing and extending Connection
+     *
+     * @param Configuration $config
+     */
+    public function __construct(Configuration $config)
+    {
+        $this->configuration = $config;
+    }
+
+    /**
+     * connection using the injected config
+     */
+    public function connect()
+    {
+        $host = $this->configuration->getHost();
+        // ...
+    }
+}

Facade/BiosInterface.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace DesignPatterns\Facade;
+
+/**
+ * Class BiosInterface
+ */
+interface BiosInterface
+{
+    /**
+     * execute the BIOS
+     */
+    public function execute();
+
+    /**
+     * wait for halt
+     */
+    public function waitForKeyPress();
+
+    /**
+     * launches the OS
+     *
+     * @param OsInterface $os
+     */
+    public function launch(OsInterface $os);
+
+    /**
+     * power down BIOS
+     */
+    public function powerDown();
+}

Facade/Facade.php

@@ -1,9 +1,5 @@
 <?php
 
-/*
- * DesignPatternPHP
- */
-
 namespace DesignPatterns\Facade;
 
 /**
@@ -28,31 +24,45 @@ namespace DesignPatterns\Facade;
  */
 class Facade
 {
+    /**
+     * @var OsInterface
+     */
+    protected $os;
 
-    protected $opsys;
+    /**
+     * @var BiosInterface
+     */
     protected $bios;
 
     /**
      * This is the perfect time to use a dependency injection container
      * to creaate an instance of this class
+     *
+     * @param BiosInterface $bios
+     * @param OsInterface   $os
      */
     public function __construct(BiosInterface $bios, OsInterface $os)
     {
         $this->bios = $bios;
-        $this->opsys = $os;
+        $this->os = $os;
     }
 
+    /**
+     * turn on the system
+     */
     public function turnOn()
     {
         $this->bios->execute();
         $this->bios->waitForKeyPress();
-        $this->bios->launch($this->opsys);
+        $this->bios->launch($this->os);
     }
 
+    /**
+     * turn off the system
+     */
     public function turnOff()
     {
-        $this->opsys->halt();
+        $this->os->halt();
         $this->bios->powerDown();
     }
-
+}
-}

Facade/OsInterface.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace DesignPatterns\Facade;
+
+/**
+ * Class OsInterface
+ */
+interface OsInterface
+{
+    /**
+     * halt the OS
+     */
+    public function halt();
+}

FactoryMethod/Bicycle.php

@@ -1,20 +1,24 @@
 <?php
 
-/*
- * DesignPatternPHP
- */
-
 namespace DesignPatterns\FactoryMethod;
 
 /**
  * Bicycle is a bicycle
  */
-class Bicycle implements Vehicle
+class Bicycle implements VehicleInterface
 {
+    /**
+     * @var string
+     */
+    protected $color;
 
+    /**
+     * sets the color of the bicycle
+     *
+     * @param string $rgb
+     */
     public function setColor($rgb)
     {
-        
+        $this->color = $rgb;
     }
-
+}
-}

FactoryMethod/FactoryMethod.php

@@ -1,9 +1,5 @@
 <?php
 
-/*
- * DesignPatternPHP
- */
-
 namespace DesignPatterns\FactoryMethod;
 
 /**
@@ -32,7 +28,7 @@ abstract class FactoryMethod
      * 
      * @param string $type a generic type
      * 
-     * @return Vehicle a new vehicle
+     * @return VehicleInterface a new vehicle
      */
     abstract protected function createVehicle($type);
 
@@ -41,7 +37,7 @@ abstract class FactoryMethod
      * 
      * @param int $type
      * 
-     * @return Vehicle a new vehicle
+     * @return VehicleInterface a new vehicle
      */
     public function create($type)
     {
@@ -50,5 +46,4 @@ abstract class FactoryMethod
 
         return $obj;
     }
-
+}
-}

FactoryMethod/Ferrari.php

@@ -1,20 +1,22 @@
 <?php
 
-/*
- * DesignPatternPHP
- */
-
 namespace DesignPatterns\FactoryMethod;
 
 /**
  * Ferrari is a italian car
  */
-class Ferrari implements Vehicle
+class Ferrari implements VehicleInterface
 {
+    /**
+     * @var string
+     */
+    protected $color;
 
+    /**
+     * @param string $rgb
+     */
     public function setColor($rgb)
     {
-        
+        $this->color = $rgb;
     }
-
+}
-}

FactoryMethod/GermanFactory.php

@@ -1,39 +1,31 @@
 <?php
 
-/*
- * DesignPatternPHP
- */
-
 namespace DesignPatterns\FactoryMethod;
 
 /**
- * GermanFactory is vehicle factory in Germany
+ * GermanFactory is a vehicle factory in Germany
  */
 class GermanFactory extends FactoryMethod
 {
-
     /**
-     * @inheritdoc
+     * {@inheritdoc}
      */
     protected function createVehicle($type)
     {
         switch ($type) {
-
+            case parent::CHEAP:
-            case parent::CHEAP :
                 return new Bicycle();
                 break;
-
+            case parent::FAST:
-            case parent::FAST :
                 $obj = new Porsche();
                 // we can specialize the way we want some concrete Vehicle since
                 // we know the class
                 $obj->addTuningAMG();
+
                 return $obj;
                 break;
-
+            default:
-            default :
                 throw new \InvalidArgumentException("$type is not a valid vehicle");
         }
     }
-
+}
-}

FactoryMethod/ItalianFactory.php

@@ -1,9 +1,5 @@
 <?php
 
-/*
- * DesignPatternPHP
- */
-
 namespace DesignPatterns\FactoryMethod;
 
 /**
@@ -11,25 +7,20 @@ namespace DesignPatterns\FactoryMethod;
  */
 class ItalianFactory extends FactoryMethod
 {
-
     /**
-     * @inheritdoc
+     * {@inheritdoc}
      */
     protected function createVehicle($type)
     {
         switch ($type) {
-
+            case parent::CHEAP:
-            case parent::CHEAP :
                 return new Bicycle();
                 break;
-
+            case parent::FAST:
-            case parent::FAST :
                 return new Ferrari();
                 break;
-
+            default:
-            default :
                 throw new \InvalidArgumentException("$type is not a valid vehicle");
         }
     }
-
+}
-}

FactoryMethod/Porsche.php

@@ -1,25 +1,31 @@
 <?php
 
-/*
- * DesignPatternPHP
- */
-
 namespace DesignPatterns\FactoryMethod;
 
 /**
  * Porsche is a german car
  */
-class Porsche implements Vehicle
+class Porsche implements VehicleInterface
 {
+    /**
+     * @var string
+     */
+    protected $color;
 
+    /**
+     * @param string $rgb
+     */
     public function setColor($rgb)
     {
-        
+        $this->color = $rgb;
     }
 
+    /**
+     * although tuning by AMG is only offered for Mercedes Cars,
+     * this is a valid coding example ...
+     */
     public function addTuningAMG()
     {
-        
-    }
 
-}
+    }
+}

FactoryMethod/Vehicle.php

@@ -1,16 +0,0 @@
-<?php
-
-/*
- * DesignPatternPHP
- */
-
-namespace DesignPatterns\FactoryMethod;
-
-/**
- * Vehicle is a contract for a vehicle
- */
-interface Vehicle
-{
-
-    function setColor($rgb);
-}

FactoryMethod/VehicleInterface.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace DesignPatterns\FactoryMethod;
+
+/**
+ * VehicleInterface is a contract for a vehicle
+ */
+interface VehicleInterface
+{
+    /**
+     * sets the color of the vehicle
+     *
+     * @param string $rgb
+     */
+    public function setColor($rgb);
+}

FluentInterface/SQL.php

@@ -11,56 +11,78 @@ namespace DesignPatterns\FluentInterface;
  * Examples:
  * - Doctrine2's QueryBuilder works something like that example class below
  * - PHPUnit uses fluent interfaces to build mock objects
- * - Yii Framework: CDbCommand and CActiveRecord use this pattern too
+ * - Yii Framework: CDbCommand and CActiveRecord use this pattern, too
- *
  */
 class SQL
 {
-    protected $_fields = array();
+    /**
-    protected $_from = array();
+     * @var array
-    protected $_where = array();
+     */
+    protected $fields = array();
 
     /**
+     * @var array
+     */
+    protected $from = array();
+
+    /**
+     * @var array
+     */
+    protected $where = array();
+
+    /**
+     * adds select fields
      *
      * @param array $fields
+     *
      * @return SQL
      */
     public function select(array $fields = array())
     {
-        $this->_fields = $fields;
+        $this->fields = $fields;
+
         return $this;
     }
 
     /**
+     * adds a FROM clause
      *
      * @param string $table
      * @param string $alias
+     *
      * @return SQL
      */
     public function from($table, $alias)
     {
-        $this->_from[] = $table . ' AS ' . $alias;
+        $this->from[] = $table . ' AS ' . $alias;
+
         return $this;
     }
 
     /**
+     * adds a WHERE condition
+     *
      * @param string $condition
+     *
      * @return SQL
      */
     public function where($condition)
     {
-        $this->_where[] = $condition;
+        $this->where[] = $condition;
+
         return $this;
     }
-    
+
     /**
      * Gets the query, just an example of building a query, 
      * no check on consistency
+     *
+     * @return string
      */
     public function getQuery()
     {
-        return 'SELECT ' . implode(',', $this->_fields) 
+        return 'SELECT ' . implode(',', $this->fields)
-                . ' FROM ' . implode(',', $this->_from)
+                . ' FROM ' . implode(',', $this->from)
-                . ' WHERE ' . implode(' AND ', $this->_where);
+                . ' WHERE ' . implode(' AND ', $this->where);
     }
 }

Iterator/CardGame.php

@@ -1,80 +0,0 @@
-<?php
-
-/*
- * DesignPatternPHP
- */
-
-namespace DesignPatterns\Iterator;
-
-/**
- * Iterator provides a standard way to iterate over a collection without knowing
- * how it is implemented. All you need to know is : you can traverse it
- * with current, valid, next, rewind and key.
- * 
- * That's the key feature of this pattern :
- * The underlaying machinery could be an array, a matrix, a file, a cursor
- * from database, a webservice with a cache, you don't care anymore.
- * 
- * Note: This design pattern changes from one language to another. It depends 
- * mostly how loop statements handle collections (see Java before and after 1.5)
- * 
- * In this simple example, I try to demonstrate how I manage a "linear" iterator
- * on a card game but in fact, the underlaying storage is handled by two combined
- * arrays.
- * 
- * If tomorrow you decide to read cards from a database, the client 
- * (see the PHPUnit test) will remain unchanged. That's the beauty of it.
- */
-class CardGame implements \Iterator
-{
-
-    protected $color = array('D', 'S', 'C', 'H');
-    protected $number = array(7, 8, 9, 10, 'J', 'Q', 'K', 'A');
-
-    /**
-     * Return the current value
-     */
-    public function current()
-    {
-        return current($this->number) . ' of ' . current($this->color);
-    }
-
-    /**
-     * Return the current key
-     */
-    public function key()
-    {
-        return current($this->color) . current($this->number);
-    }
-
-    /**
-     * Go to the next item in the collection
-     */
-    public function next()
-    {
-        if (false === next($this->number)) {
-            if (false !== next($this->color)) {
-                reset($this->number);
-            }
-        }
-    }
-
-    /**
-     * Go to the first item in the collection
-     */
-    public function rewind()
-    {
-        reset($this->color);
-        reset($this->number);
-    }
-
-    /**
-     * Is the current position a valid item (true) 
-     * or do we reach the end (false) ?
-     */
-    public function valid()
-    {
-        return current($this->number) || current($this->color);
-    }
-
-}

Iterator/File.php

@@ -0,0 +1,51 @@
+<?php
+
+namespace DesignPatterns\Iterator;
+
+/**
+ * iterator pattern
+ *
+ * Purpose:
+ * to make an object iterable
+ *
+ * Examples:
+ * - to process a file line by line by just running over all lines (which have an object representation) for a file
+ *   (which of course is an object, too)
+ *
+ * Note:
+ * Standard PHP Library (SPL) defines an interface Iterator which is best suited for this!
+ * Often you would want to implement the Countable interface too, to allow count($object) on your iterable object
+ *
+ * THIS EXAMPLE ALSO APPLIES THE COMPOSITE PATTERN
+ *
+ */
+class File
+{
+    /**
+     * @var RowSet
+     */
+    protected $rowSet;
+
+    /**
+     * @var string
+     */
+    protected $pathName;
+
+    /**
+     * @param string $pathName
+     */
+    public function __construct($pathName)
+    {
+        $this->rowSet = new Rowset($this);
+    }
+
+    /**
+     * processes the rowSet
+     */
+    public function process()
+    {
+        // this is the place to show how using an iterator, with foreach
+        // See the CardGame.php file
+        $this->rowSet->process();
+    }
+}

Iterator/Iterator.php

@@ -1,119 +0,0 @@
-<?php
-
-namespace DesignPatterns;
-
-/**
- * iterator pattern
- *
- * Purpose:
- * to make an object iterable
- *
- * Examples:
- * - to process a file line by line by just running over all lines (which have an object representation) for a file
- *   (which of course is an object, too)
- *
- * Note:
- * Standard PHP Library (SPL) defines an interface Iterator which is best suited for this!
- * Often you would want to implement the Countable interface too, to allow count($object) on your iterable object
- *
- * THIS EXAMPLE ALSO APPLIES THE COMPOSITE PATTERN
- *
- */
-class File
-{
-    protected $_rowset;
-
-    protected $_pathName;
-
-    public function __construct($pathName)
-    {
-        $this->_rowset = new Rowset($this);
-    }
-
-    public function process()
-    {
-        // this is the place to show how using an iterator, with foreach
-        // See the CardGame.php file
-        $this->_rowset->process();
-    }
-}
-
-class Rowset implements \Iterator
-{
-    protected $_currentRow;
-
-    protected $_file;
-
-    public function __construct($file)
-    {
-        $this->_file = $file;
-    }
-
-    /**
-     * composite pattern: run through all rows and process them
-     *
-     * @return void
-     */
-    public function process()
-    {
-        // this actually calls rewind(), { next(), valid(), key() and current() :}
-        /**
-         * THE key feature of the Iterator Pattern is to provide a *public contract*
-         * to iterate on a collection without knowing how items are handled inside
-         * the collection. It is not just an easy way to use "foreach"
-         * 
-         * One cannot see the point of iterator pattern if you iterate on $this.
-         * This example is unclear and mixed with some Composite pattern ideas. 
-         */
-        foreach ($this as $line => $row) {
-            $row->process();
-        }
-    }
-
-    public function rewind()
-    {
-        // seek to first line from $this->_file
-    }
-
-    public function next()
-    {
-        // read the next line from $this->_file
-        if (!$eof) {
-            $data = ''; // get the line
-            $this->_currentRow = new Row($data);
-        } else {
-            $this->_currentRow = null;
-        }
-    }
-
-    public function current()
-    {
-        return $this->_currentRow;
-    }
-
-    public function valid()
-    {
-        return null !== $this->_currentRow;
-    }
-
-    public function key()
-    {
-        // you would want to increment this in next() or whatsoever
-        return $this->_lineNumber;
-    }
-}
-
-class Row
-{
-    protected $_data;
-
-    public function __construct($data)
-    {
-        $this->_data = $data;
-    }
-
-    public function process()
-    {
-        // do some fancy things here ...
-    }
-}

Iterator/Row.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace DesignPatterns\Iterator;
+
+/**
+ * Class Row
+ */
+class Row
+{
+    protected $data;
+
+    /**
+     * {@inheritdoc}
+     */
+    public function __construct($data)
+    {
+        $this->data = $data;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function process()
+    {
+        // do some fancy things here ...
+    }
+}

Iterator/RowSet.php

@@ -0,0 +1,100 @@
+<?php
+
+namespace DesignPatterns\Iterator;
+
+/**
+ * Class RowSet
+ */
+class RowSet implements \Iterator
+{
+    /**
+     * @var
+     */
+    protected $currentRow;
+
+    /**
+     * @var string
+     */
+    protected $file;
+
+    /**
+     * @var int
+     */
+    protected $lineNumber;
+
+    /**
+     * @param string $file
+     */
+    public function __construct($file)
+    {
+        $this->file = $file;
+    }
+
+    /**
+     * composite pattern: run through all rows and process them
+     *
+     * @return void
+     */
+    public function process()
+    {
+        // this actually calls rewind(), { next(), valid(), key() and current() :}
+        /**
+         * THE key feature of the Iterator Pattern is to provide a *public contract*
+         * to iterate on a collection without knowing how items are handled inside
+         * the collection. It is not just an easy way to use "foreach"
+         *
+         * One cannot see the point of iterator pattern if you iterate on $this.
+         * This example is unclear and mixed with some Composite pattern ideas.
+         */
+        foreach ($this as $line => $row) {
+            $row->process();
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function rewind()
+    {
+        // seek to first line from $this->file
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function next()
+    {
+        // read the next line from $this->file
+        if (!$eof) {
+            $data = ''; // get the line
+            $this->currentRow = new Row($data);
+        } else {
+            $this->currentRow = null;
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function current()
+    {
+        return $this->currentRow;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function valid()
+    {
+        return null !== $this->currentRow;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function key()
+    {
+        // you would want to increment this in next() or whatsoever
+        return $this->lineNumber;
+    }
+}

Mediator/Colleague.php

@@ -1,9 +1,5 @@
 <?php
 
-/*
- * DesignPatternPHP
- */
-
 namespace DesignPatterns\Mediator;
 
 /**
@@ -12,8 +8,11 @@ namespace DesignPatterns\Mediator;
  */
 abstract class Colleague
 {
-
+    /**
-    // this ensures no change in subclasses
+     * this ensures no change in subclasses
+     *
+     * @var MediatorInterface
+     */
     private $mediator;
 
     // for subclasses
@@ -22,10 +21,12 @@ abstract class Colleague
         return $this->mediator;
     }
 
+    /**
+     * @param MediatorInterface $medium
+     */
     public function __construct(MediatorInterface $medium)
     {
         // in this way, we are sure the concrete colleague knows the mediator
         $this->mediator = $medium;
     }
-
+}
-}

Mediator/Mediator.php

@@ -1,9 +1,5 @@
 <?php
 
-/*
- * DesignPatternPHP
- */
-
 namespace DesignPatterns\Mediator;
 
 use DesignPatterns\Mediator\Subsystem;
@@ -29,6 +25,11 @@ class Mediator implements MediatorInterface
     protected $database;
     protected $client;
 
+    /**
+     * @param Subsystem\Database $db
+     * @param Subsystem\Client   $cl
+     * @param Subsystem\Server   $srv
+     */
     public function setColleague(Subsystem\Database $db, Subsystem\Client $cl, Subsystem\Server $srv)
     {
         $this->database = $db;
@@ -36,19 +37,31 @@ class Mediator implements MediatorInterface
         $this->client = $cl;
     }
 
+    /**
+     * make request
+     */
     public function makeRequest()
     {
         $this->server->process();
     }
 
+    /**
+     * query db
+     *
+     * @return mixed
+     */
     public function queryDb()
     {
         return $this->database->getData();
     }
 
+    /**
+     * send response
+     *
+     * @param string $content
+     */
     public function sendResponse($content)
     {
         $this->client->output($content);
     }
-
+}
-}

Mediator/MediatorInterface.php

@@ -1,9 +1,5 @@
 <?php
 
-/*
- * DesignPatternPHP
- */
-
 namespace DesignPatterns\Mediator;
 
 /**
@@ -12,10 +8,20 @@ namespace DesignPatterns\Mediator;
  */
 interface MediatorInterface
 {
+    /**
+     * sends the response
+     *
+     * @param string $content
+     */
+    public function sendResponse($content);
 
-    function sendResponse($content);
+    /**
+     * makes a request
+     */
+    public function makeRequest();
 
-    function makeRequest();
+    /**
-
+     * queries the DB
-    function queryDb();
+     */
-}
+    public function queryDb();
+}

Mediator/Subsystem/Client.php

@@ -1,9 +1,5 @@
 <?php
 
-/*
- * DesignPatternPHP
- */
-
 namespace DesignPatterns\Mediator\Subsystem;
 
 use DesignPatterns\Mediator\Colleague;
@@ -13,15 +9,21 @@ use DesignPatterns\Mediator\Colleague;
  */
 class Client extends Colleague
 {
-
+    /**
+     * request
+     */
     public function request()
     {
         $this->getMediator()->makeRequest();
     }
 
+    /**
+     * output content
+     *
+     * @param string $content
+     */
     public function output($content)
     {
         echo $content;
     }
-
+}
-}

Mediator/Subsystem/Database.php

@@ -1,9 +1,5 @@
 <?php
 
-/*
- * DesignPatternPHP
- */
-
 namespace DesignPatterns\Mediator\Subsystem;
 
 use DesignPatterns\Mediator\Colleague;
@@ -13,10 +9,11 @@ use DesignPatterns\Mediator\Colleague;
  */
 class Database extends Colleague
 {
-
+    /**
+     * @return string
+     */
     public function getData()
     {
         return "World";
     }
-
+}
-}

Mediator/Subsystem/Server.php

@@ -1,9 +1,5 @@
 <?php
 
-/*
- * DesignPatternPHP
- */
-
 namespace DesignPatterns\Mediator\Subsystem;
 
 use DesignPatterns\Mediator\Colleague;
@@ -13,11 +9,12 @@ use DesignPatterns\Mediator\Colleague;
  */
 class Server extends Colleague
 {
-
+    /**
+     * process on server
+     */
     public function process()
     {
         $data = $this->getMediator()->queryDb();
         $this->getMediator()->sendResponse("Hello $data");
     }
-
+}
-}

Multiton/Multiton.php

@@ -37,7 +37,7 @@ class Multiton
      *
      * @var array
      */
-    private static $_instances = array();
+    private static $instances = array();
 
     /**
      * should not be called from outside: private!
@@ -53,15 +53,16 @@ class Multiton
      * uses lazy initialization
      * 
      * @param string $instanceName
+     *
      * @return Multiton
      */
     public static function getInstance($instanceName)
     {
-        if ( ! array_key_exists($instanceName, self::$_instances)) {
+        if (!array_key_exists($instanceName, self::$instances)) {
-            self::$_instances[$instanceName] = new self();
+            self::$instances[$instanceName] = new self();
         }
 
-        return self::$_instances[$instanceName];
+        return self::$instances[$instanceName];
     }
 
     /**

NullObject/LoggerInterface.php

@@ -1,18 +1,18 @@
 <?php
 
-/*
- * DesignPatternPHP
- */
-
 namespace DesignPatterns\NullObject;
 
 /**
  * LoggerInterface is a contract for logging something
  * 
- * Key-feaature : NullLogger MUST inherit from this interface like any other Loggers
+ * Key feature: NullLogger MUST inherit from this interface like any other Loggers
  */
 interface LoggerInterface
 {
-
+    /**
+     * @param string $str
+     *
+     * @return mixed
+     */
     public function log($str);
-}
+}

NullObject/NullLogger.php

@@ -1,9 +1,5 @@
 <?php
 
-/*
- * DesignPatternPHP
- */
-
 namespace DesignPatterns\NullObject;
 
 /**
@@ -32,10 +28,11 @@ namespace DesignPatterns\NullObject;
  */
 class NullLogger implements LoggerInterface
 {
-
+    /**
+     * @param string $str
+     */
     public function log($str)
     {
         // do nothing
     }
-
+}
-}

NullObject/PrintLogger.php

@@ -1,9 +1,5 @@
 <?php
 
-/*
- * DesignPatternPHP
- */
-
 namespace DesignPatterns\NullObject;
 
 /**
@@ -11,10 +7,11 @@ namespace DesignPatterns\NullObject;
  */
 class PrintLogger implements LoggerInterface
 {
-
+    /**
+     * @param string $str
+     */
     public function log($str)
     {
         echo $str;
     }
-
+}
-}

NullObject/Service.php

@@ -1,9 +1,5 @@
 <?php
 
-/*
- * DesignPatternPHP
- */
-
 namespace DesignPatterns\NullObject;
 
 /**
@@ -11,20 +7,28 @@ namespace DesignPatterns\NullObject;
  */
 class Service
 {
-
+    /**
+     * @var LoggerInterface
+     */
     protected $logger;
 
-    // we inject the logger in ctor and it is mandatory
+    /**
+     * we inject the logger in ctor and it is mandatory
+     *
+     * @param LoggerInterface $log
+     */
     public function __construct(LoggerInterface $log)
     {
         $this->logger = $log;
     }
 
+    /**
+     * do something ...
+     */
     public function doSomething()
     {
         // no more check "if (!is_null($this->logger))..." with the NullObject pattern
         $this->logger->log('We are in ' . __METHOD__);
         // something to do...
     }
-
+}
-}

Observer/User.php

@@ -10,49 +10,57 @@ namespace DesignPatterns\Observer;
  */
 class User implements \SplSubject
 {
-
-    protected $_data = array();
-
     /**
+     * user data
+     *
      * @var array
      */
-    protected $_observers = array();
+    protected $data = array();
+
+    /**
+     * observers
+     *
+     * @var array
+     */
+    protected $observers = array();
 
     /**
      * attach a new observer
      *
      * @param \SplObserver $observer
+     *
      * @return void
      */
     public function attach(\SplObserver $observer)
     {
-        $this->_observers[] = $observer;
+        $this->observers[] = $observer;
     }
 
     /**
      * detach an observer
      *
      * @param \SplObserver $observer
+     *
      * @return void
      */
     public function detach(\SplObserver $observer)
     {
-        $index = array_search($observer, $this->_observers);
+        $index = array_search($observer, $this->observers);
 
         if (false !== $index) {
-            unset($this->_observers[$index]);
+            unset($this->observers[$index]);
         }
     }
 
     /**
-     *
+     * notify observers
      *
      * @return void
      */
     public function notify()
     {
         /** @var SplObserver $observer */
-        foreach ($this->_observers as $observer) {
+        foreach ($this->observers as $observer) {
             $observer->update($this);
         }
     }
@@ -61,17 +69,16 @@ class User implements \SplSubject
      * Ideally one would better write setter/getter for all valid attributes and only call notify()
      * on attributes that matter when changed
      *
-     * @param $name
+     * @param string $name
-     * @param $value
+     * @param mixed  $value
+     *
      * @return void
      */
     public function __set($name, $value)
     {
-        $this->_data[$name] = $value;
+        $this->data[$name] = $value;
 
         // notify the observers, that user has been updated
         $this->notify();
     }
-
 }
-

Observer/UserObserver.php

@@ -17,7 +17,6 @@ namespace DesignPatterns\Observer;
  */
 class UserObserver implements \SplObserver
 {
-
     /**
      * This is the only method to implement as an observer.
      * It is called by the Subject (usually by SplSubject::notify() )
@@ -28,5 +27,4 @@ class UserObserver implements \SplObserver
     {
         echo get_class($subject) . ' has been updated';
     }
-
 }

Prototype/BarBookPrototype.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace DesignPatterns\Prototype;
+
+/**
+ * Class BarBookPrototype
+ */
+class BarBookPrototype extends BookPrototype
+{
+    /**
+     * @var string
+     */
+    protected $category = 'Bar';
+
+    /**
+     * empty clone
+     */
+    public function __clone()
+    {
+
+    }
+}

Prototype/BookPrototype.php

@@ -0,0 +1,48 @@
+<?php
+
+namespace DesignPatterns\Prototype;
+
+/**
+ * Prototype pattern
+ *
+ * Purpose:
+ * to avoid the cost of creating objects the standard way (new Foo()) and instead create a prototype and clone it
+ *
+ * Examples:
+ * - Large amounts of data (e.g. create 1,000,000 rows in a database at once via a ORM)
+ *
+ */
+abstract class BookPrototype
+{
+    /**
+     * @var string
+     */
+    protected $title;
+
+    /**
+     * @var string
+     */
+    protected $category;
+
+    /**
+     * @abstract
+     * @return void
+     */
+    abstract public function __clone();
+
+    /**
+     * @return string
+     */
+    public function getTitle()
+    {
+        return $this->title;
+    }
+
+    /**
+     * @param string $title
+     */
+    public function setTitle($title)
+    {
+        $this->title = $title;
+    }
+}

Prototype/FooBookPrototype.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace DesignPatterns\Prototype;
+
+/**
+ * Class FooBookPrototype
+ */
+class FooBookPrototype extends BookPrototype
+{
+    protected $category = 'Foo';
+
+    /**
+     * empty clone
+     */
+    public function __clone()
+    {
+
+    }
+}

Prototype/Prototype.php

@@ -1,65 +0,0 @@
-<?php
-
-namespace DesignPatterns;
-
-/**
- * Prototype pattern
- *
- * Purpose:
- * to avoid the cost of creating objects the standard way (new Foo()) and instead create a prototype and clone it
- *
- * Examples:
- * - Large amounts of data (e.g. create 1,000,000 rows in a database at once via a ORM)
- *
- */
-abstract class BookPrototype
-{
-    protected $_title;
-    protected $_category;
-
-    /**
-     * @abstract
-     * @return void
-     */
-    abstract public function __clone();
-
-    public function getTitle()
-    {
-        return $this->_title;
-    }
-
-    public function setTitle($title)
-    {
-        $this->_title = $title;
-    }
-}
-
-class FooBookPrototype extends BookPrototype
-{
-    protected $_category = 'Foo';
-
-    public function __clone()
-    {
-        
-    }
-}
-
-class BarBookPrototype extends BookPrototype
-{
-    protected $_category = 'Bar';
-
-
-    public function __clone()
-    {
-        
-    }
-}
-
-$fooPrototype = new FooBookPrototype();
-$barPrototype = new BarBookPrototype();
-
-// now lets say we need 10,000 books of foo and 5,000 of bar ...
-for ($i = 0; $i < 10000; $i++) {
-    $book = clone $fooPrototype;
-    $book->setTitle('Foo Book No ' . $i);
-}

Prototype/index.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace DesignPatterns\Prototype;
+
+$fooPrototype = new FooBookPrototype();
+$barPrototype = new BarBookPrototype();
+
+// now lets say we need 10,000 books of foo and 5,000 of bar ...
+for ($i = 0; $i < 10000; $i++) {
+    $book = clone $fooPrototype;
+    $book->setTitle('Foo Book No ' . $i);
+}

Proxy/Proxy.php

@@ -1,94 +0,0 @@
-<?php
-
-namespace DesignPatterns;
-
-/**
- * Proxy pattern
- *
- * Purpose:
- * to interface to anything that is expensive or impossible to duplicate
- *
- * Examples:
- * - Doctrine2 uses proxies to implement framework magic (e.g. Lazy initialization) in them, while the user still works
- *   with his own entity classes and will never use nor touch the proxies
- *
- */
-class Record
-{
-    protected $_data;
-
-    public function __construct($data = null)
-    {
-        $this->_data = $data;
-    }
-
-    /**
-     * magic setter
-     *
-     * @param string $name
-     * @param mixed $value
-     * @return void
-     */
-    public function __set($name, $value)
-    {
-        $this->_data[(string) $name] = $value;
-    }
-
-    /**
-     * magic getter
-     *
-     * @param string $name
-     * @return mixed|null
-     */
-    public function __get($name)
-    {
-        if (array_key_exists($name, $this->_data)) {
-            return $this->_data[(string) $name];
-        } else {
-            return null;
-        }
-    }
-}
-
-class RecordProxy extends Record
-{
-    /**
-     * @var bool
-     */
-    protected $_isDirty = false;
-
-    /**
-     * @var bool
-     */
-    protected $_isInitialized = false;
-
-    /**
-     * @param array
-     */
-    public function __construct($data)
-    {
-        parent::__construct($data);
-
-        // when the record has data, mark it as initialized
-        // since Record will hold our business logic, we don't want to
-        // implement this behaviour there, but instead in a new proxy class
-        // that extends the Record class
-        if (null !== $data) {
-            $this->_isInitialized = true;
-            $this->_isDirty = true;
-        }
-    }
-
-    /**
-     * magic setter
-     *
-     * @param string $name
-     * @param mixed $value
-     * @return void
-     */
-    public function __set($name, $value)
-    {
-        $this->_isDirty = true;
-        parent::__set($name, $value);
-    }
-}

Proxy/Record.php

@@ -0,0 +1,59 @@
+<?php
+
+namespace DesignPatterns\Proxy;
+
+/**
+ * Proxy pattern
+ *
+ * Purpose:
+ * to interface to anything that is expensive or impossible to duplicate
+ *
+ * Examples:
+ * - Doctrine2 uses proxies to implement framework magic (e.g. lazy initialization) in them, while the user still works
+ *   with his own entity classes and will never use nor touch the proxies
+ *
+ */
+class Record
+{
+    /**
+     * @var array|null
+     */
+    protected $data;
+
+    /**
+     * @param null $data
+     */
+    public function __construct($data = null)
+    {
+        $this->data = (array) $data;
+    }
+
+    /**
+     * magic setter
+     *
+     * @param string $name
+     * @param mixed  $value
+     *
+     * @return void
+     */
+    public function __set($name, $value)
+    {
+        $this->data[(string) $name] = $value;
+    }
+
+    /**
+     * magic getter
+     *
+     * @param string $name
+     *
+     * @return mixed|null
+     */
+    public function __get($name)
+    {
+        if (array_key_exists($name, $this->data)) {
+            return $this->data[(string) $name];
+        } else {
+            return null;
+        }
+    }
+}

Proxy/RecordProxy.php

@@ -0,0 +1,50 @@
+<?php
+
+namespace DesignPatterns\Proxy;
+
+/**
+ * Class RecordProxy
+ */
+class RecordProxy extends Record
+{
+    /**
+     * @var bool
+     */
+    protected $isDirty = false;
+
+    /**
+     * @var bool
+     */
+    protected $isInitialized = false;
+
+    /**
+     * @param array $data
+     */
+    public function __construct($data)
+    {
+        parent::__construct($data);
+
+        // when the record has data, mark it as initialized
+        // since Record will hold our business logic, we don't want to
+        // implement this behaviour there, but instead in a new proxy class
+        // that extends the Record class
+        if (null !== $data) {
+            $this->isInitialized = true;
+            $this->isDirty = true;
+        }
+    }
+
+    /**
+     * magic setter
+     *
+     * @param string $name
+     * @param mixed  $value
+     *
+     * @return void
+     */
+    public function __set($name, $value)
+    {
+        $this->isDirty = true;
+        parent::__set($name, $value);
+    }
+}

README.md

@@ -49,6 +49,7 @@ The patterns can be structured in roughly three different categories. Please cli
 ## Contribute
 
 Please feel free to fork and extend existing or add your own examples and send a pull request with your changes!
+To establish a consistent code quality, please check your code using [PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer) against [this standard](https://github.com/domnikl/Symfony2-coding-standard).
 
 ## License
 

Registry/Registry.php

@@ -14,39 +14,41 @@ namespace DesignPatterns;
  * - Yii Framework: CWebApplication holds all the application components, such as CWebUser, CUrlManager, etc.
  *
  */
-
 abstract class Registry
 {
     const LOGGER = 'logger';
 
-    protected static $_storedValues;
+    /**
+     * @var array
+     */
+    protected static $storedValues = array();
 
     /**
-     * @static
+     * sets a value
+     *
      * @param string $key
-     * @param mixed $value
+     * @param mixed  $value
+     *
+     * @static
      * @return void
      */
     public static function set($key, $value)
     {
-        self::$_storedValues[$key] = $value;
+        self::$storedValues[$key] = $value;
     }
 
     /**
-     * @static
+     * gets a value from the registry
+     *
      * @param string $key
+     *
+     * @static
      * @return mixed
      */
     public static function get($key)
     {
-        return self::$_storedValues[$key];
+        return self::$storedValues[$key];
     }
 
     // typically there would be methods to check if a key has already been registered and so on ...
 }
-
-// while bootstraping the application
-Registry::set(Registry::LOGGER, new \StdClass());
-
-// throughout the application
-Registry::get(Registry::LOGGER)->log('foo');

Registry/index.php

@@ -0,0 +1,9 @@
+<?php
+
+use DesignPatterns\Registry;
+
+// while bootstrapping the application
+Registry::set(Registry::LOGGER, new \StdClass());
+
+// throughout the application
+Registry::get(Registry::LOGGER)->log('foo');

SimpleFactory/Bicycle.php

@@ -1,20 +1,19 @@
 <?php
 
-/*
- * DesignPatternPHP
- */
-
 namespace DesignPatterns\SimpleFactory;
 
 /**
  * Bicycle is a bicycle
  */
-class Bicycle implements Vehicle
+class Bicycle implements VehicleInterface
 {
-
+    /**
+     * @param mixed $destination
+     *
+     * @return mixed|void
+     */
     public function driveTo($destination)
     {
-        
-    }
 
-}
+    }
+}

SimpleFactory/ConcreteFactory.php

@@ -1,9 +1,5 @@
 <?php
 
-/*
- * DesignPatternPHP
- */
-
 namespace DesignPatterns\SimpleFactory;
 
 /**
@@ -17,7 +13,9 @@ namespace DesignPatterns\SimpleFactory;
  */
 class ConcreteFactory
 {
-
+    /**
+     * @var array
+     */
     protected $typeList;
 
     /**
@@ -36,7 +34,8 @@ class ConcreteFactory
      * Creates a vehicle
      * 
      * @param string $type a known type key
-     * @return Vehicle a new instance of Vehicle
+     *
+     * @return VehicleInterface a new instance of VehicleInterface
      * @throws \InvalidArgumentException
      */
     public function createVehicle($type)
@@ -48,5 +47,4 @@ class ConcreteFactory
 
         return new $className();
     }
-
+}
-}

SimpleFactory/Scooter.php

@@ -1,20 +1,17 @@
 <?php
 
-/*
- * DesignPatternPHP
- */
-
 namespace DesignPatterns\SimpleFactory;
 
 /**
  * Scooter is a Scooter
  */
-class Scooter implements Vehicle
+class Scooter implements VehicleInterface
 {
-
+    /**
+     * @param mixed $destination
+     */
     public function driveTo($destination)
     {
-        
-    }
 
-}
+    }
+}

SimpleFactory/Vehicle.php

@@ -1,16 +0,0 @@
-<?php
-
-/*
- * DesignPatternPHP
- */
-
-namespace DesignPatterns\SimpleFactory;
-
-/**
- * Vehicle is a contract for a vehicle
- */
-interface Vehicle
-{
-
-    function driveTo($destination);
-}

SimpleFactory/VehicleInterface.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace DesignPatterns\SimpleFactory;
+
+/**
+ * VehicleInterface is a contract for a vehicle
+ */
+interface VehicleInterface
+{
+    /**
+     * @param mixed $destination
+     *
+     * @return mixed
+     */
+    public function driveTo($destination);
+}

Singleton/Singleton.php

@@ -40,7 +40,9 @@ class Singleton
      *
      */
     private function __construct()
-    {}
+    {
+
+    }
 
     /**
      * prevent the instance from being cloned
@@ -48,7 +50,9 @@ class Singleton
      * @return void
      */
     private function __clone()
-    {}
+    {
+
+    }
 
     /**
      * prevent from being unserialized
@@ -56,5 +60,7 @@ class Singleton
      * @return void
      */
     private function __wakeup()
-    {}
+    {
+
+    }
 }

State/CreateOrder.php

@@ -0,0 +1,49 @@
+<?php
+
+namespace DesignPatterns\Status;
+
+/**
+ * Class CreateOrder
+ */
+class CreateOrder implements OrderInterface
+{
+    /**
+     * @var array
+     */
+    private $order;
+
+    /**
+     * @param array $order
+     *
+     * @throws \Exception
+     */
+    public function __construct(array $order)
+    {
+        if (empty($order)) {
+            throw new \Exception('Order can not be empty!');
+        }
+        $this->order = $order;
+    }
+
+    /**
+     * @return mixed
+     */
+    public function shipOrder()
+    {
+        $this->order['status'] = 'shipping';
+        $this->order['updatedTime'] = time();
+
+        // Setting the new order status into database;
+        return $this->updateOrder($order);
+    }
+
+    /**
+     * @return mixed|void
+     * @throws \Exception
+     */
+    public function completeOrder()
+    {
+        //Can not complete the order which status is created, throw exception;
+        throw new \Exception('Can not complete the order which status is created!');
+    }
+}

State/OrderController.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace DesignPatterns\Status;
+
+/**
+ * Class OrderController
+ */
+class OrderController
+{
+    /**
+     * @param int $id
+     */
+    public function shipAction($id)
+    {
+        $order = OrderFactory::getOrder($id);
+        try {
+            $order->shipOrder($id);
+        } catch (Exception $e) {
+            //handle error!
+        }
+        // response to browser
+    }
+
+    /**
+     * @param int $id
+     */
+    public function completeAction($id)
+    {
+        $order = OrderFactory::getOrder($id);
+        try {
+            $order->completeOrder($id);
+        } catch (Exception $e) {
+            //handle error!
+        }
+        // response to browser
+    }
+}

State/OrderFactory.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace DesignPatterns\Status;
+
+/**
+ * Class OrderFactory
+ */
+class OrderFactory
+{
+    private function __construct()
+    {
+        throw Exception('Can not instance the OrderFactory class!');
+    }
+
+    /**
+     * @param int $id
+     *
+     * @return CreateOrder|ShippingOrder
+     * @throws \Exception
+     */
+    public static function getOrder($id)
+    {
+        $order = 'Get Order From Database';
+
+        switch ($order['status']) {
+            case 'created':
+                return new CreateOrder($order);
+            case 'shipping':
+                return new ShippingOrder($order);
+            default:
+                throw new \Exception('Order status error!');
+                break;
+        }
+    }
+}