Class Horde_Cli_Modular_Modules
The Horde_Cli_Modular_Modules:: class handles a set of CLI modules.
Copyright 2010-2012 Horde LLC (http://www.horde.org/)
See the enclosed file COPYING for license information (LGPL). If you
did not receive this file, see http://www.horde.org/licenses/lgpl21.
-
Horde_Cli_Modular_Modules
implements
Iterator,
Countable
Methods summary
public
|
#
__construct( array $parameters = null )
Constructor.
Parameters
- $parameters
- Options for this instance.
<pre>- directory: (string) The path to the directory that holds the modules.
- exclude: (<span class="php-keyword1">array</span>) Exclude these modules from the <span class="php-keyword1">list</span>.</pre>
|
public
array
|
#
listModules( )
List the available modules.
List the available modules.
Returns
array
The list of modules.
|
public
|
#
rewind( )
Implementation of the Iterator rewind() method. Rewinds the module list.
Implementation of the Iterator rewind() method. Rewinds the module list.
return NULL
Implementation of
Iterator::rewind()
|
public
mixed
|
#
current( )
Implementation of the Iterator current(). Returns the current module.
Implementation of the Iterator current(). Returns the current module.
Returns
mixed
The current module.
Implementation of
Iterator::current()
|
public
mixed
|
#
key( )
Implementation of the Iterator key() method. Returns the key of the current module.
Implementation of the Iterator key() method. Returns the key of the current module.
Returns
mixed
The class name of the current module.
Implementation of
Iterator::key()
|
public
Cli_Modular_Module|null
|
#
next( )
Implementation of the Iterator next() method. Returns the next module.
Implementation of the Iterator next() method. Returns the next module.
Returns
Cli_Modular_Module|nullThe next module or null if there are no more
modules.
Implementation of
Iterator::next()
|
public
boolean
|
#
valid( )
Implementation of the Iterator valid() method. Indicates if the current element is a valid element.
Implementation of the Iterator valid() method. Indicates if the current element is a valid element.
Returns
boolean
Whether the current element is valid
Implementation of
Iterator::valid()
|
public
integer
|
#
count( )
Implementation of Countable count() method. Returns the number of modules.
Implementation of Countable count() method. Returns the number of modules.
Returns
integer
Number of modules.
Implementation of
Countable::count()
|