Public Member Functions | |
| __construct (array $factories) | |
| addFactory (ResourceIteratorFactoryInterface $factory) | |
| build (CommandInterface $command, array $options=array()) | |
| canBuild (CommandInterface $command) | |
Protected Member Functions | |
| getFactory (CommandInterface $command) | |
Protected Attributes | |
| $factories | |
Detailed Description
Factory that utilizes multiple factories for creating iterators
Definition at line 11 of file CompositeResourceIteratorFactory.php.
Constructor & Destructor Documentation
◆ __construct()
| Guzzle\Service\Resource\CompositeResourceIteratorFactory::__construct | ( | array | $factories | ) |
- Parameters
-
array $factories Array of factories used to instantiate iterators
Definition at line 20 of file CompositeResourceIteratorFactory.php.
References Guzzle\Service\Resource\CompositeResourceIteratorFactory\$factories.
Member Function Documentation
◆ addFactory()
| Guzzle\Service\Resource\CompositeResourceIteratorFactory::addFactory | ( | ResourceIteratorFactoryInterface | $factory | ) |
Add a factory to the composite factory
- Parameters
-
ResourceIteratorFactoryInterface $factory Factory to add
- Returns
- self
Definition at line 46 of file CompositeResourceIteratorFactory.php.
◆ build()
| Guzzle\Service\Resource\CompositeResourceIteratorFactory::build | ( | CommandInterface | $command, |
| array | $options = array() |
||
| ) |
Create a resource iterator
- Parameters
-
CommandInterface $command Command to create an iterator for array $options Iterator options that are exposed as data.
- Returns
- ResourceIteratorInterface
Implements Guzzle\Service\Resource\ResourceIteratorFactoryInterface.
Definition at line 25 of file CompositeResourceIteratorFactory.php.
References Guzzle\Service\Resource\CompositeResourceIteratorFactory\getFactory(), and Guzzle\Service\Command\CommandInterface\getName().
◆ canBuild()
| Guzzle\Service\Resource\CompositeResourceIteratorFactory::canBuild | ( | CommandInterface | $command | ) |
Check if the factory can create an iterator
- Parameters
-
CommandInterface $command Command to create an iterator for
- Returns
- bool
Implements Guzzle\Service\Resource\ResourceIteratorFactoryInterface.
Definition at line 34 of file CompositeResourceIteratorFactory.php.
References Guzzle\Service\Resource\CompositeResourceIteratorFactory\getFactory().
◆ getFactory()
|
protected |
Get the factory that matches the command object
- Parameters
-
CommandInterface $command Command retrieving the iterator for
- Returns
- ResourceIteratorFactoryInterface|bool
Definition at line 60 of file CompositeResourceIteratorFactory.php.
Referenced by Guzzle\Service\Resource\CompositeResourceIteratorFactory\build(), and Guzzle\Service\Resource\CompositeResourceIteratorFactory\canBuild().
Field Documentation
◆ $factories
|
protected |
Array of factories
Definition at line 17 of file CompositeResourceIteratorFactory.php.
Referenced by Guzzle\Service\Resource\CompositeResourceIteratorFactory\__construct().
The documentation for this class was generated from the following file:
