Skip to content
Browse files

Fixed the phpdoc in the DependencyInjection component

  • Loading branch information...
1 parent 5c5040c commit 9f7eeb8226d412bc4a74a5c0540fd115e2982ff6 @stof stof committed
View
2 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)
{
View
2 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)
{
View
2 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)
{
View
2 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)
{
View
2 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)
{
View
4 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);
View
2 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)
{
View
2 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)
{
View
4 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)
{
View
2 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)
{
View
2 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)
{
View
15 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
*/
View
25 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)
View
14 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);
View
8 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
*/
View
6 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)
View
3 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)
{
View
42 Dumper/XmlDumper.php
@@ -62,9 +62,7 @@ public function dump(array $options = array())
/**
* Adds parameters.
*
- * @param DOMElement $parent
- *
- * @return void
+ * @param \DOMElement $parent
*/
private function addParameters(\DOMElement $parent)
{
@@ -85,10 +83,8 @@ private function addParameters(\DOMElement $parent)
/**
* Adds method calls.
*
- * @param array $methodcalls
- * @param DOMElement $parent
- *
- * @return void
+ * @param array $methodcalls
+ * @param \DOMElement $parent
*/
private function addMethodCalls(array $methodcalls, \DOMElement $parent)
{
@@ -105,11 +101,9 @@ private function addMethodCalls(array $methodcalls, \DOMElement $parent)
/**
* Adds a service.
*
- * @param Definition $definition
- * @param string $id
- * @param DOMElement $parent
- *
- * @return void
+ * @param Definition $definition
+ * @param string $id
+ * @param \DOMElement $parent
*/
private function addService($definition, $id, \DOMElement $parent)
{
@@ -177,11 +171,9 @@ private function addService($definition, $id, \DOMElement $parent)
/**
* Adds a service alias.
*
- * @param string $alias
- * @param string $id
- * @param DOMElement $parent
- *
- * @return void
+ * @param string $alias
+ * @param string $id
+ * @param \DOMElement $parent
*/
private function addServiceAlias($alias, $id, \DOMElement $parent)
{
@@ -197,9 +189,7 @@ private function addServiceAlias($alias, $id, \DOMElement $parent)
/**
* Adds services.
*
- * @param DOMElement $parent
- *
- * @return void
+ * @param \DOMElement $parent
*/
private function addServices(\DOMElement $parent)
{
@@ -222,12 +212,10 @@ private function addServices(\DOMElement $parent)
/**
* Converts parameters.
*
- * @param array $parameters
- * @param string $type
- * @param DOMElement $parent
- * @param string $keyAttribute
- *
- * @return void
+ * @param array $parameters
+ * @param string $type
+ * @param \DOMElement $parent
+ * @param string $keyAttribute
*/
private function convertParameters($parameters, $type, \DOMElement $parent, $keyAttribute = 'key')
{
@@ -292,6 +280,8 @@ private function escape($arguments)
*
* @param mixed $value Value to convert
*
+ * @return string
+ *
* @throws \RuntimeException When trying to dump object or resource
*/
public static function phpToXml($value)
View
6 Dumper/YamlDumper.php
@@ -12,7 +12,9 @@
namespace Symfony\Component\DependencyInjection\Dumper;
use Symfony\Component\Yaml\Yaml;
+use Symfony\Component\DependencyInjection\Alias;
use Symfony\Component\DependencyInjection\ContainerInterface;
+use Symfony\Component\DependencyInjection\Definition;
use Symfony\Component\DependencyInjection\Parameter;
use Symfony\Component\DependencyInjection\Reference;
@@ -117,7 +119,7 @@ private function addService($id, $definition)
* Adds a service alias
*
* @param string $alias
- * @param string $id
+ * @param Alias $id
*
* @return string
*/
@@ -178,6 +180,8 @@ private function addParameters()
*
* @param mixed $value
*
+ * @return mixed
+ *
* @throws \RuntimeException When trying to dump object or resource
*/
private function dumpValue($value)
View
18 Loader/XmlFileLoader.php
@@ -93,8 +93,6 @@ private function parseParameters(SimpleXMLElement $xml, $file)
*
* @param SimpleXMLElement $xml
* @param string $file
- *
- * @return void
*/
private function parseImports(SimpleXMLElement $xml, $file)
{
@@ -113,8 +111,6 @@ private function parseImports(SimpleXMLElement $xml, $file)
*
* @param SimpleXMLElement $xml
* @param string $file
- *
- * @return void
*/
private function parseDefinitions(SimpleXMLElement $xml, $file)
{
@@ -133,8 +129,6 @@ private function parseDefinitions(SimpleXMLElement $xml, $file)
* @param string $id
* @param SimpleXMLElement $service
* @param string $file
- *
- * @return void
*/
private function parseDefinition($id, $service, $file)
{
@@ -207,6 +201,8 @@ private function parseDefinition($id, $service, $file)
*
* @param string $file Path to a file
*
+ * @return SimpleXMLElement
+ *
* @throws \InvalidArgumentException When loading of XML file returns error
*/
private function parseFile($file)
@@ -299,8 +295,8 @@ private function processAnonymousServices(SimpleXMLElement $xml, $file)
/**
* Validates an XML document.
*
- * @param DOMDocument $dom
- * @param string $file
+ * @param \DOMDocument $dom
+ * @param string $file
*/
private function validate(\DOMDocument $dom, $file)
{
@@ -314,8 +310,6 @@ private function validate(\DOMDocument $dom, $file)
* @param \DOMDocument $dom
* @param string $file
*
- * @return void
- *
* @throws \RuntimeException When extension references a non-existent XSD file
* @throws \InvalidArgumentException When xml doesn't validate its xsd schema
*/
@@ -392,8 +386,6 @@ private function validateSchema(\DOMDocument $dom, $file)
* @param \DOMDocument $dom
* @param string $file
*
- * @return void
- *
* @throws \InvalidArgumentException When non valid tag are found or no extension are found
*/
private function validateExtensions(\DOMDocument $dom, $file)
@@ -420,6 +412,8 @@ private function validateExtensions(\DOMDocument $dom, $file)
/**
* Returns an array of XML errors.
*
+ * @param Boolean $internalErrors
+ *
* @return array
*/
private function getXmlErrors($internalErrors)
View
8 Loader/YamlFileLoader.php
@@ -83,8 +83,6 @@ public function supports($resource, $type = null)
*
* @param array $content
* @param string $file
- *
- * @return void
*/
private function parseImports($content, $file)
{
@@ -103,8 +101,6 @@ private function parseImports($content, $file)
*
* @param array $content
* @param string $file
- *
- * @return void
*/
private function parseDefinitions($content, $file)
{
@@ -124,7 +120,7 @@ private function parseDefinitions($content, $file)
* @param array $service
* @param string $file
*
- * @return void
+ * @throws InvalidArgumentException When tags are invalid
*/
private function parseDefinition($id, $service, $file)
{
@@ -319,8 +315,6 @@ private function resolveServices($value)
* Loads from Extensions
*
* @param array $content
- *
- * @return void
*/
private function loadFromExtensions($content)
{
View
2 ParameterBag/ParameterBag.php
@@ -84,7 +84,7 @@ public function all()
*
* @return mixed The parameter value
*
- * @throws ParameterNotFoundException if the parameter is not defined
+ * @throws ParameterNotFoundException if the parameter is not defined
*
* @api
*/

0 comments on commit 9f7eeb8

Please sign in to comment.
Something went wrong with that request. Please try again.