63c77aae53
Conflicts: composer.json src/Symfony/Bundle/FrameworkBundle/Command/RouterApacheDumperCommand.php src/Symfony/Bundle/FrameworkBundle/Command/RouterDebugCommand.php src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/TextDescriptor.php src/Symfony/Bundle/SecurityBundle/Resources/config/security.xml src/Symfony/Bundle/SecurityBundle/Resources/config/security_listeners.xml src/Symfony/Bundle/TwigBundle/Controller/ExceptionController.php src/Symfony/Component/ClassLoader/ApcUniversalClassLoader.php src/Symfony/Component/ClassLoader/DebugClassLoader.php src/Symfony/Component/ClassLoader/UniversalClassLoader.php src/Symfony/Component/Console/Input/StringInput.php src/Symfony/Component/Debug/DebugClassLoader.php src/Symfony/Component/DependencyInjection/Container.php src/Symfony/Component/DependencyInjection/ContainerBuilder.php src/Symfony/Component/DependencyInjection/ContainerInterface.php src/Symfony/Component/DependencyInjection/Definition.php src/Symfony/Component/DependencyInjection/DefinitionDecorator.php src/Symfony/Component/DependencyInjection/Scope.php src/Symfony/Component/DependencyInjection/ScopeInterface.php src/Symfony/Component/DomCrawler/composer.json src/Symfony/Component/EventDispatcher/Event.php src/Symfony/Component/HttpKernel/Kernel.php src/Symfony/Component/HttpKernel/KernelInterface.php src/Symfony/Component/HttpKernel/Log/LoggerInterface.php src/Symfony/Component/HttpKernel/Log/NullLogger.php src/Symfony/Component/Security/Core/composer.json src/Symfony/Component/Security/Resources/translations/security.tr.xlf src/Symfony/Component/Security/composer.json src/Symfony/Component/Translation/Translator.php
638 lines
15 KiB
PHP
638 lines
15 KiB
PHP
<?php
|
|
|
|
/*
|
|
* This file is part of the Symfony package.
|
|
*
|
|
* (c) Fabien Potencier <fabien@symfony.com>
|
|
*
|
|
* For the full copyright and license information, please view the LICENSE
|
|
* file that was distributed with this source code.
|
|
*/
|
|
|
|
namespace Symfony\Component\DependencyInjection;
|
|
|
|
use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
|
|
use Symfony\Component\DependencyInjection\Exception\OutOfBoundsException;
|
|
|
|
/**
|
|
* Definition represents a service definition.
|
|
*
|
|
* @author Fabien Potencier <fabien@symfony.com>
|
|
*/
|
|
class Definition
|
|
{
|
|
private $class;
|
|
private $file;
|
|
private $factory;
|
|
private $shared = true;
|
|
private $deprecated = false;
|
|
private $deprecationTemplate = 'The "%service_id%" service is deprecated. You should stop using it, as it will soon be removed.';
|
|
private $properties = array();
|
|
private $calls = array();
|
|
private $configurator;
|
|
private $tags = array();
|
|
private $public = true;
|
|
private $synthetic = false;
|
|
private $abstract = false;
|
|
private $lazy = false;
|
|
private $decoratedService;
|
|
|
|
protected $arguments;
|
|
|
|
/**
|
|
* Constructor.
|
|
*
|
|
* @param string|null $class The service class
|
|
* @param array $arguments An array of arguments to pass to the service constructor
|
|
*/
|
|
public function __construct($class = null, array $arguments = array())
|
|
{
|
|
$this->class = $class;
|
|
$this->arguments = $arguments;
|
|
}
|
|
|
|
/**
|
|
* Sets a factory.
|
|
*
|
|
* @param string|array $factory A PHP function or an array containing a class/Reference and a method to call
|
|
*
|
|
* @return Definition The current instance
|
|
*/
|
|
public function setFactory($factory)
|
|
{
|
|
if (is_string($factory) && strpos($factory, '::') !== false) {
|
|
$factory = explode('::', $factory, 2);
|
|
}
|
|
|
|
$this->factory = $factory;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets the factory.
|
|
*
|
|
* @return string|array The PHP function or an array containing a class/Reference and a method to call
|
|
*/
|
|
public function getFactory()
|
|
{
|
|
return $this->factory;
|
|
}
|
|
|
|
/**
|
|
* Sets the service that this service is decorating.
|
|
*
|
|
* @param null|string $id The decorated service id, use null to remove decoration
|
|
* @param null|string $renamedId The new decorated service id
|
|
* @param int $priority The priority of decoration
|
|
*
|
|
* @return Definition The current instance
|
|
*
|
|
* @throws InvalidArgumentException In case the decorated service id and the new decorated service id are equals.
|
|
*/
|
|
public function setDecoratedService($id, $renamedId = null, $priority = 0)
|
|
{
|
|
if ($renamedId && $id == $renamedId) {
|
|
throw new \InvalidArgumentException(sprintf('The decorated service inner name for "%s" must be different than the service name itself.', $id));
|
|
}
|
|
|
|
if (null === $id) {
|
|
$this->decoratedService = null;
|
|
} else {
|
|
$this->decoratedService = array($id, $renamedId, (int) $priority);
|
|
}
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets the service that decorates this service.
|
|
*
|
|
* @return null|array An array composed of the decorated service id, the new id for it and the priority of decoration, null if no service is decorated
|
|
*/
|
|
public function getDecoratedService()
|
|
{
|
|
return $this->decoratedService;
|
|
}
|
|
|
|
/**
|
|
* Sets the service class.
|
|
*
|
|
* @param string $class The service class
|
|
*
|
|
* @return Definition The current instance
|
|
*/
|
|
public function setClass($class)
|
|
{
|
|
$this->class = $class;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets the service class.
|
|
*
|
|
* @return string|null The service class
|
|
*/
|
|
public function getClass()
|
|
{
|
|
return $this->class;
|
|
}
|
|
|
|
/**
|
|
* Sets the arguments to pass to the service constructor/factory method.
|
|
*
|
|
* @param array $arguments An array of arguments
|
|
*
|
|
* @return Definition The current instance
|
|
*/
|
|
public function setArguments(array $arguments)
|
|
{
|
|
$this->arguments = $arguments;
|
|
|
|
return $this;
|
|
}
|
|
|
|
public function setProperties(array $properties)
|
|
{
|
|
$this->properties = $properties;
|
|
|
|
return $this;
|
|
}
|
|
|
|
public function getProperties()
|
|
{
|
|
return $this->properties;
|
|
}
|
|
|
|
public function setProperty($name, $value)
|
|
{
|
|
$this->properties[$name] = $value;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Adds an argument to pass to the service constructor/factory method.
|
|
*
|
|
* @param mixed $argument An argument
|
|
*
|
|
* @return Definition The current instance
|
|
*/
|
|
public function addArgument($argument)
|
|
{
|
|
$this->arguments[] = $argument;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Sets a specific argument.
|
|
*
|
|
* @param int $index
|
|
* @param mixed $argument
|
|
*
|
|
* @return Definition The current instance
|
|
*
|
|
* @throws OutOfBoundsException When the replaced argument does not exist
|
|
*/
|
|
public function replaceArgument($index, $argument)
|
|
{
|
|
if ($index < 0 || $index > count($this->arguments) - 1) {
|
|
throw new OutOfBoundsException(sprintf('The index "%d" is not in the range [0, %d].', $index, count($this->arguments) - 1));
|
|
}
|
|
|
|
$this->arguments[$index] = $argument;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets the arguments to pass to the service constructor/factory method.
|
|
*
|
|
* @return array The array of arguments
|
|
*/
|
|
public function getArguments()
|
|
{
|
|
return $this->arguments;
|
|
}
|
|
|
|
/**
|
|
* Gets an argument to pass to the service constructor/factory method.
|
|
*
|
|
* @param int $index
|
|
*
|
|
* @return mixed The argument value
|
|
*
|
|
* @throws OutOfBoundsException When the argument does not exist
|
|
*/
|
|
public function getArgument($index)
|
|
{
|
|
if ($index < 0 || $index > count($this->arguments) - 1) {
|
|
throw new OutOfBoundsException(sprintf('The index "%d" is not in the range [0, %d].', $index, count($this->arguments) - 1));
|
|
}
|
|
|
|
return $this->arguments[$index];
|
|
}
|
|
|
|
/**
|
|
* Sets the methods to call after service initialization.
|
|
*
|
|
* @param array $calls An array of method calls
|
|
*
|
|
* @return Definition The current instance
|
|
*/
|
|
public function setMethodCalls(array $calls = array())
|
|
{
|
|
$this->calls = array();
|
|
foreach ($calls as $call) {
|
|
$this->addMethodCall($call[0], $call[1]);
|
|
}
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Adds a method to call after service initialization.
|
|
*
|
|
* @param string $method The method name to call
|
|
* @param array $arguments An array of arguments to pass to the method call
|
|
*
|
|
* @return Definition The current instance
|
|
*
|
|
* @throws InvalidArgumentException on empty $method param
|
|
*/
|
|
public function addMethodCall($method, array $arguments = array())
|
|
{
|
|
if (empty($method)) {
|
|
throw new InvalidArgumentException(sprintf('Method name cannot be empty.'));
|
|
}
|
|
$this->calls[] = array($method, $arguments);
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Removes a method to call after service initialization.
|
|
*
|
|
* @param string $method The method name to remove
|
|
*
|
|
* @return Definition The current instance
|
|
*/
|
|
public function removeMethodCall($method)
|
|
{
|
|
foreach ($this->calls as $i => $call) {
|
|
if ($call[0] === $method) {
|
|
unset($this->calls[$i]);
|
|
break;
|
|
}
|
|
}
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Check if the current definition has a given method to call after service initialization.
|
|
*
|
|
* @param string $method The method name to search for
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function hasMethodCall($method)
|
|
{
|
|
foreach ($this->calls as $call) {
|
|
if ($call[0] === $method) {
|
|
return true;
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Gets the methods to call after service initialization.
|
|
*
|
|
* @return array An array of method calls
|
|
*/
|
|
public function getMethodCalls()
|
|
{
|
|
return $this->calls;
|
|
}
|
|
|
|
/**
|
|
* Sets tags for this definition.
|
|
*
|
|
* @param array $tags
|
|
*
|
|
* @return Definition the current instance
|
|
*/
|
|
public function setTags(array $tags)
|
|
{
|
|
$this->tags = $tags;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Returns all tags.
|
|
*
|
|
* @return array An array of tags
|
|
*/
|
|
public function getTags()
|
|
{
|
|
return $this->tags;
|
|
}
|
|
|
|
/**
|
|
* Gets a tag by name.
|
|
*
|
|
* @param string $name The tag name
|
|
*
|
|
* @return array An array of attributes
|
|
*/
|
|
public function getTag($name)
|
|
{
|
|
return isset($this->tags[$name]) ? $this->tags[$name] : array();
|
|
}
|
|
|
|
/**
|
|
* Adds a tag for this definition.
|
|
*
|
|
* @param string $name The tag name
|
|
* @param array $attributes An array of attributes
|
|
*
|
|
* @return Definition The current instance
|
|
*/
|
|
public function addTag($name, array $attributes = array())
|
|
{
|
|
$this->tags[$name][] = $attributes;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Whether this definition has a tag with the given name.
|
|
*
|
|
* @param string $name
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function hasTag($name)
|
|
{
|
|
return isset($this->tags[$name]);
|
|
}
|
|
|
|
/**
|
|
* Clears all tags for a given name.
|
|
*
|
|
* @param string $name The tag name
|
|
*
|
|
* @return Definition
|
|
*/
|
|
public function clearTag($name)
|
|
{
|
|
if (isset($this->tags[$name])) {
|
|
unset($this->tags[$name]);
|
|
}
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Clears the tags for this definition.
|
|
*
|
|
* @return Definition The current instance
|
|
*/
|
|
public function clearTags()
|
|
{
|
|
$this->tags = array();
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Sets a file to require before creating the service.
|
|
*
|
|
* @param string $file A full pathname to include
|
|
*
|
|
* @return Definition The current instance
|
|
*/
|
|
public function setFile($file)
|
|
{
|
|
$this->file = $file;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets the file to require before creating the service.
|
|
*
|
|
* @return string|null The full pathname to include
|
|
*/
|
|
public function getFile()
|
|
{
|
|
return $this->file;
|
|
}
|
|
|
|
/**
|
|
* Sets if the service must be shared or not.
|
|
*
|
|
* @param bool $shared Whether the service must be shared or not
|
|
*
|
|
* @return Definition The current instance
|
|
*/
|
|
public function setShared($shared)
|
|
{
|
|
$this->shared = (bool) $shared;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Whether this service is shared.
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function isShared()
|
|
{
|
|
return $this->shared;
|
|
}
|
|
|
|
/**
|
|
* Sets the visibility of this service.
|
|
*
|
|
* @param bool $boolean
|
|
*
|
|
* @return Definition The current instance
|
|
*/
|
|
public function setPublic($boolean)
|
|
{
|
|
$this->public = (bool) $boolean;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Whether this service is public facing.
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function isPublic()
|
|
{
|
|
return $this->public;
|
|
}
|
|
|
|
/**
|
|
* Sets the lazy flag of this service.
|
|
*
|
|
* @param bool $lazy
|
|
*
|
|
* @return Definition The current instance
|
|
*/
|
|
public function setLazy($lazy)
|
|
{
|
|
$this->lazy = (bool) $lazy;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Whether this service is lazy.
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function isLazy()
|
|
{
|
|
return $this->lazy;
|
|
}
|
|
|
|
/**
|
|
* Sets whether this definition is synthetic, that is not constructed by the
|
|
* container, but dynamically injected.
|
|
*
|
|
* @param bool $boolean
|
|
*
|
|
* @return Definition the current instance
|
|
*/
|
|
public function setSynthetic($boolean)
|
|
{
|
|
$this->synthetic = (bool) $boolean;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Whether this definition is synthetic, that is not constructed by the
|
|
* container, but dynamically injected.
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function isSynthetic()
|
|
{
|
|
return $this->synthetic;
|
|
}
|
|
|
|
/**
|
|
* Whether this definition is abstract, that means it merely serves as a
|
|
* template for other definitions.
|
|
*
|
|
* @param bool $boolean
|
|
*
|
|
* @return Definition the current instance
|
|
*/
|
|
public function setAbstract($boolean)
|
|
{
|
|
$this->abstract = (bool) $boolean;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Whether this definition is abstract, that means it merely serves as a
|
|
* template for other definitions.
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function isAbstract()
|
|
{
|
|
return $this->abstract;
|
|
}
|
|
|
|
/**
|
|
* Whether this definition is deprecated, that means it should not be called
|
|
* anymore.
|
|
*
|
|
* @param bool $status
|
|
* @param string $template Template message to use if the definition is deprecated
|
|
*
|
|
* @return Definition the current instance
|
|
*
|
|
* @throws InvalidArgumentException When the message template is invalid.
|
|
*/
|
|
public function setDeprecated($status = true, $template = null)
|
|
{
|
|
if (null !== $template) {
|
|
if (preg_match('#[\r\n]|\*/#', $template)) {
|
|
throw new InvalidArgumentException('Invalid characters found in deprecation template.');
|
|
}
|
|
|
|
if (false === strpos($template, '%service_id%')) {
|
|
throw new InvalidArgumentException('The deprecation template must contain the "%service_id%" placeholder.');
|
|
}
|
|
|
|
$this->deprecationTemplate = $template;
|
|
}
|
|
|
|
$this->deprecated = (bool) $status;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Whether this definition is deprecated, that means it should not be called
|
|
* anymore.
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function isDeprecated()
|
|
{
|
|
return $this->deprecated;
|
|
}
|
|
|
|
/**
|
|
* Message to use if this definition is deprecated.
|
|
*
|
|
* @param string $id Service id relying on this definition
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getDeprecationMessage($id)
|
|
{
|
|
return str_replace('%service_id%', $id, $this->deprecationTemplate);
|
|
}
|
|
|
|
/**
|
|
* Sets a configurator to call after the service is fully initialized.
|
|
*
|
|
* @param callable $callable A PHP callable
|
|
*
|
|
* @return Definition The current instance
|
|
*/
|
|
public function setConfigurator($callable)
|
|
{
|
|
$this->configurator = $callable;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets the configurator to call after the service is fully initialized.
|
|
*
|
|
* @return callable|null The PHP callable to call
|
|
*/
|
|
public function getConfigurator()
|
|
{
|
|
return $this->configurator;
|
|
}
|
|
}
|