923 lines
22 KiB
PHP
923 lines
22 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\Argument\BoundArgument;
|
||
|
|
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 const DEFAULT_DEPRECATION_TEMPLATE = 'The "%service_id%" service is deprecated. You should stop using it, as it will be removed in the future.';
|
||
|
|
|
||
|
|
private $class;
|
||
|
|
private $file;
|
||
|
|
private $factory;
|
||
|
|
private $shared = true;
|
||
|
|
private $deprecation = [];
|
||
|
|
private $properties = [];
|
||
|
|
private $calls = [];
|
||
|
|
private $instanceof = [];
|
||
|
|
private $autoconfigured = false;
|
||
|
|
private $configurator;
|
||
|
|
private $tags = [];
|
||
|
|
private $public = false;
|
||
|
|
private $synthetic = false;
|
||
|
|
private $abstract = false;
|
||
|
|
private $lazy = false;
|
||
|
|
private $decoratedService;
|
||
|
|
private $autowired = false;
|
||
|
|
private $changes = [];
|
||
|
|
private $bindings = [];
|
||
|
|
private $errors = [];
|
||
|
|
|
||
|
|
protected $arguments = [];
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @internal
|
||
|
|
*
|
||
|
|
* Used to store the name of the inner id when using service decoration together with autowiring
|
||
|
|
*/
|
||
|
|
public $innerServiceId;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @internal
|
||
|
|
*
|
||
|
|
* Used to store the behavior to follow when using service decoration and the decorated service is invalid
|
||
|
|
*/
|
||
|
|
public $decorationOnInvalid;
|
||
|
|
|
||
|
|
public function __construct(string $class = null, array $arguments = [])
|
||
|
|
{
|
||
|
|
if (null !== $class) {
|
||
|
|
$this->setClass($class);
|
||
|
|
}
|
||
|
|
$this->arguments = $arguments;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns all changes tracked for the Definition object.
|
||
|
|
*
|
||
|
|
* @return array An array of changes for this Definition
|
||
|
|
*/
|
||
|
|
public function getChanges()
|
||
|
|
{
|
||
|
|
return $this->changes;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Sets the tracked changes for the Definition object.
|
||
|
|
*
|
||
|
|
* @param array $changes An array of changes for this Definition
|
||
|
|
*
|
||
|
|
* @return $this
|
||
|
|
*/
|
||
|
|
public function setChanges(array $changes)
|
||
|
|
{
|
||
|
|
$this->changes = $changes;
|
||
|
|
|
||
|
|
return $this;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Sets a factory.
|
||
|
|
*
|
||
|
|
* @param string|array|Reference|null $factory A PHP function, reference or an array containing a class/Reference and a method to call
|
||
|
|
*
|
||
|
|
* @return $this
|
||
|
|
*/
|
||
|
|
public function setFactory($factory)
|
||
|
|
{
|
||
|
|
$this->changes['factory'] = true;
|
||
|
|
|
||
|
|
if (\is_string($factory) && str_contains($factory, '::')) {
|
||
|
|
$factory = explode('::', $factory, 2);
|
||
|
|
} elseif ($factory instanceof Reference) {
|
||
|
|
$factory = [$factory, '__invoke'];
|
||
|
|
}
|
||
|
|
|
||
|
|
$this->factory = $factory;
|
||
|
|
|
||
|
|
return $this;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Gets the factory.
|
||
|
|
*
|
||
|
|
* @return string|array|null 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 string|null $id The decorated service id, use null to remove decoration
|
||
|
|
* @param string|null $renamedId The new decorated service id
|
||
|
|
*
|
||
|
|
* @return $this
|
||
|
|
*
|
||
|
|
* @throws InvalidArgumentException in case the decorated service id and the new decorated service id are equals
|
||
|
|
*/
|
||
|
|
public function setDecoratedService(?string $id, string $renamedId = null, int $priority = 0, int $invalidBehavior = ContainerInterface::EXCEPTION_ON_INVALID_REFERENCE)
|
||
|
|
{
|
||
|
|
if ($renamedId && $id === $renamedId) {
|
||
|
|
throw new InvalidArgumentException(sprintf('The decorated service inner name for "%s" must be different than the service name itself.', $id));
|
||
|
|
}
|
||
|
|
|
||
|
|
$this->changes['decorated_service'] = true;
|
||
|
|
|
||
|
|
if (null === $id) {
|
||
|
|
$this->decoratedService = null;
|
||
|
|
} else {
|
||
|
|
$this->decoratedService = [$id, $renamedId, $priority];
|
||
|
|
|
||
|
|
if (ContainerInterface::EXCEPTION_ON_INVALID_REFERENCE !== $invalidBehavior) {
|
||
|
|
$this->decoratedService[] = $invalidBehavior;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
return $this;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Gets the service that this service is decorating.
|
||
|
|
*
|
||
|
|
* @return array|null 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.
|
||
|
|
*
|
||
|
|
* @return $this
|
||
|
|
*/
|
||
|
|
public function setClass(?string $class)
|
||
|
|
{
|
||
|
|
$this->changes['class'] = true;
|
||
|
|
|
||
|
|
$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.
|
||
|
|
*
|
||
|
|
* @return $this
|
||
|
|
*/
|
||
|
|
public function setArguments(array $arguments)
|
||
|
|
{
|
||
|
|
$this->arguments = $arguments;
|
||
|
|
|
||
|
|
return $this;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Sets the properties to define when creating the service.
|
||
|
|
*
|
||
|
|
* @return $this
|
||
|
|
*/
|
||
|
|
public function setProperties(array $properties)
|
||
|
|
{
|
||
|
|
$this->properties = $properties;
|
||
|
|
|
||
|
|
return $this;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Gets the properties to define when creating the service.
|
||
|
|
*
|
||
|
|
* @return array
|
||
|
|
*/
|
||
|
|
public function getProperties()
|
||
|
|
{
|
||
|
|
return $this->properties;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Sets a specific property.
|
||
|
|
*
|
||
|
|
* @param mixed $value
|
||
|
|
*
|
||
|
|
* @return $this
|
||
|
|
*/
|
||
|
|
public function setProperty(string $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 $this
|
||
|
|
*/
|
||
|
|
public function addArgument($argument)
|
||
|
|
{
|
||
|
|
$this->arguments[] = $argument;
|
||
|
|
|
||
|
|
return $this;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Replaces a specific argument.
|
||
|
|
*
|
||
|
|
* @param int|string $index
|
||
|
|
* @param mixed $argument
|
||
|
|
*
|
||
|
|
* @return $this
|
||
|
|
*
|
||
|
|
* @throws OutOfBoundsException When the replaced argument does not exist
|
||
|
|
*/
|
||
|
|
public function replaceArgument($index, $argument)
|
||
|
|
{
|
||
|
|
if (0 === \count($this->arguments)) {
|
||
|
|
throw new OutOfBoundsException('Cannot replace arguments if none have been configured yet.');
|
||
|
|
}
|
||
|
|
|
||
|
|
if (\is_int($index) && ($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));
|
||
|
|
}
|
||
|
|
|
||
|
|
if (!\array_key_exists($index, $this->arguments)) {
|
||
|
|
throw new OutOfBoundsException(sprintf('The argument "%s" doesn\'t exist.', $index));
|
||
|
|
}
|
||
|
|
|
||
|
|
$this->arguments[$index] = $argument;
|
||
|
|
|
||
|
|
return $this;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Sets a specific argument.
|
||
|
|
*
|
||
|
|
* @param int|string $key
|
||
|
|
* @param mixed $value
|
||
|
|
*
|
||
|
|
* @return $this
|
||
|
|
*/
|
||
|
|
public function setArgument($key, $value)
|
||
|
|
{
|
||
|
|
$this->arguments[$key] = $value;
|
||
|
|
|
||
|
|
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|string $index
|
||
|
|
*
|
||
|
|
* @return mixed The argument value
|
||
|
|
*
|
||
|
|
* @throws OutOfBoundsException When the argument does not exist
|
||
|
|
*/
|
||
|
|
public function getArgument($index)
|
||
|
|
{
|
||
|
|
if (!\array_key_exists($index, $this->arguments)) {
|
||
|
|
throw new OutOfBoundsException(sprintf('The argument "%s" doesn\'t exist.', $index));
|
||
|
|
}
|
||
|
|
|
||
|
|
return $this->arguments[$index];
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Sets the methods to call after service initialization.
|
||
|
|
*
|
||
|
|
* @return $this
|
||
|
|
*/
|
||
|
|
public function setMethodCalls(array $calls = [])
|
||
|
|
{
|
||
|
|
$this->calls = [];
|
||
|
|
foreach ($calls as $call) {
|
||
|
|
$this->addMethodCall($call[0], $call[1], $call[2] ?? false);
|
||
|
|
}
|
||
|
|
|
||
|
|
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
|
||
|
|
* @param bool $returnsClone Whether the call returns the service instance or not
|
||
|
|
*
|
||
|
|
* @return $this
|
||
|
|
*
|
||
|
|
* @throws InvalidArgumentException on empty $method param
|
||
|
|
*/
|
||
|
|
public function addMethodCall(string $method, array $arguments = [], bool $returnsClone = false)
|
||
|
|
{
|
||
|
|
if (empty($method)) {
|
||
|
|
throw new InvalidArgumentException('Method name cannot be empty.');
|
||
|
|
}
|
||
|
|
$this->calls[] = $returnsClone ? [$method, $arguments, true] : [$method, $arguments];
|
||
|
|
|
||
|
|
return $this;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Removes a method to call after service initialization.
|
||
|
|
*
|
||
|
|
* @return $this
|
||
|
|
*/
|
||
|
|
public function removeMethodCall(string $method)
|
||
|
|
{
|
||
|
|
foreach ($this->calls as $i => $call) {
|
||
|
|
if ($call[0] === $method) {
|
||
|
|
unset($this->calls[$i]);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
return $this;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Check if the current definition has a given method to call after service initialization.
|
||
|
|
*
|
||
|
|
* @return bool
|
||
|
|
*/
|
||
|
|
public function hasMethodCall(string $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 the definition templates to conditionally apply on the current definition, keyed by parent interface/class.
|
||
|
|
*
|
||
|
|
* @param ChildDefinition[] $instanceof
|
||
|
|
*
|
||
|
|
* @return $this
|
||
|
|
*/
|
||
|
|
public function setInstanceofConditionals(array $instanceof)
|
||
|
|
{
|
||
|
|
$this->instanceof = $instanceof;
|
||
|
|
|
||
|
|
return $this;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Gets the definition templates to conditionally apply on the current definition, keyed by parent interface/class.
|
||
|
|
*
|
||
|
|
* @return ChildDefinition[]
|
||
|
|
*/
|
||
|
|
public function getInstanceofConditionals()
|
||
|
|
{
|
||
|
|
return $this->instanceof;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Sets whether or not instanceof conditionals should be prepended with a global set.
|
||
|
|
*
|
||
|
|
* @return $this
|
||
|
|
*/
|
||
|
|
public function setAutoconfigured(bool $autoconfigured)
|
||
|
|
{
|
||
|
|
$this->changes['autoconfigured'] = true;
|
||
|
|
|
||
|
|
$this->autoconfigured = $autoconfigured;
|
||
|
|
|
||
|
|
return $this;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @return bool
|
||
|
|
*/
|
||
|
|
public function isAutoconfigured()
|
||
|
|
{
|
||
|
|
return $this->autoconfigured;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Sets tags for this definition.
|
||
|
|
*
|
||
|
|
* @return $this
|
||
|
|
*/
|
||
|
|
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.
|
||
|
|
*
|
||
|
|
* @return array An array of attributes
|
||
|
|
*/
|
||
|
|
public function getTag(string $name)
|
||
|
|
{
|
||
|
|
return $this->tags[$name] ?? [];
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Adds a tag for this definition.
|
||
|
|
*
|
||
|
|
* @return $this
|
||
|
|
*/
|
||
|
|
public function addTag(string $name, array $attributes = [])
|
||
|
|
{
|
||
|
|
$this->tags[$name][] = $attributes;
|
||
|
|
|
||
|
|
return $this;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Whether this definition has a tag with the given name.
|
||
|
|
*
|
||
|
|
* @return bool
|
||
|
|
*/
|
||
|
|
public function hasTag(string $name)
|
||
|
|
{
|
||
|
|
return isset($this->tags[$name]);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Clears all tags for a given name.
|
||
|
|
*
|
||
|
|
* @return $this
|
||
|
|
*/
|
||
|
|
public function clearTag(string $name)
|
||
|
|
{
|
||
|
|
unset($this->tags[$name]);
|
||
|
|
|
||
|
|
return $this;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Clears the tags for this definition.
|
||
|
|
*
|
||
|
|
* @return $this
|
||
|
|
*/
|
||
|
|
public function clearTags()
|
||
|
|
{
|
||
|
|
$this->tags = [];
|
||
|
|
|
||
|
|
return $this;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Sets a file to require before creating the service.
|
||
|
|
*
|
||
|
|
* @return $this
|
||
|
|
*/
|
||
|
|
public function setFile(?string $file)
|
||
|
|
{
|
||
|
|
$this->changes['file'] = true;
|
||
|
|
|
||
|
|
$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.
|
||
|
|
*
|
||
|
|
* @return $this
|
||
|
|
*/
|
||
|
|
public function setShared(bool $shared)
|
||
|
|
{
|
||
|
|
$this->changes['shared'] = true;
|
||
|
|
|
||
|
|
$this->shared = $shared;
|
||
|
|
|
||
|
|
return $this;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Whether this service is shared.
|
||
|
|
*
|
||
|
|
* @return bool
|
||
|
|
*/
|
||
|
|
public function isShared()
|
||
|
|
{
|
||
|
|
return $this->shared;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Sets the visibility of this service.
|
||
|
|
*
|
||
|
|
* @return $this
|
||
|
|
*/
|
||
|
|
public function setPublic(bool $boolean)
|
||
|
|
{
|
||
|
|
$this->changes['public'] = true;
|
||
|
|
|
||
|
|
$this->public = $boolean;
|
||
|
|
|
||
|
|
return $this;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Whether this service is public facing.
|
||
|
|
*
|
||
|
|
* @return bool
|
||
|
|
*/
|
||
|
|
public function isPublic()
|
||
|
|
{
|
||
|
|
return $this->public;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Sets if this service is private.
|
||
|
|
*
|
||
|
|
* @return $this
|
||
|
|
*
|
||
|
|
* @deprecated since Symfony 5.2, use setPublic() instead
|
||
|
|
*/
|
||
|
|
public function setPrivate(bool $boolean)
|
||
|
|
{
|
||
|
|
trigger_deprecation('symfony/dependency-injection', '5.2', 'The "%s()" method is deprecated, use "setPublic()" instead.', __METHOD__);
|
||
|
|
|
||
|
|
return $this->setPublic(!$boolean);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Whether this service is private.
|
||
|
|
*
|
||
|
|
* @return bool
|
||
|
|
*/
|
||
|
|
public function isPrivate()
|
||
|
|
{
|
||
|
|
return !$this->public;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Sets the lazy flag of this service.
|
||
|
|
*
|
||
|
|
* @return $this
|
||
|
|
*/
|
||
|
|
public function setLazy(bool $lazy)
|
||
|
|
{
|
||
|
|
$this->changes['lazy'] = true;
|
||
|
|
|
||
|
|
$this->lazy = $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.
|
||
|
|
*
|
||
|
|
* @return $this
|
||
|
|
*/
|
||
|
|
public function setSynthetic(bool $boolean)
|
||
|
|
{
|
||
|
|
$this->synthetic = $boolean;
|
||
|
|
|
||
|
|
if (!isset($this->changes['public'])) {
|
||
|
|
$this->setPublic(true);
|
||
|
|
}
|
||
|
|
|
||
|
|
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.
|
||
|
|
*
|
||
|
|
* @return $this
|
||
|
|
*/
|
||
|
|
public function setAbstract(bool $boolean)
|
||
|
|
{
|
||
|
|
$this->abstract = $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 string $package The name of the composer package that is triggering the deprecation
|
||
|
|
* @param string $version The version of the package that introduced the deprecation
|
||
|
|
* @param string $message The deprecation message to use
|
||
|
|
*
|
||
|
|
* @return $this
|
||
|
|
*
|
||
|
|
* @throws InvalidArgumentException when the message template is invalid
|
||
|
|
*/
|
||
|
|
public function setDeprecated(/* string $package, string $version, string $message */)
|
||
|
|
{
|
||
|
|
$args = \func_get_args();
|
||
|
|
|
||
|
|
if (\func_num_args() < 3) {
|
||
|
|
trigger_deprecation('symfony/dependency-injection', '5.1', 'The signature of method "%s()" requires 3 arguments: "string $package, string $version, string $message", not defining them is deprecated.', __METHOD__);
|
||
|
|
|
||
|
|
$status = $args[0] ?? true;
|
||
|
|
|
||
|
|
if (!$status) {
|
||
|
|
trigger_deprecation('symfony/dependency-injection', '5.1', 'Passing a null message to un-deprecate a node is deprecated.');
|
||
|
|
}
|
||
|
|
|
||
|
|
$message = (string) ($args[1] ?? null);
|
||
|
|
$package = $version = '';
|
||
|
|
} else {
|
||
|
|
$status = true;
|
||
|
|
$package = (string) $args[0];
|
||
|
|
$version = (string) $args[1];
|
||
|
|
$message = (string) $args[2];
|
||
|
|
}
|
||
|
|
|
||
|
|
if ('' !== $message) {
|
||
|
|
if (preg_match('#[\r\n]|\*/#', $message)) {
|
||
|
|
throw new InvalidArgumentException('Invalid characters found in deprecation template.');
|
||
|
|
}
|
||
|
|
|
||
|
|
if (!str_contains($message, '%service_id%')) {
|
||
|
|
throw new InvalidArgumentException('The deprecation template must contain the "%service_id%" placeholder.');
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
$this->changes['deprecated'] = true;
|
||
|
|
$this->deprecation = $status ? ['package' => $package, 'version' => $version, 'message' => $message ?: self::DEFAULT_DEPRECATION_TEMPLATE] : [];
|
||
|
|
|
||
|
|
return $this;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Whether this definition is deprecated, that means it should not be called
|
||
|
|
* anymore.
|
||
|
|
*
|
||
|
|
* @return bool
|
||
|
|
*/
|
||
|
|
public function isDeprecated()
|
||
|
|
{
|
||
|
|
return (bool) $this->deprecation;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Message to use if this definition is deprecated.
|
||
|
|
*
|
||
|
|
* @deprecated since Symfony 5.1, use "getDeprecation()" instead.
|
||
|
|
*
|
||
|
|
* @param string $id Service id relying on this definition
|
||
|
|
*
|
||
|
|
* @return string
|
||
|
|
*/
|
||
|
|
public function getDeprecationMessage(string $id)
|
||
|
|
{
|
||
|
|
trigger_deprecation('symfony/dependency-injection', '5.1', 'The "%s()" method is deprecated, use "getDeprecation()" instead.', __METHOD__);
|
||
|
|
|
||
|
|
return $this->getDeprecation($id)['message'];
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param string $id Service id relying on this definition
|
||
|
|
*/
|
||
|
|
public function getDeprecation(string $id): array
|
||
|
|
{
|
||
|
|
return [
|
||
|
|
'package' => $this->deprecation['package'],
|
||
|
|
'version' => $this->deprecation['version'],
|
||
|
|
'message' => str_replace('%service_id%', $id, $this->deprecation['message']),
|
||
|
|
];
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Sets a configurator to call after the service is fully initialized.
|
||
|
|
*
|
||
|
|
* @param string|array|Reference|null $configurator A PHP function, reference or an array containing a class/Reference and a method to call
|
||
|
|
*
|
||
|
|
* @return $this
|
||
|
|
*/
|
||
|
|
public function setConfigurator($configurator)
|
||
|
|
{
|
||
|
|
$this->changes['configurator'] = true;
|
||
|
|
|
||
|
|
if (\is_string($configurator) && str_contains($configurator, '::')) {
|
||
|
|
$configurator = explode('::', $configurator, 2);
|
||
|
|
} elseif ($configurator instanceof Reference) {
|
||
|
|
$configurator = [$configurator, '__invoke'];
|
||
|
|
}
|
||
|
|
|
||
|
|
$this->configurator = $configurator;
|
||
|
|
|
||
|
|
return $this;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Gets the configurator to call after the service is fully initialized.
|
||
|
|
*
|
||
|
|
* @return callable|array|null
|
||
|
|
*/
|
||
|
|
public function getConfigurator()
|
||
|
|
{
|
||
|
|
return $this->configurator;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Is the definition autowired?
|
||
|
|
*
|
||
|
|
* @return bool
|
||
|
|
*/
|
||
|
|
public function isAutowired()
|
||
|
|
{
|
||
|
|
return $this->autowired;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Enables/disables autowiring.
|
||
|
|
*
|
||
|
|
* @return $this
|
||
|
|
*/
|
||
|
|
public function setAutowired(bool $autowired)
|
||
|
|
{
|
||
|
|
$this->changes['autowired'] = true;
|
||
|
|
|
||
|
|
$this->autowired = $autowired;
|
||
|
|
|
||
|
|
return $this;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Gets bindings.
|
||
|
|
*
|
||
|
|
* @return array|BoundArgument[]
|
||
|
|
*/
|
||
|
|
public function getBindings()
|
||
|
|
{
|
||
|
|
return $this->bindings;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Sets bindings.
|
||
|
|
*
|
||
|
|
* Bindings map $named or FQCN arguments to values that should be
|
||
|
|
* injected in the matching parameters (of the constructor, of methods
|
||
|
|
* called and of controller actions).
|
||
|
|
*
|
||
|
|
* @return $this
|
||
|
|
*/
|
||
|
|
public function setBindings(array $bindings)
|
||
|
|
{
|
||
|
|
foreach ($bindings as $key => $binding) {
|
||
|
|
if (0 < strpos($key, '$') && $key !== $k = preg_replace('/[ \t]*\$/', ' $', $key)) {
|
||
|
|
unset($bindings[$key]);
|
||
|
|
$bindings[$key = $k] = $binding;
|
||
|
|
}
|
||
|
|
if (!$binding instanceof BoundArgument) {
|
||
|
|
$bindings[$key] = new BoundArgument($binding);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
$this->bindings = $bindings;
|
||
|
|
|
||
|
|
return $this;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Add an error that occurred when building this Definition.
|
||
|
|
*
|
||
|
|
* @param string|\Closure|self $error
|
||
|
|
*
|
||
|
|
* @return $this
|
||
|
|
*/
|
||
|
|
public function addError($error)
|
||
|
|
{
|
||
|
|
if ($error instanceof self) {
|
||
|
|
$this->errors = array_merge($this->errors, $error->errors);
|
||
|
|
} else {
|
||
|
|
$this->errors[] = $error;
|
||
|
|
}
|
||
|
|
|
||
|
|
return $this;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns any errors that occurred while building this Definition.
|
||
|
|
*
|
||
|
|
* @return array
|
||
|
|
*/
|
||
|
|
public function getErrors()
|
||
|
|
{
|
||
|
|
foreach ($this->errors as $i => $error) {
|
||
|
|
if ($error instanceof \Closure) {
|
||
|
|
$this->errors[$i] = (string) $error();
|
||
|
|
} elseif (!\is_string($error)) {
|
||
|
|
$this->errors[$i] = (string) $error;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
return $this->errors;
|
||
|
|
}
|
||
|
|
|
||
|
|
public function hasErrors(): bool
|
||
|
|
{
|
||
|
|
return (bool) $this->errors;
|
||
|
|
}
|
||
|
|
}
|