Merge pull request #21 from gittingit/fixPHPDoc

Update PHPDoc annotations and correct some typo

src/JonnyW/PhantomJs/Cache/CacheInterface.php

@@ -29,6 +29,7 @@ interface CacheInterface
      * Fetch data from file.
      *
      * @access public
+     * @param string $id
      * @return void
      */
     public function fetch($id);

src/JonnyW/PhantomJs/Cache/FileCache.php

@@ -40,7 +40,6 @@ class FileCache implements CacheInterface
      * @access public
      * @param  string $directory
      * @param  string $extension
-     * @return void
      */
     public function __construct($directory, $extension)
     {
@@ -52,8 +51,8 @@ class FileCache implements CacheInterface
      * Write data to storage.
      *
      * @access public
-     * @param  string                                           $id
-     * @param  string                                           $data
+     * @param  string $id
+     * @param  string $data
      * @return string
      * @throws \JonnyW\PhantomJs\Exception\NotWritableException
      */
@@ -79,7 +78,9 @@ class FileCache implements CacheInterface
      * Fetch data from file.
      *
      * @access public
-     * @return void
+     * @param string $id
+     * @return mixed|void
+     * @throws \JonnyW\PhantomJs\Exception\NotExistsException
      */
     public function fetch($id)
     {
@@ -122,7 +123,7 @@ class FileCache implements CacheInterface
      * Is data writeable.
      *
      * @access protected
-     * @param  string  $id
+     * @param $file
      * @return boolean
      */
     protected function isWritable($file)
@@ -160,7 +161,8 @@ class FileCache implements CacheInterface
      *
      * @access protected
      * @param  string $id
-     * @return void
+     * @return string
+     * @throws \JonnyW\PhantomJs\Exception\NotWritableException
      */
     protected function getFileName($id)
     {

src/JonnyW/PhantomJs/Client.php

@@ -99,8 +99,7 @@ class Client implements ClientInterface
      *
      * @access public
      * @param  \JonnyW\PhantomJs\Procedure\ProcedureLoaderInterface $procedureLoader
-     * @param  \JonnyW\PhantomJs\Message\MessageFactoryInterface    $messageFactory
-     * @return void
+     * @param  \JonnyW\PhantomJs\Message\MessageFactoryInterface $messageFactory
      */
     public function __construct(ProcedureLoaderInterface $procedureLoader, MessageFactoryInterface $messageFactory)
     {
@@ -137,7 +136,7 @@ class Client implements ClientInterface
      * Get message factory instance
      *
      * @access public
-     * @return \JonnyW\PhantomJs\Message\FactoryInterface
+     * @return \JonnyW\PhantomJs\Message\MessageFactoryInterface
      */
     public function getMessageFactory()
     {
@@ -201,7 +200,7 @@ class Client implements ClientInterface
      * Set bin directory.
      *
      * @access public
-     * @param  string                   $path
+     * @param  string $path
      * @return \JonnyW\PhantomJs\Client
      */
     public function setBinDir($path)
@@ -226,7 +225,7 @@ class Client implements ClientInterface
      * Set new PhantomJs executable path.
      *
      * @access public
-     * @param  string                   $path
+     * @param  string $path
      * @return \JonnyW\PhantomJs\Client
      */
     public function setPhantomJs($path)
@@ -253,7 +252,7 @@ class Client implements ClientInterface
      * Set PhantomJs loader executable path.
      *
      * @access public
-     * @param  string                   $path
+     * @param  string $path
      * @return \JonnyW\PhantomJs\Client
      */
     public function setPhantomLoader($path)
@@ -280,7 +279,7 @@ class Client implements ClientInterface
      * Set PhantomJs run options.
      *
      * @access public
-     * @param  array                    $options
+     * @param  array $options
      * @return \JonnyW\PhantomJs\Client
      */
     public function setOptions(array $options)
@@ -305,7 +304,7 @@ class Client implements ClientInterface
      * Add single PhantomJs run option.
      *
      * @access public
-     * @param  string                   $option
+     * @param  string $option
      * @return \JonnyW\PhantomJs\Client
      */
     public function addOption($option)
@@ -321,7 +320,7 @@ class Client implements ClientInterface
      * Debug.
      *
      * @access public
-     * @param  boolean                  $doDebug
+     * @param  boolean $doDebug
      * @return \JonnyW\PhantomJs\Client
      */
     public function debug($doDebug)
@@ -335,7 +334,7 @@ class Client implements ClientInterface
      * Set log info.
      *
      * @access public
-     * @param  string                   $info
+     * @param  string $info
      * @return \JonnyW\PhantomJs\Client
      */
     public function setLog($info)
@@ -373,7 +372,7 @@ class Client implements ClientInterface
      * Validate execuable file.
      *
      * @access private
-     * @param  string                                                 $file
+     * @param  string $file
      * @return boolean
      * @throws \JonnyW\PhantomJs\Exception\InvalidExecutableException
      */

src/JonnyW/PhantomJs/ClientInterface.php

@@ -30,7 +30,7 @@ interface ClientInterface
      * Get message factory instance
      *
      * @access public
-     * @return \JonnyW\PhantomJs\Message\FactoryInterface
+     * @return \JonnyW\PhantomJs\Message\MessageFactoryInterface
      */
     public function getMessageFactory();
 
@@ -47,7 +47,7 @@ interface ClientInterface
      * Set bin directory.
      *
      * @access public
-     * @param  string                   $path
+     * @param  string $path
      * @return \JonnyW\PhantomJs\Client
      */
     public function setBinDir($path);

src/JonnyW/PhantomJs/DependencyInjection/ServiceContainer.php

@@ -22,7 +22,7 @@ class ServiceContainer extends ContainerBuilder
     /**
      * Service container instance
      *
-     * @var \JonnyW\PhantomJs\ServiceContainer
+     * @var \JonnyW\PhantomJs\DependencyInjection\ServiceContainer
      * @access private
      */
     private static $instance;
@@ -31,7 +31,6 @@ class ServiceContainer extends ContainerBuilder
      * Get singleton instance
      *
      * @access public
-     * @param  \JonnyW\PhantomJs\Message\FactoryInterface $messageFactory
      * @return \JonnyW\PhantomJs\Client
      */
     public static function getInstance()

src/JonnyW/PhantomJs/Message/AbstractRequest.php

@@ -87,10 +87,9 @@ abstract class AbstractRequest implements RequestInterface
      * Internal constructor
      *
      * @access public
-     * @param  string $url     (default: null)
-     * @param  string $method  (default: RequestInterface::METHOD_GET)
-     * @param  int    $timeout (default: 5000)
-     * @return void
+     * @param string $url (default: null)
+     * @param string $method (default: RequestInterface::METHOD_GET)
+     * @param int $timeout (default: 5000)
      */
     public function __construct($url = null, $method = RequestInterface::METHOD_GET, $timeout = 5000)
     {
@@ -112,7 +111,7 @@ abstract class AbstractRequest implements RequestInterface
      * Set request method
      *
      * @access public
-     * @param  string                                             $method
+     * @param  string $method
      * @return \JonnyW\PhantomJs\Message\AbstractRequest
      * @throws \JonnyW\PhantomJs\Exception\InvalidMethodException
      */
@@ -145,7 +144,7 @@ abstract class AbstractRequest implements RequestInterface
      * Set timeout period
      *
      * @access public
-     * @param  int                                       $timeout
+     * @param  int $timeout
      * @return \JonnyW\PhantomJs\Message\AbstractRequest
      */
     public function setTimeout($timeout)
@@ -170,7 +169,7 @@ abstract class AbstractRequest implements RequestInterface
      * Set page load delay time (seconds).
      *
      * @access public
-     * @param  int                                       $delay
+     * @param  int $delay
      * @return \JonnyW\PhantomJs\Message\AbstractRequest
      */
     public function setDelay($delay)
@@ -231,7 +230,7 @@ abstract class AbstractRequest implements RequestInterface
      * Set request URL
      *
      * @access public
-     * @param  string                                          $url
+     * @param  string $url
      * @return \JonnyW\PhantomJs\Message\AbstractRequest
      * @throws \JonnyW\PhantomJs\Exception\InvalidUrlException
      */
@@ -291,7 +290,7 @@ abstract class AbstractRequest implements RequestInterface
      * Set request data
      *
      * @access public
-     * @param  array                                     $data
+     * @param  array $data
      * @return \JonnyW\PhantomJs\Message\AbstractRequest
      */
     public function setRequestData(array $data)
@@ -321,7 +320,7 @@ abstract class AbstractRequest implements RequestInterface
      * Set headers
      *
      * @access public
-     * @param  array                                     $headers
+     * @param  array $headers
      * @return \JonnyW\PhantomJs\Message\AbstractRequest
      */
     public function setHeaders(array $headers)
@@ -333,8 +332,8 @@ abstract class AbstractRequest implements RequestInterface
      * Add single header
      *
      * @access public
-     * @param  string                                    $header
-     * @param  string                                    $value
+     * @param  string $header
+     * @param  string $value
      * @return \JonnyW\PhantomJs\Message\AbstractRequest
      */
     public function addHeader($header, $value)
@@ -348,7 +347,7 @@ abstract class AbstractRequest implements RequestInterface
      * Merge headers with existing
      *
      * @access public
-     * @param  array                                     $headers
+     * @param  array $headers
      * @return \JonnyW\PhantomJs\Message\AbstractRequest
      */
     public function addHeaders(array $headers)
@@ -384,7 +383,7 @@ abstract class AbstractRequest implements RequestInterface
      * @param  string $format
      * @return array
      */
-    protected function flattenData(array $data, $prefix  = '', $format = '%s')
+    protected function flattenData(array $data, $prefix = '', $format = '%s')
     {
         $flat = array();
 

src/JonnyW/PhantomJs/Message/CaptureRequest.php

@@ -63,10 +63,10 @@ class CaptureRequest extends AbstractRequest
      * Internal constructor
      *
      * @access public
-     * @param  string $url     (default: null)
-     * @param  string $method  (default: RequestInterface::METHOD_GET)
-     * @param  int    $timeout (default: 5000)
-     * @return void
+     * @param string $url (default: null)
+     * @param string $method (default: RequestInterface::METHOD_GET)
+     * @param int $timeout (default: 5000)
+     * @return \JonnyW\PhantomJs\Message\CaptureRequest
      */
     public function __construct($url = null, $method = RequestInterface::METHOD_GET, $timeout = 5000)
     {
@@ -93,10 +93,10 @@ class CaptureRequest extends AbstractRequest
      * Set viewport size.
      *
      * @access public
-     * @param  int                                       $width
-     * @param  int                                       $height
-     * @param  int                                       $top    (default: 0)
-     * @param  int                                       $left   (default: 0)
+     * @param  int $width
+     * @param  int $height
+     * @param  int $top    (default: 0)
+     * @param  int $left   (default: 0)
      * @return \JonnyW\PhantomJs\Message\AbstractRequest
      */
     public function setCaptureDimensions($width, $height, $top = 0, $left = 0)
@@ -157,9 +157,9 @@ class CaptureRequest extends AbstractRequest
      * Set file to save screen capture.
      *
      * @access public
-     * @param  string                                            $file
+     * @param  string $file
+     * @throws \JonnyW\PhantomJs\Exception\NotWritableException
      * @return \JonnyW\PhantomJs\Message\CaptureRequest
-     * @throws \JonnyW\PhantomJs\Exception\NotWriteableException
      */
     public function setCaptureFile($file)
     {

src/JonnyW/PhantomJs/Message/MessageFactory.php

@@ -42,9 +42,9 @@ class MessageFactory implements MessageFactoryInterface
      * Create request instance.
      *
      * @access public
-     * @param  string                            $url
-     * @param  string                            $method
-     * @param  int                               $timeout
+     * @param  string $url
+     * @param  string $method
+     * @param  int $timeout
      * @return \JonnyW\PhantomJs\Message\Request
      */
     public function createRequest($url = null, $method = RequestInterface::METHOD_GET, $timeout = 5000)
@@ -56,9 +56,9 @@ class MessageFactory implements MessageFactoryInterface
      * Create capture request instance.
      *
      * @access public
-     * @param  string                            $url
-     * @param  string                            $method
-     * @param  int                               $timeout
+     * @param  string $url
+     * @param  string $method
+     * @param  int $timeout
      * @return \JonnyW\PhantomJs\Message\Request
      */
     public function createCaptureRequest($url = null, $method = RequestInterface::METHOD_GET, $timeout = 5000)

src/JonnyW/PhantomJs/Message/Request.php

@@ -43,7 +43,7 @@ class Request extends AbstractRequest
      * Set request type
      *
      * @access public
-     * @param  string                                    $type
+     * @param  string $type
      * @return \JonnyW\PhantomJs\Message\AbstractRequest
      */
     public function setType($type)

src/JonnyW/PhantomJs/Message/Response.php

@@ -83,6 +83,7 @@ class Response implements ResponseInterface
      * Import response data
      *
      * @access public
+     * @param array $data
      * @return \JonnyW\PhantomJs\Message\Response
      */
     public function import(array $data)
@@ -111,7 +112,7 @@ class Response implements ResponseInterface
      * Set headers array
      *
      * @access protected
-     * @param  array                              $headers
+     * @param  array $headers
      * @return \JonnyW\PhantomJs\Message\Response
      */
     protected function setHeaders(array $headers)
@@ -165,7 +166,7 @@ class Response implements ResponseInterface
     }
 
     /**
-     * Get page content from respone
+     * Get page content from response
      *
      * @access public
      * @return string

src/JonnyW/PhantomJs/Parser/JsonParser.php

@@ -19,7 +19,7 @@ class JsonParser implements ParserInterface
      * Parse json string into array.
      *
      * @access public
-     * @param  string    $data
+     * @param  string $data
      * @return \stdClass
      */
     public function parse($data)

src/JonnyW/PhantomJs/Procedure/ChainProcedureLoader.php

@@ -26,11 +26,10 @@ class ChainProcedureLoader implements ProcedureLoaderInterface
     protected $procedureLoaders;
 
     /**
-     * Internal cosntructure.
+     * Internal constructor.
      *
      * @access public
      * @param  array $procedureLoaders
-     * @return void
      */
     public function __construct(array $procedureLoaders)
     {
@@ -53,12 +52,13 @@ class ChainProcedureLoader implements ProcedureLoaderInterface
      * Load procedure instance by id.
      *
      * @access public
-     * @param  string                                         $id
+     * @param  string $id
+     * @throws \InvalidArgumentException
      * @return \JonnyW\PhantomJs\Procedure\ProcedureInterface
-     * @throws \JonnyW\PhantomJs\Exception\NotExistsException
      */
     public function load($id)
     {
+        /** @var \JonnyW\PhantomJs\Procedure\ProcedureLoaderInterface $loader */
         foreach ($this->procedureLoaders as $loader) {
 
             try {

src/JonnyW/PhantomJs/Procedure/Procedure.php

@@ -60,10 +60,9 @@ class Procedure implements ProcedureInterface
      * Internal constructor.
      *
      * @access public
-     * @param  \JonnyW\PhantomJs\Parser\ParserInterface             $parser
-     * @param  \JonnyW\PhantomJs\Cache\CacheInterface               $cacheHandler
+     * @param  \JonnyW\PhantomJs\Parser\ParserInterface $parser
+     * @param  \JonnyW\PhantomJs\Cache\CacheInterface $cacheHandler
      * @param  \JonnyW\PhantomJs\Template\TemplateRendererInterface $renderer
-     * @return void
      */
     public function __construct(ParserInterface $parser, CacheInterface $cacheHandler, TemplateRendererInterface $renderer)
     {
@@ -76,12 +75,13 @@ class Procedure implements ProcedureInterface
      * Run procedure.
      *
      * @access public
-     * @param  \JonnyW\PhantomJs\ClientInterface                    $client
-     * @param  \JonnyW\PhantomJs\Message\RequestInterface           $request
-     * @param  \JonnyW\PhantomJs\Message\ResponseInterface          $response
-     * @return void
-     * @throws \JonnyW\PhantomJs\Exception\NotWriteableException
+     * @param  \JonnyW\PhantomJs\ClientInterface $client
+     * @param  \JonnyW\PhantomJs\Message\RequestInterface $request
+     * @param  \JonnyW\PhantomJs\Message\ResponseInterface $response
      * @throws \JonnyW\PhantomJs\Exception\ProcedureFailedException
+     * @throws \Exception
+     * @throws \JonnyW\PhantomJs\Exception\NotWritableException
+     * @return void
      */
     public function run(ClientInterface $client, RequestInterface $request, ResponseInterface $response)
     {
@@ -137,7 +137,7 @@ class Procedure implements ProcedureInterface
      * Load procedure.
      *
      * @access public
-     * @param  string                                $procedure
+     * @param  string $procedure
      * @return \JonnyW\PhantomJs\Procedure\Procedure
      */
     public function load($procedure)

src/JonnyW/PhantomJs/Procedure/ProcedureFactory.php

@@ -48,10 +48,9 @@ class ProcedureFactory implements ProcedureFactoryInterface
      * Internal constructor.
      *
      * @access public
-     * @param  \JonnyW\PhantomJs\Parser\ParserInterface             $parser
-     * @param  \JonnyW\PhantomJs\Cache\CacheInterface               $cacheHandler
+     * @param  \JonnyW\PhantomJs\Parser\ParserInterface $parser
+     * @param  \JonnyW\PhantomJs\Cache\CacheInterface $cacheHandler
      * @param  \JonnyW\PhantomJs\Template\TemplateRendererInterface $renderer
-     * @return void
      */
     public function __construct(ParserInterface $parser, CacheInterface $cacheHandler, TemplateRendererInterface $renderer)
     {

src/JonnyW/PhantomJs/Procedure/ProcedureLoader.php

@@ -39,8 +39,7 @@ class ProcedureLoader implements ProcedureLoaderInterface
      *
      * @access public
      * @param  \JonnyW\PhantomJs\Procedure\ProcedureFactoryInterface $procedureFactory
-     * @param  \Symfony\Component\Config\FileLocatorInterface        $locator
-     * @return void
+     * @param  \Symfony\Component\Config\FileLocatorInterface $locator
      */
     public function __construct(ProcedureFactoryInterface $procedureFactory, FileLocatorInterface $locator)
     {
@@ -52,7 +51,7 @@ class ProcedureLoader implements ProcedureLoaderInterface
      * Load procedure instance by id.
      *
      * @access public
-     * @param  string                                         $id
+     * @param  string $id
      * @return \JonnyW\PhantomJs\Procedure\ProcedureInterface
      */
     public function load($id)
@@ -70,7 +69,7 @@ class ProcedureLoader implements ProcedureLoaderInterface
      * Load procedure file content.
      *
      * @access protected
-     * @param  string                                         $file
+     * @param  string $file
      * @return string
      * @throws \InvalidArgumentException
      * @throws \JonnyW\PhantomJs\Exception\NotExistsException

src/JonnyW/PhantomJs/Procedure/ProcedureLoaderFactory.php

@@ -31,7 +31,6 @@ class ProcedureLoaderFactory implements ProcedureLoaderFactoryInterface
      *
      * @access public
      * @param  \JonnyW\PhantomJs\Procedure\ProcedureFactoryInterface $procedureFactory
-     * @return void
      */
     public function __construct(ProcedureFactoryInterface $procedureFactory)
     {
@@ -42,7 +41,7 @@ class ProcedureLoaderFactory implements ProcedureLoaderFactoryInterface
      * Create procedure loader instance.
      *
      * @access public
-     * @param  string                                      $directory
+     * @param  string $directory
      * @return \JonnyW\PhantomJs\Procedure\ProcedureLoader
      */
     public function createProcedureLoader($directory)
@@ -62,7 +61,7 @@ class ProcedureLoaderFactory implements ProcedureLoaderFactoryInterface
      * Create file locator instance.
      *
      * @access protected
-     * @param  string                                $directory
+     * @param  string $directory
      * @return \Symfony\Component\Config\FileLocator
      * @throws \InvalidArgumentException
      */

src/JonnyW/PhantomJs/Procedure/ProcedureLoaderFactoryInterface.php

@@ -20,7 +20,7 @@ interface ProcedureLoaderFactoryInterface
      * Create procedure loader instance.
      *
      * @access public
-     * @param  string                                               $directory
+     * @param  string $directory
      * @return \JonnyW\PhantomJs\Procedure\ProcedureLoaderInterface
      */
     public function createProcedureLoader($directory);

src/JonnyW/PhantomJs/Procedure/ProcedureLoaderInterface.php

@@ -19,7 +19,7 @@ interface ProcedureLoaderInterface
      * Load procedure instance by id.
      *
      * @access public
-     * @param  string                                         $id
+     * @param  string $id
      * @return \JonnyW\PhantomJs\Procedure\ProcedureInterface
      */
     public function load($id);

src/JonnyW/PhantomJs/Template/TemplateRenderer.php

@@ -28,7 +28,6 @@ class TemplateRenderer implements TemplateRendererInterface
      *
      * @access public
      * @param  \Twig_Environment $twig
-     * @return void
      */
     public function __construct(\Twig_Environment $twig)
     {

src/JonnyW/PhantomJs/Tests/Integration/Template/TemplateRendererTest.php

@@ -107,7 +107,7 @@ class TemplateRendererTest extends TestCase
     /**
      * Get template renderer instance.
      *
-     * @param  \Twig_Environment                          $twig
+     * @param  \Twig_Environment $twig
      * @return \JonnyW\PhantomJs\Message\TemplateRenderer
      */
     protected function getTemplateRenderer(\Twig_Environment $twig)