Class CompositeResourceIteratorFactory
Factory that utilizes multiple factories for creating iterators
- Guzzle\Service\Resource\CompositeResourceIteratorFactory implements Guzzle\Service\Resource\ResourceIteratorFactoryInterface
Namespace: Guzzle\Service\Resource
Located at Guzzle/Service/Resource/CompositeResourceIteratorFactory.php
Located at Guzzle/Service/Resource/CompositeResourceIteratorFactory.php
Methods summary
-
public__construct ( array $factories ) -
publicbuild ( Guzzle\Service\Command\CommandInterface $command, array $options = array() )Create a resource iterator
-
publiccanBuild ( Guzzle\Service\Command\CommandInterface $command )Check if the factory can create an iterator
-
publicaddFactory ( Guzzle\Service\Resource\ResourceIteratorFactoryInterface $factory )Add a factory to the composite factory
-
protectedgetFactory ( Guzzle\Service\Command\CommandInterface $command )Get the factory that matches the command object
Methods detail
Parameters
- $factories
array
$factories Array of factories used to instantiate iterators
#
public
Guzzle\Service\Resource\ResourceIteratorInterface
build( Guzzle\Service\Command\CommandInterface $command, array $options = array() )
Create a resource iterator
Parameters
- $command
Guzzle\Service\Command\CommandInterface
$command Command to create an iterator for- $options
array
$options Iterator options that are exposed as data.
Returns
Implementation of
Check if the factory can create an iterator
Parameters
- $command
Guzzle\Service\Command\CommandInterface
$command Command to create an iterator for
Returns
booleanImplementation of
#
public
Guzzle\Service\Resource\CompositeResourceIteratorFactory
addFactory( Guzzle\Service\Resource\ResourceIteratorFactoryInterface $factory )
Add a factory to the composite factory
Parameters
- $factory
Guzzle\Service\Resource\ResourceIteratorFactoryInterface
$factory Factory to add
Returns
#
protected
Guzzle\Service\Resource\ResourceIteratorFactoryInterface|boolean
getFactory( Guzzle\Service\Command\CommandInterface $command )
Get the factory that matches the command object
Parameters
- $command
Guzzle\Service\Command\CommandInterface
$command Command retrieving the iterator for
Returns
Magic methods summary
Properties summary
protected
array
|
$factories |
#
Array of factories |