Fixed the phpdoc in the DependencyInjection component

symfony · Sep 7, 2012 · 05f7f78 · 05f7f78
1 parent 462f93a
commit 05f7f78
Show file tree

Hide file tree

Showing 22 changed files with 95 additions and 78 deletions.
diff --git a/src/Symfony/Component/DependencyInjection/Compiler/AnalyzeServiceReferencesPass.php b/src/Symfony/Component/DependencyInjection/Compiler/AnalyzeServiceReferencesPass.php
@@ -116,7 +116,7 @@ private function processArguments(array $arguments)
      *
      * @param string $id A full id or alias for a service definition.
      *
-     * @return Definition The definition related to the supplied id
+     * @return Definition|null The definition related to the supplied id
      */
     private function getDefinition($id)
     {

diff --git a/src/Symfony/Component/DependencyInjection/Compiler/CheckCircularReferencesPass.php b/src/Symfony/Component/DependencyInjection/Compiler/CheckCircularReferencesPass.php
@@ -51,7 +51,7 @@ public function process(ContainerBuilder $container)
      *
      * @param array $edges An array of Nodes
      *
-     * @throws \RuntimeException When a circular reference is found.
+     * @throws ServiceCircularReferenceException When a circular reference is found.
      */
     private function checkOutEdges(array $edges)
     {

diff --git a/src/Symfony/Component/DependencyInjection/Compiler/CheckReferenceValidityPass.php b/src/Symfony/Component/DependencyInjection/Compiler/CheckReferenceValidityPass.php
@@ -116,7 +116,7 @@ private function validateReferences(array $arguments)
      * @param Reference  $reference
      * @param Definition $definition
      *
-     * @throws \RuntimeException when there is an issue with the Reference scope
+     * @throws ScopeWideningInjectionException|ScopeCrossingInjectionException when there is an issue with the Reference scope
      */
     private function validateScope(Reference $reference, Definition $definition = null)
     {

diff --git a/src/Symfony/Component/DependencyInjection/Compiler/InlineServiceDefinitionsPass.php b/src/Symfony/Component/DependencyInjection/Compiler/InlineServiceDefinitionsPass.php
@@ -70,6 +70,8 @@ public function process(ContainerBuilder $container)
      *
      * @param ContainerBuilder $container The ContainerBuilder
      * @param array            $arguments An array of arguments
+     *
+     * @return array
      */
     private function inlineArguments(ContainerBuilder $container, array $arguments)
     {

diff --git a/src/Symfony/Component/DependencyInjection/Compiler/RemoveUnusedDefinitionsPass.php b/src/Symfony/Component/DependencyInjection/Compiler/RemoveUnusedDefinitionsPass.php
@@ -34,8 +34,6 @@ public function setRepeatedPass(RepeatedPass $repeatedPass)
      * Processes the ContainerBuilder to remove unused definitions.
      *
      * @param ContainerBuilder $container
-     *
-     * @return void
      */
     public function process(ContainerBuilder $container)
     {

diff --git a/src/Symfony/Component/DependencyInjection/Compiler/RepeatedPass.php b/src/Symfony/Component/DependencyInjection/Compiler/RepeatedPass.php
@@ -27,6 +27,8 @@ class RepeatedPass implements CompilerPassInterface
      * Constructor.
      *
      * @param array $passes An array of RepeatablePassInterface objects
+     *
+     * @throws \InvalidArgumentException when the passes don't implement RepeatablePassInterface
      */
     public function __construct(array $passes)
     {
@@ -48,7 +50,7 @@ public function __construct(array $passes)
      */
     public function process(ContainerBuilder $container)
     {
-        $compiler = $container->getCompiler();
+        $container->getCompiler();
         $this->repeat = false;
         foreach ($this->passes as $pass) {
             $pass->process($container);

diff --git a/src/Symfony/Component/DependencyInjection/Compiler/ReplaceAliasByActualDefinitionPass.php b/src/Symfony/Component/DependencyInjection/Compiler/ReplaceAliasByActualDefinitionPass.php
@@ -97,6 +97,8 @@ private function updateReferences($container, $currentId, $newId)
      * @param array  $arguments An array of Arguments
      * @param string $currentId The alias identifier
      * @param string $newId     The identifier the alias points to
+     *
+     * @return array
      */
     private function updateArgumentReferences(array $arguments, $currentId, $newId)
     {

diff --git a/src/Symfony/Component/DependencyInjection/Compiler/ResolveDefinitionTemplatesPass.php b/src/Symfony/Component/DependencyInjection/Compiler/ResolveDefinitionTemplatesPass.php
@@ -57,6 +57,8 @@ public function process(ContainerBuilder $container)
      * @param DefinitionDecorator $definition
      *
      * @return Definition
+     *
+     * @throws \RuntimeException When the definition is invalid
      */
     private function resolveDefinition($id, DefinitionDecorator $definition)
     {

diff --git a/src/Symfony/Component/DependencyInjection/Compiler/ResolveInvalidReferencesPass.php b/src/Symfony/Component/DependencyInjection/Compiler/ResolveInvalidReferencesPass.php
@@ -70,6 +70,10 @@ public function process(ContainerBuilder $container)
      *
      * @param array   $arguments    An array of Reference objects
      * @param Boolean $inMethodCall
+     *
+     * @return array
+     *
+     * @throws \RuntimeException When the config is invalid
      */
     private function processArguments(array $arguments, $inMethodCall = false)
     {

diff --git a/src/Symfony/Component/DependencyInjection/Compiler/ResolveParameterPlaceHoldersPass.php b/src/Symfony/Component/DependencyInjection/Compiler/ResolveParameterPlaceHoldersPass.php
@@ -27,6 +27,8 @@ class ResolveParameterPlaceHoldersPass implements CompilerPassInterface
      * Processes the ContainerBuilder to resolve parameter placeholders.
      *
      * @param ContainerBuilder $container
+     *
+     * @throws ParameterNotFoundException When an invalid parameter is referenced
      */
     public function process(ContainerBuilder $container)
     {

diff --git a/src/Symfony/Component/DependencyInjection/Compiler/ServiceReferenceGraph.php b/src/Symfony/Component/DependencyInjection/Compiler/ServiceReferenceGraph.php
@@ -35,6 +35,8 @@ public function __construct()
      * Checks if the graph has a specific node.
      *
      * @param string $id Id to check
+     *
+     * @return Boolean
      */
     public function hasNode($id)
     {

diff --git a/src/Symfony/Component/DependencyInjection/Container.php b/src/Symfony/Component/DependencyInjection/Container.php
@@ -135,7 +135,7 @@ public function getParameterBag()
      *
      * @return mixed  The parameter value
      *
-     * @throws  \InvalidArgumentException if the parameter is not defined
+     * @throws \InvalidArgumentException if the parameter is not defined
      *
      * @api
      */
@@ -178,6 +178,9 @@ public function setParameter($name, $value)
      * @param object $service The service instance
      * @param string $scope   The scope of the service
      *
+     * @throws \RuntimeException When trying to set a service in an inactive scope
+     * @throws \InvalidArgumentException When trying to set a service in the prototype scope
+     *
      * @api
      */
     public function set($id, $service, $scope = self::SCOPE_CONTAINER)
@@ -226,7 +229,8 @@ public function has($id)
      *
      * @return object The associated service
      *
-     * @throws \InvalidArgumentException if the service is not defined
+     * @throws ServiceCircularReferenceException When a circular reference is detected
+     * @throws ServiceNotFoundException When the service is not defined
      *
      * @see Reference
      *
@@ -287,7 +291,8 @@ public function getServiceIds()
      *
      * @param string $name
      *
-     * @return void
+     * @throws \RuntimeException When the parent scope is inactive
+     * @throws \InvalidArgumentException When the scope does not exist
      *
      * @api
      */
@@ -333,8 +338,6 @@ public function enterScope($name)
      *
      * @param string $name The name of the scope to leave
      *
-     * @return void
-     *
      * @throws \InvalidArgumentException if the scope is not active
      *
      * @api
@@ -374,7 +377,7 @@ public function leaveScope($name)
      *
      * @param ScopeInterface $scope
      *
-     * @return void
+     * @throws \InvalidArgumentException When the scope is invalid
      *
      * @api
      */

diff --git a/src/Symfony/Component/DependencyInjection/ContainerBuilder.php b/src/Symfony/Component/DependencyInjection/ContainerBuilder.php
@@ -58,6 +58,8 @@ public function registerExtension(ExtensionInterface $extension)
      *
      * @return ExtensionInterface An extension instance
      *
+     * @throws \LogicException if the extension is not registered
+     *
      * @api
      */
     public function getExtension($name)
@@ -150,6 +152,8 @@ public function addObjectResource($object)
      *
      * @return ContainerBuilder The current instance
      *
+     * @throws \LogicException if the container is frozen
+     *
      * @api
      */
     public function loadFromExtension($extension, array $values = array())
@@ -247,7 +251,7 @@ public function getScopeChildren()
      * @param object $service The service instance
      * @param string $scope   The scope
      *
-     * @throws BadMethodCallException
+     * @throws \BadMethodCallException if the container is frozen
      *
      * @api
      */
@@ -480,8 +484,11 @@ public function setAliases(array $aliases)
     /**
      * Sets an alias for an existing service.
      *
-     * @param string $alias The alias to create
-     * @param mixed  $id    The service to alias
+     * @param string        $alias The alias to create
+     * @param string|Alias  $id    The service to alias
+     *
+     * @throws \InvalidArgumentException if the id is not a string or an Alias
+     * @throws \InvalidArgumentException if the alias is for itself
      *
      * @api
      */
@@ -533,7 +540,7 @@ public function hasAlias($id)
     /**
      * Gets all defined aliases.
      *
-     * @return array An array of aliases
+     * @return Alias[] An array of aliases
      *
      * @api
      */
@@ -612,7 +619,7 @@ public function setDefinitions(array $definitions)
     /**
      * Gets all service definitions.
      *
-     * @return array An array of Definition instances
+     * @return Definition[] An array of Definition instances
      *
      * @api
      */
@@ -627,7 +634,9 @@ public function getDefinitions()
      * @param string     $id         The service identifier
      * @param Definition $definition A Definition instance
      *
-     * @throws BadMethodCallException
+     * @return Definition the service definition
+     *
+     * @throws \BadMethodCallException if the container is frozen
      *
      * @api
      */
@@ -708,8 +717,10 @@ public function findDefinition($id)
      * @param Definition $definition A service definition instance
      * @param string     $id         The service identifier
      *
-     * @return object              The service described by the service definition
+     * @return object The service described by the service definition
      *
+     * @throws \RuntimeException When the scope is inactive
+     * @throws \RuntimeException When the factory definition is incomplete
      * @throws \InvalidArgumentException When configure callable is not callable
      */
     private function createService(Definition $definition, $id)

diff --git a/src/Symfony/Component/DependencyInjection/ContainerInterface.php b/src/Symfony/Component/DependencyInjection/ContainerInterface.php
@@ -11,6 +11,9 @@
 
 namespace Symfony\Component\DependencyInjection;
 
+use Symfony\Component\DependencyInjection\Exception\ServiceCircularReferenceException;
+use Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException;
+
 /**
  * ContainerInterface is the interface implemented by service container classes.
  *
@@ -46,7 +49,8 @@ public function set($id, $service, $scope = self::SCOPE_CONTAINER);
      *
      * @return object The associated service
      *
-     * @throws \InvalidArgumentException if the service is not defined
+     * @throws ServiceCircularReferenceException When a circular reference is detected
+     * @throws ServiceNotFoundException When the service is not defined
      *
      * @see Reference
      *
@@ -72,7 +76,7 @@ public function has($id);
      *
      * @return mixed  The parameter value
      *
-     * @throws  \InvalidArgumentException if the parameter is not defined
+     * @throws \InvalidArgumentException if the parameter is not defined
      *
      * @api
      */
@@ -104,8 +108,6 @@ public function setParameter($name, $value);
      *
      * @param string $name
      *
-     * @return void
-     *
      * @api
      */
     public function enterScope($name);
@@ -115,8 +117,6 @@ public function enterScope($name);
      *
      * @param string $name
      *
-     * @return void
-     *
      * @api
      */
     public function leaveScope($name);
@@ -126,8 +126,6 @@ public function leaveScope($name);
      *
      * @param ScopeInterface $scope
      *
-     * @return void
-     *
      * @api
      */
     public function addScope(ScopeInterface $scope);

diff --git a/src/Symfony/Component/DependencyInjection/Definition.php b/src/Symfony/Component/DependencyInjection/Definition.php
@@ -240,6 +240,8 @@ public function addArgument($argument)
      *
      * @return Definition The current instance
      *
+     * @throws \OutOfBoundsException When the replaced argument does not exist
+     *
      * @api
      */
     public function replaceArgument($index, $argument)
@@ -272,6 +274,8 @@ public function getArguments()
      *
      * @return mixed The argument value
      *
+     * @throws \OutOfBoundsException When the argument does not exist
+     *
      * @api
      */
     public function getArgument($index)
@@ -611,7 +615,7 @@ public function isAbstract()
     /**
      * Sets a configurator to call after the service is fully initialized.
      *
-     * @param mixed $callable A PHP callable
+     * @param callable $callable A PHP callable
      *
      * @return Definition The current instance
      *
@@ -627,7 +631,7 @@ public function setConfigurator($callable)
     /**
      * Gets the configurator to call after the service is fully initialized.
      *
-     * @return mixed The PHP callable to call
+     * @return callable The PHP callable to call
      *
      * @api
      */

diff --git a/src/Symfony/Component/DependencyInjection/DefinitionDecorator.php b/src/Symfony/Component/DependencyInjection/DefinitionDecorator.php
@@ -26,7 +26,7 @@ class DefinitionDecorator extends Definition
     /**
      * Constructor.
      *
-     * @param Definition $parent The Definition instance to decorate.
+     * @param string $parent The id of Definition instance to decorate.
      *
      * @api
      */
@@ -41,7 +41,7 @@ public function __construct($parent)
     /**
      * Returns the Definition being decorated.
      *
-     * @return Definition
+     * @return string
      *
      * @api
      */
@@ -156,6 +156,8 @@ public function setPublic($boolean)
      *
      * @return mixed The argument value
      *
+     * @throws \OutOfBoundsException When the argument does not exist
+     *
      * @api
      */
     public function getArgument($index)

diff --git a/src/Symfony/Component/DependencyInjection/Dumper/PhpDumper.php b/src/Symfony/Component/DependencyInjection/Dumper/PhpDumper.php
@@ -184,6 +184,9 @@ private function addServiceInclude($id, $definition)
      * @param Definition $definition
      *
      * @return string
+     *
+     * @throws \RuntimeException When the factory definition is incomplete
+     * @throws ServiceCircularReferenceException When a circular reference is detected
      */
     private function addServiceInlinedDefinitions($id, $definition)
     {