Merge remote-tracking branch 'prolic/phpdoc-di' into prolic-zen-52

zendframework · Jun 28, 2012 · 761379e · 761379e
commit 761379e
Show file tree

Hide file tree

Showing 21 changed files with 460 additions and 101 deletions.
diff --git a/src/Configuration.php b/src/Configuration.php
@@ -7,15 +7,16 @@
 
 class Configuration
 {
-    protected $data = array();
-
     /**
-     * @var Zend\Di\DependencyInjector
+     * @var array
      */
-    protected $di = null;
-
+    protected $data = array();
+    
     /**
+     * Constructor
+     *
      * @param  array|Traversable $options
+     * @throws Exception\InvalidArgumentException
      */
     public function __construct($options)
     {
@@ -30,7 +31,13 @@ public function __construct($options)
         }
         $this->data = $options;
     }
-
+
+    /**
+     * Configure
+     *
+     * @param Di $di
+     * @return void
+     */
     public function configure(Di $di)
     {
         if (isset($this->data['definition'])) {

diff --git a/src/Definition/Builder/PhpClass.php b/src/Definition/Builder/PhpClass.php
@@ -9,13 +9,24 @@ class PhpClass
     protected $instantiator         = '__construct';
     protected $injectionMethods     = array();
     protected $superTypes           = array();
-
+
+    /**
+     * Set name
+     *
+     * @param string $name
+     * @return PhpClass
+     */
     public function setName($name)
     {
         $this->name = $name;
         return $this;
     }
-
+
+    /**
+     * Get name
+     *
+     * @return string
+     */
     public function getName()
     {
         return $this->name;
@@ -31,18 +42,29 @@ public function getInstantiator()
     {
         return $this->instantiator;
     }
-    
+
     public function addSuperType($superType)
     {
         $this->superTypes[] = $superType;
         return $this;
     }
-
+
+    /**
+     * Get super types
+     *
+     * @return array
+     */
     public function getSuperTypes()
     {
         return $this->superTypes;
     }
-
+
+    /**
+     * Add injection method
+     *
+     * @param InjectionMethod $injectionMethod
+     * @return PhpClass
+     */
     public function addInjectionMethod(InjectionMethod $injectionMethod)
     {
         $this->injectionMethods[] = $injectionMethod;

diff --git a/src/Definition/BuilderDefinition.php b/src/Definition/BuilderDefinition.php
@@ -6,9 +6,22 @@
 
 class BuilderDefinition implements DefinitionInterface
 {
+    /**
+     * @var string
+     */
     protected $defaultClassBuilder = 'Zend\Di\Definition\Builder\PhpClass';
+
+    /**
+     * @var array
+     */
     protected $classes = array();
 
+    /**
+     * Create classes from array
+     *
+     * @param array $builderData
+     * @return void
+     */
     public function createClassesFromArray(array $builderData)
     {
         foreach ($builderData as $className => $classInfo) {
@@ -42,7 +55,13 @@ public function createClassesFromArray(array $builderData)
             $this->addClass($class);
         }
     }
-
+
+    /**
+     * Add class
+     *
+     * @param Builder\PhpClass $phpClass
+     * @return BuilderDefinition
+     */
     public function addClass(Builder\PhpClass $phpClass)
     {
         $this->classes[] = $phpClass;
@@ -93,7 +112,10 @@ public function getClassBuilder()
     {
         return $this->defaultClassBuilder;
     }
-
+
+    /**
+     * @return array
+     */
     public function getClasses()
     {
         $classNames = array();
@@ -102,7 +124,11 @@ public function getClasses()
         }
         return $classNames;
     }
-
+
+    /**
+     * @param string $class
+     * @return bool
+     */
     public function hasClass($class)
     {
         foreach ($this->classes as $classObj) {
@@ -112,7 +138,11 @@ public function hasClass($class)
         }
         return false;
     }
-
+
+    /**
+     * @param string $name
+     * @return bool
+     */
     protected function getClass($name)
     {
         foreach ($this->classes as $classObj) {
@@ -122,7 +152,12 @@ protected function getClass($name)
         }
         return false;
     }
-
+
+    /**
+     * @param string $class
+     * @return array
+     * @throws Exception\RuntimeException
+     */
     public function getClassSupertypes($class)
     {
         $class = $this->getClass($class);
@@ -131,7 +166,12 @@ public function getClassSupertypes($class)
         }
         return $class->getSuperTypes();
     }
-
+
+    /**
+     * @param string $class
+     * @return array|string
+     * @throws Exception\RuntimeException
+     */
     public function getInstantiator($class)
     {
         $class = $this->getClass($class);
@@ -140,17 +180,27 @@ public function getInstantiator($class)
         }
         return $class->getInstantiator();
     }
-
+
+    /**
+     * @param string $class
+     * @return bool
+     * @throws Exception\RuntimeException
+     */
     public function hasMethods($class)
     {
-        /* @var $class Zend\Di\Definition\Builder\PhpClass */
+        /* @var $class \Zend\Di\Definition\Builder\PhpClass */
         $class = $this->getClass($class);
         if ($class === false) {
             throw new Exception\RuntimeException('Cannot find class object in this builder definition.');
         }
         return (count($class->getInjectionMethods()) > 0);
     }
-
+
+    /**
+     * @param string $class
+     * @return array
+     * @throws Exception\RuntimeException
+     */
     public function getMethods($class)
     {
         $class = $this->getClass($class);
@@ -164,7 +214,13 @@ public function getMethods($class)
         }
         return $methodNames;
     }
-
+
+    /**
+     * @param string $class
+     * @param string $method
+     * @return bool
+     * @throws Exception\RuntimeException
+     */
     public function hasMethod($class, $method)
     {
         $class = $this->getClass($class);
@@ -181,8 +237,8 @@ public function hasMethod($class, $method)
     }
 
     /**
-     * @param $class
-     * @param $method
+     * @param string $class
+     * @param string $method
      * @return bool
      */
     public function hasMethodParameters($class, $method)
@@ -202,7 +258,13 @@ public function hasMethodParameters($class, $method)
         }
         return (count($method->getParameters()) > 0);
     }
-
+
+    /**
+     * @param string $class
+     * @param string $method
+     * @return array
+     * @throws Exception\RuntimeException
+     */
     public function getMethodParameters($class, $method)
     {
         $class = $this->getClass($class);

diff --git a/src/Definition/ClassDefinition.php b/src/Definition/ClassDefinition.php
@@ -29,6 +29,11 @@ public function setSupertypes(array $supertypes)
         return $this;
     }
 
+    /**
+     * @param string $method
+     * @param bool|null $isRequired
+     * @return ClassDefinition
+     */
     public function addMethod($method, $isRequired = null)
     {
         if ($isRequired === null) {
@@ -43,6 +48,7 @@ public function addMethod($method, $isRequired = null)
      * @param $method
      * @param $parameterName
      * @param array $parameterInfo (keys: required, type)
+     * @return ClassDefinition
      */
     public function addMethodParameter($method, $parameterName, array $parameterInfo)
     {

diff --git a/src/Definition/CompilerDefinition.php b/src/Definition/CompilerDefinition.php
@@ -2,15 +2,14 @@
 
 namespace Zend\Di\Definition;
 
-use Zend\Code\Scanner\DerivedClassScanner,
-    Zend\Code\Scanner\AggregateDirectoryScanner,
-    Zend\Code\Scanner\DirectoryScanner,
-    Zend\Code\Scanner\FileScanner,
-
-    Zend\Di\Definition\Annotation,
-    Zend\Code\Annotation\AnnotationManager,
-    Zend\Code\Reflection,
-    Zend\Code\Annotation\AnnotationCollection;
+use Zend\Code\Annotation\AnnotationCollection;
+use Zend\Code\Annotation\AnnotationManager;
+use Zend\Code\Scanner\AggregateDirectoryScanner;
+use Zend\Code\Scanner\DirectoryScanner;
+use Zend\Code\Scanner\DerivedClassScanner;
+use Zend\Code\Scanner\FileScanner;
+use Zend\Code\Reflection;
+use Zend\Di\Definition\Annotation;
 
 class CompilerDefinition implements DefinitionInterface
 {
@@ -25,36 +24,62 @@ class CompilerDefinition implements DefinitionInterface
 
     protected $classes = array();
 
+    /**
+     * Constructor
+     *
+     * @param null|IntrospectionStrategy $introspectionStrategy
+     */
     public function __construct(IntrospectionStrategy $introspectionStrategy = null)
     {
         $this->introspectionStrategy = ($introspectionStrategy) ?: new IntrospectionStrategy();
         $this->directoryScanner = new AggregateDirectoryScanner();
     }
 
+    /**
+     * Set introspection strategy
+     *
+     * @param IntrospectionStrategy $introspectionStrategy
+     */
     public function setIntrospectionStrategy(IntrospectionStrategy $introspectionStrategy)
     {
         $this->introspectionStrategy = $introspectionStrategy;
     }
 
     /**
-     * 
+     * Get introspection strategy
+     *
      * @return IntrospectionStrategy
      */
     public function getIntrospectionStrategy()
     {
         return $this->introspectionStrategy;
     }
 
+    /**
+     * Add directory
+     *
+     * @param string $directory
+     */
     public function addDirectory($directory)
     {
         $this->addDirectoryScanner(new DirectoryScanner($directory));
     }
 
+    /**
+     * Add directory scanner
+     *
+     * @param DirectoryScanner $directoryScanner
+     */
     public function addDirectoryScanner(DirectoryScanner $directoryScanner)
     {
         $this->directoryScanner->addDirectoryScanner($directoryScanner);
     }
-
+
+    /**
+     * Add code scanner file
+     *
+     * @param FileScanner $fileScanner
+     */
     public function addCodeScannerFile(FileScanner $fileScanner)
     {
         if ($this->directoryScanner == null) {
@@ -63,7 +88,12 @@ public function addCodeScannerFile(FileScanner $fileScanner)
 
         $this->directoryScanner->addFileScanner($fileScanner);
     }
-
+
+    /**
+     * Compile
+     *
+     * @return void
+     */
     public function compile()
     {
         /* @var $classScanner \Zend\Code\Scanner\DerivedClassScanner */