Class CompositeFactory
Composite factory used by a client object to create command objects utilizing multiple factories
- Guzzle\Service\Command\Factory\CompositeFactory implements IteratorAggregate, Countable, Guzzle\Service\Command\Factory\FactoryInterface
Namespace: Guzzle\Service\Command\Factory
Located at Guzzle/Service/Command/Factory/CompositeFactory.php
Located at Guzzle/Service/Command/Factory/CompositeFactory.php
Methods summary
-
public staticgetDefaultChain ( Guzzle\Service\ClientInterface $client )Get the default chain to use with clients
-
public__construct ( array $factories = array() ) -
publicadd ( Guzzle\Service\Command\Factory\FactoryInterface $factory, string|FactoryInterface $before = null )Add a command factory to the chain
-
publichas ( FactoryInterface|string $factory )Check if the chain contains a specific command factory
-
publicremove ( string|FactoryInterface $factory = null )Remove a specific command factory from the chain
-
publicfind ( string|FactoryInterface $factory )Get a command factory by class name
-
publicfactory ( string $name, array $args = array() )Create a command using the associated command factories
-
publiccount ( ) -
publicgetIterator ( )
Methods detail
#
public static
Guzzle\Service\Command\Factory\CompositeFactory
getDefaultChain( Guzzle\Service\ClientInterface $client )
Get the default chain to use with clients
Parameters
- $client
Guzzle\Service\ClientInterface
$client Client to base the chain on
Returns
Parameters
- $factories
array
$factories Array of command factories
#
public
Guzzle\Service\Command\Factory\CompositeFactory
add( Guzzle\Service\Command\Factory\FactoryInterface $factory, string|Guzzle\Service\Command\Factory\FactoryInterface $before = null )
Add a command factory to the chain
Parameters
- $factory
Guzzle\Service\Command\Factory\FactoryInterface
$factory Factory to add- $before
string|Guzzle\Service\Command\Factory\FactoryInterface
$before Insert the new command factory before a command factory class or object matching a class name.
Returns
Check if the chain contains a specific command factory
Parameters
- $factory
Guzzle\Service\Command\Factory\FactoryInterface|string
$factory Factory to check
Returns
boolean
#
public
Guzzle\Service\Command\Factory\CompositeFactory
remove( string|Guzzle\Service\Command\Factory\FactoryInterface $factory = null )
Remove a specific command factory from the chain
Parameters
- $factory
string|Guzzle\Service\Command\Factory\FactoryInterface
$factory Factory to remove by name or instance
Returns
#
public
null|Guzzle\Service\Command\Factory\FactoryInterface
find( string|Guzzle\Service\Command\Factory\FactoryInterface $factory )
Get a command factory by class name
Parameters
- $factory
string|Guzzle\Service\Command\Factory\FactoryInterface
$factory Command factory class or instance
Returns
Create a command using the associated command factories
Parameters
- $name
string
$name Name of the command- $args
array
$args Command arguments
Returns
Implementation of
Implementation of
Implementation of
Magic methods summary
Properties summary
protected
array
|
$factories |
#
Array of command factories |