Documentation

Horde_Cli_Modular_Modules
in package
implements IteratorAggregate, Countable

The Horde_Cli_Modular_Modules:: class handles a set of CLI modules.

Tags
author

Gunnar Wrobel wrobel@pardus.de

category

Horde

copyright

2010-2017 Horde LLC

license

http://www.horde.org/licenses/lgpl21 LGPL

Interfaces, Classes, Traits and Enums

IteratorAggregate
Countable

Table of Contents

$_modules  : array<string|int, mixed>
The available modules.
$_parameters  : array<string|int, mixed>
Parameters.
__construct()  : mixed
Constructor.
count()  : int
Implementation of Countable count() method. Returns the number of modules.
getIterator()  : Iterator
listModules()  : array<string|int, mixed>
List the available modules.
_initModules()  : null
Initialize the list of module class names.

Properties

$_modules

The available modules.

private array<string|int, mixed> $_modules

$_parameters

Parameters.

private array<string|int, mixed> $_parameters

Methods

__construct()

Constructor.

public __construct([array<string|int, mixed> $parameters = null ]) : mixed
Parameters
$parameters : array<string|int, mixed> = null

Options for this instance.

 - directory: (string) The path to the directory that holds the modules.
 - exclude:   (array) Exclude these modules from the list.
Return values
mixed

count()

Implementation of Countable count() method. Returns the number of modules.

public count() : int
Return values
int

Number of modules.

getIterator()

public getIterator() : Iterator
Return values
Iterator

listModules()

List the available modules.

public listModules() : array<string|int, mixed>
Return values
array<string|int, mixed>

The list of modules.

_initModules()

Initialize the list of module class names.

private _initModules() : null
Tags
throws
Horde_Cli_Modular_Exception

In case the list of modules could not be established.

Return values
null

Search results