WaiterConfigFactory
in package
implements
WaiterFactoryInterface
Factory for creating {@see WaiterInterface} objects using a configuration DSL.
Table of Contents
Interfaces
- WaiterFactoryInterface
- Waiter factory used to create waiter objects by short names
Properties
- $config : array<string|int, mixed>
- $inflector : InflectorInterface
Methods
- __construct() : mixed
- build() : WaiterInterface
- Create a waiter by name
- canBuild() : bool
- Check if the factory can create a waiter by a specific name
- getWaiterConfig() : WaiterConfig
- Get waiter configuration data, taking __default__ and extensions into account
Properties
$config
protected
array<string|int, mixed>
$config
Configuration directives
$inflector
protected
InflectorInterface
$inflector
Inflector used to inflect class names
Methods
__construct()
public
__construct(array<string|int, mixed> $config[, InflectorInterface $inflector = null ]) : mixed
Parameters
- $config : array<string|int, mixed>
-
Array of configuration directives
- $inflector : InflectorInterface = null
-
Inflector used to resolve class names
build()
Create a waiter by name
public
build(mixed $waiter) : WaiterInterface
Parameters
- $waiter : mixed
-
Name of the waiter to create
Return values
WaiterInterfacecanBuild()
Check if the factory can create a waiter by a specific name
public
canBuild(mixed $waiter) : bool
Parameters
- $waiter : mixed
-
Name of the waiter to check
Return values
boolgetWaiterConfig()
Get waiter configuration data, taking __default__ and extensions into account
protected
getWaiterConfig(string $name) : WaiterConfig
Parameters
- $name : string
-
Waiter name