Documentation

Components
in package

The Components:: class is the entry point for the various component actions provided by the package.

Copyright 2010-2020 Horde LLC (http://www.horde.org/)

See the enclosed file LICENSE for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.

Tags
category

Horde

author

Gunnar Wrobel wrobel@pardus.de

license

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

Table of Contents

ERROR_NO_ACTION  = 'You did not specify an action!'
ERROR_NO_ACTION_OR_COMPONENT  = '"%s" specifies neither an action nor a component directory!'
ERROR_NO_COMPONENT  = 'You are neither in a component directory nor specified it as the first argument!'
main()  : void
The main entry point for the application.
_getActionArguments()  : array<string|int, mixed>
Provide a list of available action arguments.
_identifyComponent()  : void
Identify the selected component based on the command arguments.
_prepareConfig()  : Configs
_prepareDependencies()  : Dependencies
The main entry point for the application.
_prepareModular()  : Horde_Cli_Modular

Constants

ERROR_NO_ACTION

public final mixed ERROR_NO_ACTION = 'You did not specify an action!'

ERROR_NO_ACTION_OR_COMPONENT

public final mixed ERROR_NO_ACTION_OR_COMPONENT = '"%s" specifies neither an action nor a component directory!'

ERROR_NO_COMPONENT

public final mixed ERROR_NO_COMPONENT = 'You are neither in a component directory nor specified it as the first argument!'

Methods

main()

The main entry point for the application.

public static main([array<string|int, mixed> $parameters = [] ]) : void
Parameters
$parameters : array<string|int, mixed> = []

A list of named configuration parameters.

'cli'        - (array)  CLI configuration parameters.
  'parser'   - (array)  Parser configuration parameters.
    'class'  - (string) The class name of the parser to use.
Return values
void —

_getActionArguments()

Provide a list of available action arguments.

protected static _getActionArguments(Horde_Cli_Modular $modular) : array<string|int, mixed>
Parameters
$modular : Horde_Cli_Modular
Return values
array<string|int, mixed> —

_identifyComponent()

Identify the selected component based on the command arguments.

protected static _identifyComponent(Config $config, array<string|int, mixed> $actions, Dependencies $dependencies) : void
Parameters
$config : Config

The active configuration.

$actions : array<string|int, mixed>

The list of available actions.

$dependencies : Dependencies
Return values
void —

_prepareConfig()

protected static _prepareConfig(Horde_Argv_Parser $parser) : Configs
Parameters
$parser : Horde_Argv_Parser
Return values
Configs —

_prepareDependencies()

The main entry point for the application.

protected static _prepareDependencies(array<string|int, mixed> $parameters) : Dependencies
Parameters
$parameters : array<string|int, mixed>

A list of named configuration parameters.

Return values
Dependencies —

The dependency handler.

_prepareModular()

protected static _prepareModular(Dependencies $dependencies[, array<string|int, mixed> $parameters = [] ]) : Horde_Cli_Modular
Parameters
$dependencies : Dependencies
$parameters : array<string|int, mixed> = []
Return values
Horde_Cli_Modular —

Search results