TaggedIteratorArgument
extends IteratorArgument
in package
Represents a collection of services found by tag name to lazily iterate over.
Tags
Table of Contents
- $defaultIndexMethod : mixed
- $defaultPriorityMethod : mixed
- $indexAttribute : mixed
- $needsIndexes : mixed
- $tag : mixed
- $values : mixed
- __construct() : mixed
- getDefaultIndexMethod() : string|null
- getDefaultPriorityMethod() : string|null
- getIndexAttribute() : string|null
- getTag() : mixed
- getValues() : array<string|int, Reference>
- needsIndexes() : bool
- setValues() : mixed
Properties
$defaultIndexMethod
private
mixed
$defaultIndexMethod
$defaultPriorityMethod
private
mixed
$defaultPriorityMethod
$indexAttribute
private
mixed
$indexAttribute
$needsIndexes
private
mixed
$needsIndexes
= false
$tag
private
mixed
$tag
$values
private
mixed
$values
Methods
__construct()
public
__construct(string $tag[, string|null $indexAttribute = null ][, string|null $defaultIndexMethod = null ][, bool $needsIndexes = false ][, string|null $defaultPriorityMethod = null ]) : mixed
Parameters
- $tag : string
-
The name of the tag identifying the target services
- $indexAttribute : string|null = null
-
The name of the attribute that defines the key referencing each service in the tagged collection
- $defaultIndexMethod : string|null = null
-
The static method that should be called to get each service's key when their tag doesn't define the previous attribute
- $needsIndexes : bool = false
-
Whether indexes are required and should be generated when computing the map
- $defaultPriorityMethod : string|null = null
-
The static method that should be called to get each service's priority when their tag doesn't define the "priority" attribute
Return values
mixed —getDefaultIndexMethod()
public
getDefaultIndexMethod() : string|null
Return values
string|null —getDefaultPriorityMethod()
public
getDefaultPriorityMethod() : string|null
Return values
string|null —getIndexAttribute()
public
getIndexAttribute() : string|null
Return values
string|null —getTag()
public
getTag() : mixed
Return values
mixed —getValues()
public
getValues() : array<string|int, Reference>
Return values
array<string|int, Reference> —needsIndexes()
public
needsIndexes() : bool
Return values
bool —setValues()
public
setValues(array<string|int, Reference> $values) : mixed
Parameters
- $values : array<string|int, Reference>
-
The service references to put in the set