Class WaiterClassFactory
Factory for creating Aws\Common\Waiter\WaiterInterface
objects using a convention of
storing waiter classes in the Waiter folder of a client class namespace using a
snake_case to CamelCase conversion (e.g. camel_case => CamelCase).
- Aws\Common\Waiter\WaiterClassFactory implements Aws\Common\Waiter\WaiterFactoryInterface
Methods summary
-
public
__construct ( array|string $namespaces = array(), Guzzle\Inflection\InflectorInterface $inflector = null )
-
public
registerNamespace ( string $namespace )
Registers a namespace to check for Waiters
-
public
build ( string $waiter )
Create a waiter by name
-
public
canBuild ( string $waiter )
Check if the factory can create a waiter by a specific name
-
protected
getClassName ( string $waiter )
Get the name of a waiter class
Methods detail
#
public
__construct( array|string $namespaces = array(), Guzzle\Inflection\InflectorInterface
$inflector = null )
Parameters
- $namespaces
array|string
$namespaces Namespaces of waiter objects- $inflector
Guzzle\Inflection\InflectorInterface
$inflector Inflector used to resolve class names
Registers a namespace to check for Waiters
Parameters
- $namespace
string
$namespace Namespace which contains Waiter classes
Returns
Create a waiter by name
Parameters
- $waiter
string
$waiter Name of the waiter to create
Returns
Implementation of
Check if the factory can create a waiter by a specific name
Parameters
- $waiter
string
$waiter Name of the waiter to check
Returns
boolean
Implementation of
Get the name of a waiter class
Parameters
- $waiter
string
$waiter Waiter name
Returns
string|null
Magic methods summary
Properties summary
protected
array
|
$namespaces |
#
List of namespaces used to look for classes |
protected
|
$inflector |
#
Inflector used to inflect class names |