Documentation

ServiceConfigurator extends AbstractServiceConfigurator
in package
uses AbstractTrait, ArgumentTrait, AutoconfigureTrait, AutowireTrait, BindTrait, CallTrait, ClassTrait, ConfiguratorTrait, ConstructorTrait, DecorateTrait, DeprecateTrait, FactoryTrait, FileTrait, FromCallableTrait, LazyTrait, ParentTrait, PropertyTrait, PublicTrait, ShareTrait, SyntheticTrait, TagTrait

Tags
author

Nicolas Grekas p@tchwork.com

Table of Contents

Constants

FACTORY  = 'services'

Properties

$valuePreProcessor  : callable(mixed, bool): mixed|null
$id  : mixed
$parent  : mixed
$allowParent  : bool
$container  : ContainerBuilder
$destructed  : bool
$instanceof  : array<string|int, mixed>
$path  : string|null

Methods

__call()  : mixed
__construct()  : mixed
__destruct()  : mixed
__invoke()  : ServiceConfigurator
Registers a service.
__serialize()  : array<string|int, mixed>
__unserialize()  : void
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.
constructor()  : $this
Sets a static constructor.
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.
fromCallable()  : FromCallableConfigurator
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
remove()  : ServicesConfigurator
Removes an already defined service definition or alias.
set()  : ServiceConfigurator
Registers a service.
share()  : $this
Sets if the service must be shared or not.
stack()  : AliasConfigurator
Registers a stack of decorator services.
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.
validateAttributes()  : void

Constants

Properties

Methods

__call()

public __call(string $method, array<string|int, mixed> $args) : mixed
Parameters
$method : string
$args : array<string|int, mixed>

__construct()

public __construct(ContainerBuilder $container, array<string|int, mixed> $instanceof, bool $allowParent, ServicesConfigurator $parent, Definition $definition, string|null $id, array<string|int, mixed> $defaultTags[, string|null $path = null ]) : mixed
Parameters
$container : ContainerBuilder
$instanceof : array<string|int, mixed>
$allowParent : bool
$parent : ServicesConfigurator
$definition : Definition
$id : string|null
$defaultTags : array<string|int, mixed>
$path : string|null = null

__serialize()

public __serialize() : array<string|int, mixed>
Return values
array<string|int, mixed>

__unserialize()

public __unserialize(array<string|int, mixed> $data) : void
Parameters
$data : array<string|int, mixed>

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

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
throws
InvalidArgumentException

when a parent is already set

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 an 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
throws
InvalidArgumentException

on empty $method param

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>|ReferenceConfigurator $configurator) : $this
Parameters
$configurator : string|array<string|int, mixed>|ReferenceConfigurator
Return values
$this

constructor()

Sets a static constructor.

public final constructor(string $constructor) : $this
Parameters
$constructor : string
Return values
$this

decorate()

Sets the service that this service is decorating.

public final decorate(string|null $id[, string|null $renamedId = null ][, int $priority = 0 ][, int $invalidBehavior = ContainerInterface::EXCEPTION_ON_INVALID_REFERENCE ]) : $this
Parameters
$id : string|null

The decorated service id, use null to remove decoration

$renamedId : string|null = null
$priority : int = 0
$invalidBehavior : int = ContainerInterface::EXCEPTION_ON_INVALID_REFERENCE
Tags
throws
InvalidArgumentException

in case the decorated service id and the new decorated service id are equals

Return values
$this

deprecate()

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

public final deprecate(string $package, string $version, string $message) : $this
Parameters
$package : string

The name of the composer package that is triggering the deprecation

$version : string

The version of the package that introduced the deprecation

$message : string

The deprecation message to use

Tags
throws
InvalidArgumentException

when the message template is invalid

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

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 true to make it extend from the definition's class

Return values
$this

parent()

Sets the Definition to inherit from.

public final parent(string $parent) : $this
Parameters
$parent : string
Tags
throws
InvalidArgumentException

when parent cannot be set

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, arrays and enum 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

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> = []
Return values
$this

validateAttributes()

private validateAttributes(string $tag, array<string|int, mixed> $attributes[, array<string|int, mixed> $path = [] ]) : void
Parameters
$tag : string
$attributes : array<string|int, mixed>
$path : array<string|int, mixed> = [] 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results