ServiceConfigurator
extends AbstractServiceConfigurator
in package
Uses
AbstractTrait, ArgumentTrait, AutoconfigureTrait, AutowireTrait, BindTrait, CallTrait, ClassTrait, ConfiguratorTrait, DecorateTrait, DeprecateTrait, FactoryTrait, FileTrait, LazyTrait, ParentTrait, PropertyTrait, PublicTrait, ShareTrait, SyntheticTrait, TagTrait
Tags
Table of Contents
- FACTORY = 'services'
- $id : mixed
- $parent : mixed
- $allowParent : mixed
- $container : mixed
- $defaultTags : mixed
- $instanceof : mixed
- $path : mixed
- __call() : mixed
- __construct() : mixed
- __destruct() : mixed
- __invoke() : ServiceConfigurator
- Registers a service.
- abstract() : $this
- Whether this definition is abstract, that means it merely serves as a template for other definitions.
- alias() : AliasConfigurator
- Creates an alias.
- arg() : $this
- Sets one argument to pass to the service constructor/factory method.
- args() : $this
- Sets the arguments to pass to the service constructor/factory method.
- autoconfigure() : $this
- Sets whether or not instanceof conditionals should be prepended with a global set.
- autowire() : $this
- Enables/disables autowiring.
- bind() : $this
- Sets bindings.
- call() : $this
- Adds a method to call after service initialization.
- class() : $this
- Sets the service class.
- configurator() : $this
- Sets a configurator to call after the service is fully initialized.
- decorate() : $this
- Sets the service that this service is decorating.
- deprecate() : $this
- Whether this definition is deprecated, that means it should not be called anymore.
- factory() : $this
- Sets a factory.
- file() : $this
- Sets a file to require before creating the service.
- get() : ServiceConfigurator
- Gets an already defined service definition.
- lazy() : $this
- Sets the lazy flag of this service.
- load() : PrototypeConfigurator
- Registers a PSR-4 namespace using a glob pattern.
- parent() : $this
- Sets the Definition to inherit from.
- private() : $this
- processValue() : mixed
- Checks that a value is valid, optionally replacing Definition and Reference configurators by their configure value.
- property() : $this
- Sets a specific property.
- public() : $this
- set() : ServiceConfigurator
- Registers a service.
- share() : $this
- Sets if the service must be shared or not.
- synthetic() : $this
- Sets whether this definition is synthetic, that is not constructed by the container, but dynamically injected.
- tag() : $this
- Adds a tag for this definition.
Constants
FACTORY
public
mixed
FACTORY
= 'services'
Properties
$id
protected
mixed
$id
$parent
protected
mixed
$parent
$allowParent
private
mixed
$allowParent
$container
private
mixed
$container
$defaultTags
private
mixed
$defaultTags
= []
$instanceof
private
mixed
$instanceof
$path
private
mixed
$path
Methods
__call()
public
__call(string $method, array<string|int, mixed> $args) : mixed
Parameters
- $method : string
- $args : array<string|int, mixed>
Return values
mixed —__construct()
public
__construct(ContainerBuilder $container, array<string|int, mixed> $instanceof, bool $allowParent, ServicesConfigurator $parent, Definition $definition, mixed $id, array<string|int, mixed> $defaultTags[, string $path = null ]) : mixed
Parameters
- $container : ContainerBuilder
- $instanceof : array<string|int, mixed>
- $allowParent : bool
- $parent : ServicesConfigurator
- $definition : Definition
- $id : mixed
- $defaultTags : array<string|int, mixed>
- $path : string = null
Return values
mixed —__destruct()
public
__destruct() : mixed
Return values
mixed —__invoke()
Registers a service.
public
final __invoke(string $id[, string $class = null ]) : ServiceConfigurator
Parameters
- $id : string
- $class : string = null
Return values
ServiceConfigurator —abstract()
Whether this definition is abstract, that means it merely serves as a template for other definitions.
public
final abstract([bool $abstract = true ]) : $this
Parameters
- $abstract : bool = true
Return values
$this —alias()
Creates an alias.
public
final alias(string $id, string $referencedId) : AliasConfigurator
Parameters
- $id : string
- $referencedId : string
Return values
AliasConfigurator —arg()
Sets one argument to pass to the service constructor/factory method.
public
final arg(string|int $key, mixed $value) : $this
Parameters
- $key : string|int
- $value : mixed
Return values
$this —args()
Sets the arguments to pass to the service constructor/factory method.
public
final args(array<string|int, mixed> $arguments) : $this
Parameters
- $arguments : array<string|int, mixed>
Return values
$this —autoconfigure()
Sets whether or not instanceof conditionals should be prepended with a global set.
public
final autoconfigure([bool $autoconfigured = true ]) : $this
Parameters
- $autoconfigured : bool = true
Tags
Return values
$this —autowire()
Enables/disables autowiring.
public
final autowire([bool $autowired = true ]) : $this
Parameters
- $autowired : bool = true
Return values
$this —bind()
Sets bindings.
public
final bind(string $nameOrFqcn, mixed $valueOrRef) : $this
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
- $nameOrFqcn : string
-
A parameter name with its "$" prefix, or a FQCN
- $valueOrRef : mixed
-
The value or reference to bind
Return values
$this —call()
Adds a method to call after service initialization.
public
final call(string $method[, array<string|int, mixed> $arguments = [] ][, bool $returnsClone = false ]) : $this
Parameters
- $method : string
-
The method name to call
- $arguments : array<string|int, mixed> = []
-
An array of arguments to pass to the method call
- $returnsClone : bool = false
-
Whether the call returns the service instance or not
Tags
Return values
$this —class()
Sets the service class.
public
final class(string|null $class) : $this
Parameters
- $class : string|null
Return values
$this —configurator()
Sets a configurator to call after the service is fully initialized.
public
final configurator(string|array<string|int, mixed> $configurator) : $this
Parameters
- $configurator : string|array<string|int, mixed>
-
A PHP callable reference
Return values
$this —decorate()
Sets the service that this service is decorating.
public
final decorate(string|null $id[, string $renamedId = null ], int $priority[, int $invalidBehavior = ContainerInterface::EXCEPTION_ON_INVALID_REFERENCE ]) : $this
Parameters
- $id : string|null
-
The decorated service id, use null to remove decoration
- $renamedId : string = null
- $priority : int
- $invalidBehavior : int = ContainerInterface::EXCEPTION_ON_INVALID_REFERENCE
Tags
Return values
$this —deprecate()
Whether this definition is deprecated, that means it should not be called anymore.
public
final deprecate([string $template = null ]) : $this
Parameters
- $template : string = null
-
Template message to use if the definition is deprecated
Tags
Return values
$this —factory()
Sets a factory.
public
final factory(string|array<string|int, mixed> $factory) : $this
Parameters
- $factory : string|array<string|int, mixed>
-
A PHP callable reference
Return values
$this —file()
Sets a file to require before creating the service.
public
final file(string $file) : $this
Parameters
- $file : string
Return values
$this —get()
Gets an already defined service definition.
public
final get(string $id) : ServiceConfigurator
Parameters
- $id : string
Tags
Return values
ServiceConfigurator —lazy()
Sets the lazy flag of this service.
public
final lazy([bool|string $lazy = true ]) : $this
Parameters
- $lazy : bool|string = true
-
A FQCN to derivate the lazy proxy from or
trueto make it extend from the definition's class
Return values
$this —load()
Registers a PSR-4 namespace using a glob pattern.
public
final load(string $namespace, string $resource) : PrototypeConfigurator
Parameters
- $namespace : string
- $resource : string
Return values
PrototypeConfigurator —parent()
Sets the Definition to inherit from.
public
final parent(string $parent) : $this
Parameters
- $parent : string
Tags
Return values
$this —private()
public
final private() : $this
Return values
$this —processValue()
Checks that a value is valid, optionally replacing Definition and Reference configurators by their configure value.
public
static processValue(mixed $value[, bool $allowServices = false ]) : mixed
Parameters
- $value : mixed
- $allowServices : bool = false
-
whether Definition and Reference are allowed; by default, only scalars and arrays are
Return values
mixed —the value, optionally cast to a Definition/Reference
property()
Sets a specific property.
public
final property(string $name, mixed $value) : $this
Parameters
- $name : string
- $value : mixed
Return values
$this —public()
public
final public() : $this
Return values
$this —set()
Registers a service.
public
final set(string|null $id[, string $class = null ]) : ServiceConfigurator
Parameters
- $id : string|null
- $class : string = null
Return values
ServiceConfigurator —share()
Sets if the service must be shared or not.
public
final share([bool $shared = true ]) : $this
Parameters
- $shared : bool = true
Return values
$this —synthetic()
Sets whether this definition is synthetic, that is not constructed by the container, but dynamically injected.
public
final synthetic([bool $synthetic = true ]) : $this
Parameters
- $synthetic : bool = true
Return values
$this —tag()
Adds a tag for this definition.
public
final tag(string $name[, array<string|int, mixed> $attributes = [] ]) : $this
Parameters
- $name : string
- $attributes : array<string|int, mixed> = []