DefinitionDecorator (Component\DependencyInjection)
Symfony\Component\DependencyInjection\DefinitionDecorator
class DefinitionDecorator extends Definition
This definition decorates another definition.
Methods
__construct(string $parent) Constructor. | ||
Definition | setFactory($callable) Sets a factory. | |
string|array | getFactory() Gets the factory. | from Definition |
Definition | setDecoratedService(null|string $id, null|string $renamedId = null, int $priority) Sets the service that this service is decorating. | |
null|array | getDecoratedService() Gets the service that decorates this service. | from Definition |
Definition | setClass(string $class) Sets the service class. | |
string|null | getClass() Gets the service class. | from Definition |
Definition | 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 | |
Definition | addArgument(mixed $argument) Adds an argument to pass to the service constructor/factory method. | from Definition |
DefinitionDecorator | replaceArgument(int $index, mixed $value) You should always use this method when overwriting existing arguments of the parent definition. | |
array | getArguments() Gets the arguments to pass to the service constructor/factory method. | from Definition |
mixed | getArgument(int $index) Gets an argument to pass to the service constructor/factory method. | |
Definition | setMethodCalls(array $calls = array()) Sets the methods to call after service initialization. | from Definition |
Definition | addMethodCall(string $method, array $arguments = array()) Adds a method to call after service initialization. | from Definition |
Definition | 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 |
Definition | 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 |
Definition | 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 |
Definition | clearTag(string $name) Clears all tags for a given name. | from Definition |
Definition | clearTags() Clears the tags for this definition. | from Definition |
Definition | setFile(string $file) Sets a file to require before creating the service. | |
string|null | getFile() Gets the file to require before creating the service. | from Definition |
Definition | setShared(bool $shared) Sets if the service must be shared or not. | from Definition |
bool | isShared() Whether this service is shared. | from Definition |
Definition | setPublic(bool $boolean) Sets the visibility of this service. | |
bool | isPublic() Whether this service is public facing. | from Definition |
Definition | setLazy($boolean) Sets the lazy flag of this service. | |
bool | isLazy() Whether this service is lazy. | from Definition |
Definition | 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 |
Definition | 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 |
Definition | setDeprecated($boolean = true, string $template = null) Whether this definition is deprecated, that means it should not be called anymore. | |
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 |
Definition | setConfigurator(callable $callable) Sets a configurator to call after the service is fully initialized. | |
callable|null | getConfigurator() Gets the configurator to call after the service is fully initialized. | from Definition |
Definition | setAutowiringTypes(array $types) Sets types that will default to this definition. | from Definition |
bool | isAutowired() Is the definition autowired? | from Definition |
Definition | setAutowired($autowired $autowired) Sets autowired. | from Definition |
string[] | getAutowiringTypes() Gets autowiring types that will default to this definition. | from Definition |
Definition | addAutowiringType(string $type) Adds a type that will default to this definition. | from Definition |
Definition | removeAutowiringType(string $type) Removes a type. | from Definition |
bool | hasAutowiringType(string $type) Will this definition default for the given type? | from Definition |
string | getParent() Returns the Definition being decorated. | |
array | getChanges() Returns all changes tracked for the Definition object. |
Details
public __construct(string $parent)
Constructor.
public Definition setFactory($callable)
Sets a factory.
public string|array getFactory()
Gets the factory.
public Definition setDecoratedService(null|string $id, null|string $renamedId = null, int $priority)
Sets the service that this service is decorating.
public null|array getDecoratedService()
Gets the service that decorates this service.
public Definition setClass(string $class)
Sets the service class.
public string|null getClass()
Gets the service class.
public Definition setArguments(array $arguments)
Sets the arguments to pass to the service constructor/factory method.
public setProperties(array $properties)
public getProperties()
public setProperty($name, $value)
public Definition addArgument(mixed $argument)
Adds an argument to pass to the service constructor/factory method.
public DefinitionDecorator replaceArgument(int $index, mixed $value)
You should always use this method when overwriting existing arguments of the parent definition.
If you directly call setArguments() keep in mind that you must follow certain conventions when you want to overwrite the arguments of the parent definition, otherwise your arguments will only be appended.
public array getArguments()
Gets the arguments to pass to the service constructor/factory method.
public mixed getArgument(int $index)
Gets an argument to pass to the service constructor/factory method.
If replaceArgument() has been used to replace an argument, this method will return the replacement value.
public Definition setMethodCalls(array $calls = array())
Sets the methods to call after service initialization.
public Definition addMethodCall(string $method, array $arguments = array())
Adds a method to call after service initialization.
public Definition removeMethodCall(string $method)
Removes a method to call after service initialization.
public bool hasMethodCall(string $method)
Check if the current definition has a given method to call after service initialization.
public array getMethodCalls()
Gets the methods to call after service initialization.
public Definition setTags(array $tags)
Sets tags for this definition.
public array getTags()
Returns all tags.
public array getTag(string $name)
Gets a tag by name.
public Definition addTag(string $name, array $attributes = array())
Adds a tag for this definition.
public bool hasTag(string $name)
Whether this definition has a tag with the given name.
public Definition clearTag(string $name)
Clears all tags for a given name.
public Definition clearTags()
Clears the tags for this definition.
public Definition setFile(string $file)
Sets a file to require before creating the service.
public string|null getFile()
Gets the file to require before creating the service.
public Definition setShared(bool $shared)
Sets if the service must be shared or not.
public bool isShared()
Whether this service is shared.
public Definition setPublic(bool $boolean)
Sets the visibility of this service.
public bool isPublic()
Whether this service is public facing.
public Definition setLazy($boolean)
Sets the lazy flag of this service.
public bool isLazy()
Whether this service is lazy.
public Definition setSynthetic(bool $boolean)
Sets whether this definition is synthetic, that is not constructed by the container, but dynamically injected.
public bool isSynthetic()
Whether this definition is synthetic, that is not constructed by the container, but dynamically injected.
public Definition setAbstract(bool $boolean)
Whether this definition is abstract, that means it merely serves as a template for other definitions.
public bool isAbstract()
Whether this definition is abstract, that means it merely serves as a template for other definitions.
public Definition setDeprecated($boolean = true, string $template = null)
Whether this definition is deprecated, that means it should not be called anymore.
public bool isDeprecated()
Whether this definition is deprecated, that means it should not be called anymore.
public string getDeprecationMessage(string $id)
Message to use if this definition is deprecated.
public Definition setConfigurator(callable $callable)
Sets a configurator to call after the service is fully initialized.
public callable|null getConfigurator()
Gets the configurator to call after the service is fully initialized.
public Definition setAutowiringTypes(array $types)
Sets types that will default to this definition.
public bool isAutowired()
Is the definition autowired?
public Definition setAutowired($autowired $autowired)
Sets autowired.
public string[] getAutowiringTypes()
Gets autowiring types that will default to this definition.
public Definition addAutowiringType(string $type)
Adds a type that will default to this definition.
public Definition removeAutowiringType(string $type)
Removes a type.
public bool hasAutowiringType(string $type)
Will this definition default for the given type?
public string getParent()
Returns the Definition being decorated.
public array getChanges()
Returns all changes tracked for the Definition object.
© 2004–2016 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.0/Symfony/Component/DependencyInjection/DefinitionDecorator.html