PHP Class Phergie_Plugin_Iterator, phergie

Author: Phergie Development Team ([email protected])
Inheritance: extends FilterIterator
Afficher le fichier Open project: phergie/phergie Class Usage Examples

Protected Properties

Свойство 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

Méthodes publiques

Méthode 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.

Method Details

__construct() public méthode

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
Résultat void

accept() public méthode

Implements FilterIterator::accept().
public accept ( ) : boolean
Résultat boolean TRUE to include the current item in those by returned during iteration, FALSE otherwise

addMethodFilter() public méthode

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
Résultat Phergie_Plugin_Iterator Provides a fluent interface

addPluginFilter() public méthode

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
Résultat Phergie_Plugin_Iterator Provides a fluent interface

clearFilters() public méthode

Clears any existing plugin and methods filters.
public clearFilters ( ) : Phergie_Plugin_Iterator
Résultat Phergie_Plugin_Iterator Provides a fluent interface

Property Details

$methods protected_oe property

List of method names where plugins with these methods will be excluded when iterating
protected array $methods
Résultat array

$plugins protected_oe property

List of short names of plugins to exclude when iterating
protected array $plugins
Résultat array