class Definition

Definition represents a service definition.

Properties

protected $arguments

Methods

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

No description

array
getChanges()

Returns all changes tracked for the Definition object.

$this
setChanges(array $changes)

Sets the tracked changes for the Definition object.

$this
setFactory(string|array $factory)

Sets a factory.

string|array|null
getFactory()

Gets the factory.

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

Sets the service that this service is decorating.

array|null
getDecoratedService()

Gets the service that this service is decorating.

$this
setClass(string $class)

Sets the service class.

string|null
getClass()

Gets the service class.

$this
setArguments(array $arguments)

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

$this
setProperties(array $properties)

Sets the properties to define when creating the service.

array
getProperties()

Gets the properties to define when creating the service.

$this
setProperty(string $name, mixed $value)

Sets a specific property.

$this
addArgument(mixed $argument)

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

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

Replaces a specific argument.

$this
setArgument(int|string $key, mixed $value)

Sets a specific argument.

array
getArguments()

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

mixed
getArgument(int|string $index)

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

$this
setMethodCalls(array $calls = [])

Sets the methods to call after service initialization.

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

Adds a method to call after service initialization.

$this
removeMethodCall(string $method)

Removes a method to call after service initialization.

bool
hasMethodCall(string $method)

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

array
getMethodCalls()

Gets the methods to call after service initialization.

$this
setInstanceofConditionals(array $instanceof)

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

getInstanceofConditionals()

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

$this
setAutoconfigured(bool $autoconfigured)

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

bool
isAutoconfigured()

No description

$this
setTags(array $tags)

Sets tags for this definition.

array
getTags()

Returns all tags.

array
getTag(string $name)

Gets a tag by name.

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

Adds a tag for this definition.

bool
hasTag(string $name)

Whether this definition has a tag with the given name.

$this
clearTag(string $name)

Clears all tags for a given name.

$this
clearTags()

Clears the tags for this definition.

$this
setFile(string $file)

Sets a file to require before creating the service.

string|null
getFile()

Gets the file to require before creating the service.

$this
setShared(bool $shared)

Sets if the service must be shared or not.

bool
isShared()

Whether this service is shared.

$this
setPublic(bool $boolean)

Sets the visibility of this service.

bool
isPublic()

Whether this service is public facing.

$this
setPrivate(bool $boolean)

Sets if this service is private.

bool
isPrivate()

Whether this service is private.

$this
setLazy(bool $lazy)

Sets the lazy flag of this service.

bool
isLazy()

Whether this service is lazy.

$this
setSynthetic(bool $boolean)

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

bool
isSynthetic()

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

$this
setAbstract(bool $boolean)

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

bool
isAbstract()

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

$this
setDeprecated(bool $status = 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.

string
getDeprecationMessage(string $id)

Message to use if this definition is deprecated.

$this
setConfigurator(string|array $configurator)

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.

$this
setAutowiringTypes(array $types) deprecated

Sets types that will default to this definition.

bool
isAutowired()

Is the definition autowired?

$this
setAutowired(bool $autowired)

Enables/disables autowiring.

string[]
getAutowiringTypes() deprecated

Gets autowiring types that will default to this definition.

$this
addAutowiringType(string $type) deprecated

Adds a type that will default to this definition.

$this
removeAutowiringType(string $type) deprecated

Removes a type.

bool
hasAutowiringType(string $type) deprecated

Will this definition default for the given type?

array
getBindings()

Gets bindings.

$this
setBindings(array $bindings)

Sets bindings.

addError(string $error)

Add an error that occurred when building this Definition.

array
getErrors()

Returns any errors that occurred while building this Definition.

Details

at line 57
__construct(string|null $class = null, array $arguments = [])

Parameters

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

at line 70
array getChanges()

Returns all changes tracked for the Definition object.

Return Value

array An array of changes for this Definition

at line 82
$this setChanges(array $changes)

Sets the tracked changes for the Definition object.

Parameters

array $changes An array of changes for this Definition

Return Value

$this

at line 96
$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

at line 114
string|array|null getFactory()

Gets the factory.

Return Value

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

at line 130
$this setDecoratedService(string|null $id, string|null $renamedId = null, int $priority = 0)

Sets the service that this service is decorating.

Parameters

string|null $id The decorated service id, use null to remove decoration
string|null $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

at line 152
array|null getDecoratedService()

Gets the service that this service is decorating.

Return Value

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

at line 164
$this setClass(string $class)

Sets the service class.

Parameters

string $class The service class

Return Value

$this

at line 178
string|null getClass()

Gets the service class.

Return Value

string|null The service class

at line 188
$this setArguments(array $arguments)

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

Parameters

array $arguments

Return Value

$this

at line 200
$this setProperties(array $properties)

Sets the properties to define when creating the service.

Parameters

array $properties

Return Value

$this

at line 212
array getProperties()

Gets the properties to define when creating the service.

Return Value

array

at line 225
$this setProperty(string $name, mixed $value)

Sets a specific property.

Parameters

string $name
mixed $value

Return Value

$this

at line 239
$this addArgument(mixed $argument)

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

Parameters

mixed $argument An argument

Return Value

$this

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

Replaces a specific argument.

Parameters

int|string $index
mixed $argument

Return Value

$this

Exceptions

OutOfBoundsException When the replaced argument does not exist

at line 283
$this setArgument(int|string $key, mixed $value)

Sets a specific argument.

Parameters

int|string $key
mixed $value

Return Value

$this

at line 295
array getArguments()

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

Return Value

array The array of arguments

at line 309
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

at line 323
$this setMethodCalls(array $calls = [])

Sets the methods to call after service initialization.

Parameters

array $calls

Return Value

$this

at line 343
$this addMethodCall(string $method, array $arguments = [])

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

at line 360
$this removeMethodCall(string $method)

Removes a method to call after service initialization.

Parameters

string $method The method name to remove

Return Value

$this

at line 379
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

at line 395
array getMethodCalls()

Gets the methods to call after service initialization.

Return Value

array An array of method calls

at line 407
$this setInstanceofConditionals(array $instanceof)

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

Parameters

array $instanceof

Return Value

$this

at line 419
ChildDefinition[] getInstanceofConditionals()

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

Return Value

ChildDefinition[]

at line 431
$this setAutoconfigured(bool $autoconfigured)

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

Parameters

bool $autoconfigured

Return Value

$this

at line 443
bool isAutoconfigured()

Return Value

bool

at line 453
$this setTags(array $tags)

Sets tags for this definition.

Parameters

array $tags

Return Value

$this

at line 465
array getTags()

Returns all tags.

Return Value

array An array of tags

at line 477
array getTag(string $name)

Gets a tag by name.

Parameters

string $name The tag name

Return Value

array An array of attributes

at line 490
$this addTag(string $name, array $attributes = [])

Adds a tag for this definition.

Parameters

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

Return Value

$this

at line 504
bool hasTag(string $name)

Whether this definition has a tag with the given name.

Parameters

string $name

Return Value

bool

at line 516
$this clearTag(string $name)

Clears all tags for a given name.

Parameters

string $name The tag name

Return Value

$this

at line 528
$this clearTags()

Clears the tags for this definition.

Return Value

$this

at line 542
$this setFile(string $file)

Sets a file to require before creating the service.

Parameters

string $file A full pathname to include

Return Value

$this

at line 556
string|null getFile()

Gets the file to require before creating the service.

Return Value

string|null The full pathname to include

at line 568
$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

at line 582
bool isShared()

Whether this service is shared.

Return Value

bool

at line 594
$this setPublic(bool $boolean)

Sets the visibility of this service.

Parameters

bool $boolean

Return Value

$this

at line 609
bool isPublic()

Whether this service is public facing.

Return Value

bool

at line 626
$this setPrivate(bool $boolean)

Sets if this service is private.

When set, the "private" state has a higher precedence than "public". In version 3.4, a "private" service always remains publicly accessible, but triggers a deprecation notice when accessed from the container, so that the service can be made really private in 4.0.

Parameters

bool $boolean

Return Value

$this

at line 638
bool isPrivate()

Whether this service is private.

Return Value

bool

at line 650
$this setLazy(bool $lazy)

Sets the lazy flag of this service.

Parameters

bool $lazy

Return Value

$this

at line 664
bool isLazy()

Whether this service is lazy.

Return Value

bool

at line 677
$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

at line 690
bool isSynthetic()

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

Return Value

bool

at line 703
$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

at line 716
bool isAbstract()

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

Return Value

bool

at line 732
$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

at line 759
bool isDeprecated()

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

Return Value

bool

at line 771
string getDeprecationMessage(string $id)

Message to use if this definition is deprecated.

Parameters

string $id Service id relying on this definition

Return Value

string

at line 783
$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

at line 801
callable|null getConfigurator()

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

Return Value

callable|null The PHP callable to call

at line 815
$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

at line 833
bool isAutowired()

Is the definition autowired?

Return Value

bool

at line 845
$this setAutowired(bool $autowired)

Enables/disables autowiring.

Parameters

bool $autowired

Return Value

$this

at line 861
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[]

at line 879
$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

at line 897
$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

at line 915
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

at line 927
array getBindings()

Gets bindings.

Return Value

array

at line 943
$this setBindings(array $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).

Parameters

array $bindings

Return Value

$this

at line 961
addError(string $error)

Add an error that occurred when building this Definition.

Parameters

string $error

at line 971
array getErrors()

Returns any errors that occurred while building this Definition.

Return Value

array