DefinitionDecorator deprecated

class DefinitionDecorator extends Definition

deprecated

The DefinitionDecorator class is deprecated since version 3.3 and will be removed in 4.0. Use the Symfony\Component\DependencyInjection\ChildDefinition class instead.

This definition decorates another definition.

Methods

__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

Details

__construct(string|null $class = null, array $arguments = array())

Parameters

string|null $class The service class
array $arguments An array of arguments to pass to the service constructor

array getChanges()

Returns all changes tracked for the Definition object.

Return Value

array An array of changes for this Definition

$this setChanges(array $changes)

Sets the tracked changes for the Definition object.

Parameters

array $changes

Return Value

$this

$this setFactory(string|array $factory)

Sets a factory.

Parameters

string|array $factory A PHP function or an array containing a class/Reference and a method to call

Return Value

$this

string|array getFactory()

Gets the factory.

Return Value

string|array The PHP function or an array containing a class/Reference and a method to call

$this setDecoratedService(null|string $id, null|string $renamedId = null, int $priority)

Sets the service that this service is decorating.

Parameters

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

Return Value

$this

Exceptions

InvalidArgumentException In case the decorated service id and the new decorated service id are equals.

null|array getDecoratedService()

Gets the service that this service is decorating.

Return Value

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

$this setClass(string $class)

Sets the service class.

Parameters

string $class The service class

Return Value

$this

string|null getClass()

Gets the service class.

Return Value

string|null The service class

$this setArguments(array $arguments)

Sets the arguments to pass to the service constructor/factory method.

Parameters

array $arguments An array of arguments

Return Value

$this

setProperties(array $properties)

Parameters

array $properties

getProperties()

setProperty($name, $value)

Parameters

$name
$value

$this addArgument(mixed $argument)

Adds an argument to pass to the service constructor/factory method.

Parameters

mixed $argument An argument

Return Value

$this

$this replaceArgument(int|string $index, mixed $argument)

Sets a specific argument.

Parameters

int|string $index
mixed $argument

Return Value

$this

Exceptions

OutOfBoundsException When the replaced argument does not exist

setArgument($key, $value)

Parameters

$key
$value

array getArguments()

Gets the arguments to pass to the service constructor/factory method.

Return Value

array The array of arguments

mixed getArgument(int|string $index)

Gets an argument to pass to the service constructor/factory method.

Parameters

int|string $index

Return Value

mixed The argument value

Exceptions

OutOfBoundsException When the argument does not exist

$this setMethodCalls(array $calls = array())

Sets the methods to call after service initialization.

Parameters

array $calls An array of method calls

Return Value

$this

$this addMethodCall(string $method, array $arguments = array())

Adds a method to call after service initialization.

Parameters

string $method The method name to call
array $arguments An array of arguments to pass to the method call

Return Value

$this

Exceptions

InvalidArgumentException on empty $method param

$this removeMethodCall(string $method)

Removes a method to call after service initialization.

Parameters

string $method The method name to remove

Return Value

$this

bool hasMethodCall(string $method)

Check if the current definition has a given method to call after service initialization.

Parameters

string $method The method name to search for

Return Value

bool

array getMethodCalls()

Gets the methods to call after service initialization.

Return Value

array An array of method calls

setInstanceofConditionals(array $instanceof)

Sets the definition templates to conditionally apply on the current definition, keyed by parent interface/class.

Parameters

array $instanceof ChildDefinition[]

ChildDefinition[] getInstanceofConditionals()

Gets the definition templates to conditionally apply on the current definition, keyed by parent interface/class.

Return Value

ChildDefinition[]

$this setAutoconfigured(bool $autoconfigured)

Sets whether or not instanceof conditionals should be prepended with a global set.

Parameters

bool $autoconfigured

Return Value

$this

bool isAutoconfigured()

Return Value

bool

$this setTags(array $tags)

Sets tags for this definition.

Parameters

array $tags

Return Value

$this

array getTags()

Returns all tags.

Return Value

array An array of tags

array getTag(string $name)

Gets a tag by name.

Parameters

string $name The tag name

Return Value

array An array of attributes

$this addTag(string $name, array $attributes = array())

Adds a tag for this definition.

Parameters

string $name The tag name
array $attributes An array of attributes

Return Value

$this

bool hasTag(string $name)

Whether this definition has a tag with the given name.

Parameters

string $name

Return Value

bool

$this clearTag(string $name)

Clears all tags for a given name.

Parameters

string $name The tag name

Return Value

$this

$this clearTags()

Clears the tags for this definition.

Return Value

$this

$this setFile(string $file)

Sets a file to require before creating the service.

Parameters

string $file A full pathname to include

Return Value

$this

string|null getFile()

Gets the file to require before creating the service.

Return Value

string|null The full pathname to include

$this setShared(bool $shared)

Sets if the service must be shared or not.

Parameters

bool $shared Whether the service must be shared or not

Return Value

$this

bool isShared()

Whether this service is shared.

Return Value

bool

$this setPublic(bool $boolean)

Sets the visibility of this service.

Parameters

bool $boolean

Return Value

$this

bool isPublic()

Whether this service is public facing.

Return Value

bool

$this setLazy(bool $lazy)

Sets the lazy flag of this service.

Parameters

bool $lazy

Return Value

$this

bool isLazy()

Whether this service is lazy.

Return Value

bool

$this setSynthetic(bool $boolean)

Sets whether this definition is synthetic, that is not constructed by the container, but dynamically injected.

Parameters

bool $boolean

Return Value

$this

bool isSynthetic()

Whether this definition is synthetic, that is not constructed by the container, but dynamically injected.

Return Value

bool

$this setAbstract(bool $boolean)

Whether this definition is abstract, that means it merely serves as a template for other definitions.

Parameters

bool $boolean

Return Value

$this

bool isAbstract()

Whether this definition is abstract, that means it merely serves as a template for other definitions.

Return Value

bool

$this setDeprecated(bool $status = true, string $template = null)

Whether this definition is deprecated, that means it should not be called anymore.

Parameters

bool $status
string $template Template message to use if the definition is deprecated

Return Value

$this

Exceptions

InvalidArgumentException When the message template is invalid.

bool isDeprecated()

Whether this definition is deprecated, that means it should not be called anymore.

Return Value

bool

string getDeprecationMessage(string $id)

Message to use if this definition is deprecated.

Parameters

string $id Service id relying on this definition

Return Value

string

$this setConfigurator(string|array $configurator)

Sets a configurator to call after the service is fully initialized.

Parameters

string|array $configurator A PHP callable

Return Value

$this

callable|null getConfigurator()

Gets the configurator to call after the service is fully initialized.

Return Value

callable|null The PHP callable to call

$this setAutowiringTypes(array $types) deprecated

deprecated

since version 3.3, to be removed in 4.0.

Sets types that will default to this definition.

Parameters

array $types

Return Value

$this

bool isAutowired()

Is the definition autowired?

Return Value

bool

$this setAutowired(bool $autowired)

Sets autowired.

Parameters

bool $autowired

Return Value

$this

string[] getAutowiringTypes() deprecated

deprecated

since version 3.3, to be removed in 4.0.

Gets autowiring types that will default to this definition.

Return Value

string[]

$this addAutowiringType(string $type) deprecated

deprecated

since version 3.3, to be removed in 4.0.

Adds a type that will default to this definition.

Parameters

string $type

Return Value

$this

$this removeAutowiringType(string $type) deprecated

deprecated

since version 3.3, to be removed in 4.0.

Removes a type.

Parameters

string $type

Return Value

$this

bool hasAutowiringType(string $type) deprecated

deprecated

since version 3.3, to be removed in 4.0.

Will this definition default for the given type?

Parameters

string $type

Return Value

bool

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/4.0/Symfony/Component/DependencyInjection/DefinitionDecorator.html