class DefinitionDecorator extends Definition
deprecated
This definition decorates another definition.
__construct(string|null $class = null, array $arguments = array()) | from Definition | |
array | getChanges() Returns all changes tracked for the Definition object. | from Definition |
$this | setChanges(array $changes) Sets the tracked changes for the Definition object. | from Definition |
$this | setFactory(string|array $factory) Sets a factory. | from Definition |
string|array | getFactory() Gets the factory. | from Definition |
$this | setDecoratedService(null|string $id, null|string $renamedId = null, int $priority) Sets the service that this service is decorating. | from Definition |
null|array | getDecoratedService() Gets the service that this service is decorating. | from Definition |
$this | setClass(string $class) Sets the service class. | from Definition |
string|null | getClass() Gets the service class. | from Definition |
$this | setArguments(array $arguments) Sets the arguments to pass to the service constructor/factory method. | from Definition |
setProperties(array $properties) | from Definition | |
getProperties() | from Definition | |
setProperty($name, $value) | from Definition | |
$this | addArgument(mixed $argument) Adds an argument to pass to the service constructor/factory method. | from Definition |
$this | replaceArgument(int|string $index, mixed $argument) Sets a specific argument. | from Definition |
setArgument($key, $value) | from Definition | |
array | getArguments() Gets the arguments to pass to the service constructor/factory method. | from Definition |
mixed | getArgument(int|string $index) Gets an argument to pass to the service constructor/factory method. | from Definition |
$this | setMethodCalls(array $calls = array()) Sets the methods to call after service initialization. | from Definition |
$this | addMethodCall(string $method, array $arguments = array()) Adds a method to call after service initialization. | from Definition |
$this | removeMethodCall(string $method) Removes a method to call after service initialization. | from Definition |
bool | hasMethodCall(string $method) Check if the current definition has a given method to call after service initialization. | from Definition |
array | getMethodCalls() Gets the methods to call after service initialization. | from Definition |
setInstanceofConditionals(array $instanceof) Sets the definition templates to conditionally apply on the current definition, keyed by parent interface/class. | from Definition | |
ChildDefinition[] | getInstanceofConditionals() Gets the definition templates to conditionally apply on the current definition, keyed by parent interface/class. | from Definition |
$this | setAutoconfigured(bool $autoconfigured) Sets whether or not instanceof conditionals should be prepended with a global set. | from Definition |
bool | isAutoconfigured() | from Definition |
$this | setTags(array $tags) Sets tags for this definition. | from Definition |
array | getTags() Returns all tags. | from Definition |
array | getTag(string $name) Gets a tag by name. | from Definition |
$this | addTag(string $name, array $attributes = array()) Adds a tag for this definition. | from Definition |
bool | hasTag(string $name) Whether this definition has a tag with the given name. | from Definition |
$this | clearTag(string $name) Clears all tags for a given name. | from Definition |
$this | clearTags() Clears the tags for this definition. | from Definition |
$this | setFile(string $file) Sets a file to require before creating the service. | from Definition |
string|null | getFile() Gets the file to require before creating the service. | from Definition |
$this | setShared(bool $shared) Sets if the service must be shared or not. | from Definition |
bool | isShared() Whether this service is shared. | from Definition |
$this | setPublic(bool $boolean) Sets the visibility of this service. | from Definition |
bool | isPublic() Whether this service is public facing. | from Definition |
$this | setLazy(bool $lazy) Sets the lazy flag of this service. | from Definition |
bool | isLazy() Whether this service is lazy. | from Definition |
$this | setSynthetic(bool $boolean) Sets whether this definition is synthetic, that is not constructed by the container, but dynamically injected. | from Definition |
bool | isSynthetic() Whether this definition is synthetic, that is not constructed by the container, but dynamically injected. | from Definition |
$this | setAbstract(bool $boolean) Whether this definition is abstract, that means it merely serves as a template for other definitions. | from Definition |
bool | isAbstract() Whether this definition is abstract, that means it merely serves as a template for other definitions. | from Definition |
$this | setDeprecated(bool $status = true, string $template = null) Whether this definition is deprecated, that means it should not be called anymore. | from Definition |
bool | isDeprecated() Whether this definition is deprecated, that means it should not be called anymore. | from Definition |
string | getDeprecationMessage(string $id) Message to use if this definition is deprecated. | from Definition |
$this | setConfigurator(string|array $configurator) Sets a configurator to call after the service is fully initialized. | from Definition |
callable|null | getConfigurator() Gets the configurator to call after the service is fully initialized. | from Definition |
$this | setAutowiringTypes(array $types) deprecated Sets types that will default to this definition. | from Definition |
bool | isAutowired() Is the definition autowired? | from Definition |
$this | setAutowired(bool $autowired) Sets autowired. | from Definition |
string[] | getAutowiringTypes() deprecated Gets autowiring types that will default to this definition. | from Definition |
$this | addAutowiringType(string $type) deprecated Adds a type that will default to this definition. | from Definition |
$this | removeAutowiringType(string $type) deprecated Removes a type. | from Definition |
bool | hasAutowiringType(string $type) deprecated Will this definition default for the given type? | from Definition |
string|null | $class | The service class |
array | $arguments | An array of arguments to pass to the service constructor |
Returns all changes tracked for the Definition object.
array | An array of changes for this Definition |
Sets the tracked changes for the Definition object.
array | $changes |
$this |
Sets a factory.
string|array | $factory | A PHP function or an array containing a class/Reference and a method to call |
$this |
Gets the factory.
string|array | The PHP function or an array containing a class/Reference and a method to call |
Sets the service that this service is decorating.
null|string | $id | The decorated service id, use null to remove decoration |
null|string | $renamedId | The new decorated service id |
int | $priority | The priority of decoration |
$this |
InvalidArgumentException | In case the decorated service id and the new decorated service id are equals. |
Gets the service that this service is decorating.
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 |
Sets the service class.
string | $class | The service class |
$this |
Gets the service class.
string|null | The service class |
Sets the arguments to pass to the service constructor/factory method.
array | $arguments | An array of arguments |
$this |
array | $properties |
$name | ||
$value |
Adds an argument to pass to the service constructor/factory method.
mixed | $argument | An argument |
$this |
Sets a specific argument.
int|string | $index | |
mixed | $argument |
$this |
OutOfBoundsException | When the replaced argument does not exist |
$key | ||
$value |
Gets the arguments to pass to the service constructor/factory method.
array | The array of arguments |
Gets an argument to pass to the service constructor/factory method.
int|string | $index |
mixed | The argument value |
OutOfBoundsException | When the argument does not exist |
Sets the methods to call after service initialization.
array | $calls | An array of method calls |
$this |
Adds a method to call after service initialization.
string | $method | The method name to call |
array | $arguments | An array of arguments to pass to the method call |
$this |
InvalidArgumentException | on empty $method param |
Removes a method to call after service initialization.
string | $method | The method name to remove |
$this |
Check if the current definition has a given method to call after service initialization.
string | $method | The method name to search for |
bool |
Gets the methods to call after service initialization.
array | An array of method calls |
Sets the definition templates to conditionally apply on the current definition, keyed by parent interface/class.
array | $instanceof | ChildDefinition[] |
Gets the definition templates to conditionally apply on the current definition, keyed by parent interface/class.
ChildDefinition[] |
Sets whether or not instanceof conditionals should be prepended with a global set.
bool | $autoconfigured |
$this |
bool |
Sets tags for this definition.
array | $tags |
$this |
Returns all tags.
array | An array of tags |
Gets a tag by name.
string | $name | The tag name |
array | An array of attributes |
Adds a tag for this definition.
string | $name | The tag name |
array | $attributes | An array of attributes |
$this |
Whether this definition has a tag with the given name.
string | $name |
bool |
Clears all tags for a given name.
string | $name | The tag name |
$this |
Clears the tags for this definition.
$this |
Sets a file to require before creating the service.
string | $file | A full pathname to include |
$this |
Gets the file to require before creating the service.
string|null | The full pathname to include |
Sets if the service must be shared or not.
bool | $shared | Whether the service must be shared or not |
$this |
Whether this service is shared.
bool |
Sets the visibility of this service.
bool | $boolean |
$this |
Whether this service is public facing.
bool |
Sets the lazy flag of this service.
bool | $lazy |
$this |
Whether this service is lazy.
bool |
Sets whether this definition is synthetic, that is not constructed by the container, but dynamically injected.
bool | $boolean |
$this |
Whether this definition is synthetic, that is not constructed by the container, but dynamically injected.
bool |
Whether this definition is abstract, that means it merely serves as a template for other definitions.
bool | $boolean |
$this |
Whether this definition is abstract, that means it merely serves as a template for other definitions.
bool |
Whether this definition is deprecated, that means it should not be called anymore.
bool | $status | |
string | $template | Template message to use if the definition is deprecated |
$this |
InvalidArgumentException | When the message template is invalid. |
Whether this definition is deprecated, that means it should not be called anymore.
bool |
Message to use if this definition is deprecated.
string | $id | Service id relying on this definition |
string |
Sets a configurator to call after the service is fully initialized.
string|array | $configurator | A PHP callable |
$this |
Gets the configurator to call after the service is fully initialized.
callable|null | The PHP callable to call |
deprecated
Sets types that will default to this definition.
array | $types |
$this |
Is the definition autowired?
bool |
Sets autowired.
bool | $autowired |
$this |
deprecated
Gets autowiring types that will default to this definition.
string[] |
deprecated
Adds a type that will default to this definition.
string | $type |
$this |
deprecated
Removes a type.
string | $type |
$this |
deprecated
Will this definition default for the given type?
string | $type |
bool |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/4.0/Symfony/Component/DependencyInjection/DefinitionDecorator.html