AbstractResourceIteratorFactory
in package
implements
ResourceIteratorFactoryInterface
AbstractYes
Abstract resource iterator factory implementation
Table of Contents
Interfaces
- ResourceIteratorFactoryInterface
- Factory for creating {@see ResourceIteratorInterface} objects
Methods
- build() : ResourceIteratorInterface
- Create a resource iterator
- canBuild() : bool
- Check if the factory can create an iterator
- getClassName() : string
- Get the name of the class to instantiate for the command
Methods
build()
Create a resource iterator
public
build(CommandInterface $command[, array<string|int, mixed> $options = array() ]) : ResourceIteratorInterface
Parameters
- $command : CommandInterface
-
Command to create an iterator for
- $options : array<string|int, mixed> = array()
-
Iterator options that are exposed as data.
Return values
ResourceIteratorInterfacecanBuild()
Check if the factory can create an iterator
public
canBuild(CommandInterface $command) : bool
Parameters
- $command : CommandInterface
-
Command to create an iterator for
Return values
boolgetClassName()
Get the name of the class to instantiate for the command
protected
abstract getClassName(CommandInterface $command) : string
Parameters
- $command : CommandInterface
-
Command that is associated with the iterator