cs

Author: Dominik Liebler

Adapter/EBookAdapter.php

@@ -1,9 +1,5 @@
 <?php
 
-/*
- * DesignPatternPHP
- */
-
 namespace DesignPatterns\Adapter;
 
 /**

Builder/BikeBuilder.php

@@ -1,9 +1,5 @@
 <?php
 
-/*
- * DesignPatternPHP
- */
-
 namespace DesignPatterns\Builder;
 
 /**

Builder/Builder.php

@@ -1,9 +1,5 @@
 <?php
 
-/*
- * DesignPatternPHP
- */
-
 namespace DesignPatterns\Builder;
 
 /**
@@ -20,14 +16,28 @@
  */
 interface Builder
 {
-
-    function createVehicle();
-
-    function addWheel();
-
-    function addEngine();
-
-    function addDoors();
-
-    function getVehicle();
-}
+    /**
+     * @return mixed
+     */
+    public function createVehicle();
+
+    /**
+     * @return mixed
+     */
+    public function addWheel();
+
+    /**
+     * @return mixed
+     */
+    public function addEngine();
+
+    /**
+     * @return mixed
+     */
+    public function addDoors();
+
+    /**
+     * @return mixed
+     */
+    public function getVehicle();
+}

Builder/CarBuilder.php

@@ -1,9 +1,5 @@
 <?php
 
-/*
- * DesignPatternPHP
- */
-
 namespace DesignPatterns\Builder;
 
 /**
@@ -42,5 +38,4 @@ public function getVehicle()
     {
         return $this->car;
     }
-
-}
+}

Builder/Director.php

@@ -1,9 +1,5 @@
 <?php
 
-/*
- * DesignPatternPHP
- */
-
 namespace DesignPatterns\Builder;
 
 /**

Builder/Parts/Bike.php

@@ -1,15 +1,11 @@
 <?php
 
-/*
- * DesignPatternPHP
- */
-
 namespace DesignPatterns\Builder\Parts;
 
 /**
  * Bike is a bike
  */
 class Bike extends Vehicle
 {
-    
-}
+
+}

Builder/Parts/Car.php

@@ -1,15 +1,11 @@
 <?php
 
-/*
- * DesignPatternPHP
- */
-
 namespace DesignPatterns\Builder\Parts;
 
 /**
  * Car is a car
  */
 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;
 
 /**
  * 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;
     }
-
-}
+}

ChainOfResponsibilities/ChainOfResponsibilities.php

@@ -93,4 +93,4 @@ public function get($key)
 /**
  * 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 @@
  */
 abstract class Handler
 {
-
+    /**
+     * @var null
+     */
     private $successor = null;
 
     /**
@@ -69,4 +67,4 @@ final public function handle(Request $req)
      * @return bool true if the request has been processed
      */
     abstract protected function processing(Request $req);
-}
+}

ChainOfResponsibilities/Request.php

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

ChainOfResponsibilities/Responsible/FastStorage.php

@@ -1,9 +1,5 @@
 <?php
 
-/*
- * DesignPatternPHP
- */
-
 namespace DesignPatterns\ChainOfResponsibilities\Responsible;
 
 use DesignPatterns\ChainOfResponsibilities\Handler;
@@ -33,5 +29,4 @@ protected function processing(Request $req)
 
         return false;
     }
-
 }

ChainOfResponsibilities/Responsible/SlowStorage.php

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

Command/Invoker.php

@@ -1,9 +1,5 @@
 <?php
 
-/*
- * DesignPatternPHP
- */
-
 namespace DesignPatterns\Command;
 
 /**

Command/Receiver.php

@@ -1,9 +1,5 @@
 <?php
 
-/*
- * DesignPatternPHP
- */
-
 namespace DesignPatterns\Command;
 
 /**

FactoryMethod/Bicycle.php

@@ -5,7 +5,7 @@
 /**
  * Bicycle is a bicycle
  */
-class Bicycle implements Vehicle
+class Bicycle implements VehicleInterface
 {
     /**
      * @var string

FactoryMethod/FactoryMethod.php

@@ -28,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);
 
@@ -37,7 +37,7 @@ abstract protected function createVehicle($type);
      * 
      * @param int $type
      * 
-     * @return Vehicle a new vehicle
+     * @return VehicleInterface a new vehicle
      */
     public function create($type)
     {

FactoryMethod/Ferrari.php

@@ -5,7 +5,7 @@
 /**
  * Ferrari is a italian car
  */
-class Ferrari implements Vehicle
+class Ferrari implements VehicleInterface
 {
     /**
      * @var string

FactoryMethod/Porsche.php

@@ -5,7 +5,7 @@
 /**
  * Porsche is a german car
  */
-class Porsche implements Vehicle
+class Porsche implements VehicleInterface
 {
     /**
      * @var string

FactoryMethod/Vehicle.php FactoryMethod/VehicleInterface.php

@@ -3,14 +3,14 @@
 namespace DesignPatterns\FactoryMethod;
 
 /**
- * Vehicle is a contract for a vehicle
+ * VehicleInterface is a contract for a vehicle
  */
-interface Vehicle
+interface VehicleInterface
 {
     /**
      * sets the color of the vehicle
      *
      * @param string $rgb
      */
-    function setColor($rgb);
+    public function setColor($rgb);
 }