Merge pull request #2 from kokspflanze/improvement/doc_block

Improvement/doc block

Author: tck

composer.json

@@ -42,7 +42,8 @@
         "phpmd/phpmd": "2.*",
         "sebastian/phpcpd": "2.*",
         "theseer/phpdox": "0.7.*",
-        "nikic/php-parser": "<1.2.0"
+        "nikic/php-parser": "<1.2.0",
+        "zendframework/zend-serializer": "~2.5"
     },
     "autoload": {
         "psr-0" : {

src/TckImageResizer/Controller/IndexController.php

@@ -34,8 +34,9 @@ class IndexController extends AbstractActionController
 
     /**
      * constructor
-     * 
-     * @param ImageProcessing
+     *
+     * @param ImageProcessing $imageProcessing
+     * @param string $publicDirectory
      */
     public function __construct(ImageProcessing $imageProcessing, $publicDirectory = 'public')
     {
@@ -45,8 +46,9 @@ public function __construct(ImageProcessing $imageProcessing, $publicDirectory =
 
     /**
      * set the image processing service
-     * 
-     * @param ImageProcessing
+     *
+     * @param ImageProcessing $imageProcessing
+     * @return $this
      */
     public function setImageProcessing(ImageProcessing $imageProcessing)
     {
@@ -64,8 +66,10 @@ public function getImageProcessing()
     {
         return $this->imageProcessing;
     }
-    
-    
+
+    /**
+     * @return \Zend\Http\Response
+     */
     public function resizeAction()
     {
         $source = $this->publicDirectory . '/'
@@ -92,7 +96,8 @@ public function resizeAction()
 
         $imageInfo = getimagesize($target);
         $mimeType = $imageInfo['mime'];
-        
+
+        /** @var \Zend\Http\Response $response */
         $response = $this->getResponse();
         $response->setContent(file_get_contents($target));
         $response->setStatusCode($source ? 200 : 404);

src/TckImageResizer/Controller/IndexControllerFactory.php

@@ -23,8 +23,9 @@ class IndexControllerFactory implements FactoryInterface
 {
     /**
      * Create Service Factory
-     * 
-     * @param ServiceLocatorInterface $serviceLocator
+     *
+     * @param \Zend\Mvc\Controller\ControllerManager|ServiceLocatorInterface $serviceLocator
+     * @return IndexController
      */
     public function createService(ServiceLocatorInterface $serviceLocator)
     {

src/TckImageResizer/Service/ImageProcessing.php

@@ -49,8 +49,9 @@ public function __construct(AbstractImagine $imagine)
 
     /**
      * set the imagine service
-     * 
-     * @param AbstractImagine
+     *
+     * @param AbstractImagine $imagine
+     * @return $this
      */
     public function setImagineService(AbstractImagine $imagine)
     {

src/TckImageResizer/Service/ImageProcessingFactory.php

@@ -26,11 +26,13 @@ class ImageProcessingFactory implements FactoryInterface
 {
     /**
      * Create Service Factory
-     * 
+     *
      * @param ServiceLocatorInterface $serviceLocator
+     * @return ImageProcessing
      */
     public function createService(ServiceLocatorInterface $serviceLocator)
     {
+        /** @var \Imagine\Gd\Imagine $imagine */
         $imagine = $serviceLocator->get('TckImageResizerImagine');
 
         $service = new ImageProcessing($imagine);

test/Bootstrap.php

@@ -13,9 +13,10 @@
 
 class Bootstrap
 {
+    /** @var  ServiceManager */
     protected static $serviceManager;
-    protected static $config;
-    protected static $bootstrap;
+    /** @var  array */
+    protected static $config = array();
 
     public static function init()
     {
@@ -60,11 +61,17 @@ public static function init()
         static::$config = $config;
     }
 
+    /**
+     * @return ServiceManager
+     */
     public static function getServiceManager()
     {
         return static::$serviceManager;
     }
 
+    /**
+     * @return array
+     */
     public static function getConfig()
     {
         return static::$config;
@@ -100,6 +107,10 @@ protected static function initAutoloader()
         ));
     }
 
+    /**
+     * @param $path
+     * @return bool|string
+     */
     protected static function findParentPath($path)
     {
         $dir = __DIR__;

test/TckImageResizerTest/Controller/IndexControllerFactoryTest.php

@@ -17,7 +17,9 @@
 
 class IndexControllerFactoryTest extends PHPUnit_Framework_TestCase
 {
+    /** @var  \Zend\Mvc\Controller\ControllerManager */
     protected $controllerManager;
+    /** @var  IndexControllerFactory */
     protected $controllerFactory;
 
     protected function setUp()

test/TckImageResizerTest/Controller/IndexControllerTest.php

@@ -23,10 +23,15 @@
 
 class IndexControllerTest extends PHPUnit_Framework_TestCase
 {
+    /** @var  IndexController */
     protected $controller;
+    /** @var  Request */
     protected $request;
+    /** @var  RouteMatch */
     protected $routeMatch;
+    /** @var  MvcEvent */
     protected $event;
+    /** @var  \org\bovigo\vfs\vfsStreamDirectory */
     protected $fileSystem;
 
     protected function setUp()
@@ -39,7 +44,8 @@ protected function setUp()
             ),
             'processed' => array(),
         ));
-        
+
+        /** @var \TckImageResizer\Service\ImageProcessing $imageProcessing */
         $imageProcessing = $serviceManager->get('TckImageResizer\Service\ImageProcessing');
         $this->controller = new IndexController($imageProcessing, vfsStream::url('public'));
         $this->request    = new Request();

test/TckImageResizerTest/Service/ImageProcessingFactoryTest.php

@@ -17,7 +17,9 @@
 
 class ImageProcessingFactoryTest extends PHPUnit_Framework_TestCase
 {
+    /** @var  serviceManager */
     protected $serviceManager;
+    /** @var  ImageProcessingFactory */
     protected $imageProcessingFactory;
 
     protected function setUp()

test/TckImageResizerTest/Service/ImageProcessingTest.php

@@ -17,12 +17,16 @@
 use PHPUnit_Framework_TestCase;
 use org\bovigo\vfs\vfsStream;
 use org\bovigo\vfs\vfsStreamWrapper;
+use TckImageResizer\Exception\BadMethodCallException;
 
 class ImageProcessingTest extends PHPUnit_Framework_TestCase
 {
+    /** @var  \Zend\ServiceManager\ServiceManager */
     protected $serviceManager;
     protected $fileSystem;
+    /** @var  \Imagine\Gd\Imagine */
     protected $imagine;
+    /** @var  ImageProcessing */
     protected $imageProcessing;
 
     protected function setUp()

test/TckImageResizerTest/View/Helper/ResizeTest.php

@@ -17,7 +17,9 @@
 
 class ResizeTest extends PHPUnit_Framework_TestCase
 {
+    /** @var  PhpRenderer */
     protected $view;
+    /** @var  Resize */
     protected $helper;
 
     protected function setUp()