PHP Class Phergie_Plugin_Iterator, phergie

Author: Phergie Development Team ([email protected])

Inheritance: extends FilterIterator

Protected Properties

Property	Type	Description
$methods	array	List of method names where plugins with these methods will be excluded when iterating
$plugins	array	List of short names of plugins to exclude when iterating

Method	Description
__construct ( Iterator $iterator ) : void	Overrides the parent constructor to reset the internal iterator's pointer to the current item, which the parent class errantly does not do.
accept ( ) : boolean	Implements FilterIterator::accept().
addMethodFilter ( mixed $methods ) : Phergie_Plugin_Iterator	Adds to a list of method names where plugins defining these methods will be excluded when iterating.
addPluginFilter ( mixed $plugins ) : Phergie_Plugin_Iterator	Adds to a list of plugins to exclude when iterating.
clearFilters ( ) : Phergie_Plugin_Iterator	Clears any existing plugin and methods filters.

Overrides the parent constructor to reset the internal iterator's pointer to the current item, which the parent class errantly does not do.

public __construct ( Iterator $iterator ) : void
$iterator	Iterator	Iterator to filter
return	void

Implements FilterIterator::accept().

public accept ( ) : boolean
return	boolean	TRUE to include the current item in those by returned during iteration, FALSE otherwise

Adds to a list of method names where plugins defining these methods will be excluded when iterating.

public addMethodFilter ( mixed $methods ) : Phergie_Plugin_Iterator
$methods	mixed	String containing the name of a single method or an array containing the name of multiple methods
return	Phergie_Plugin_Iterator	Provides a fluent interface

Adds to a list of plugins to exclude when iterating.

public addPluginFilter ( mixed $plugins ) : Phergie_Plugin_Iterator
$plugins	mixed	String containing the short name of a single plugin to exclude or an array of short names of multiple plugins to exclude
return	Phergie_Plugin_Iterator	Provides a fluent interface

Clears any existing plugin and methods filters.

public clearFilters ( ) : Phergie_Plugin_Iterator
return	Phergie_Plugin_Iterator	Provides a fluent interface

List of method names where plugins with these methods will be excluded when iterating

protected array $methods
return	array

List of short names of plugins to exclude when iterating

protected array $plugins
return	array