Documentation

Help
in package
implements Horde_Cli_Modular_Module, Horde_Cli_Modular_ModuleUsage Uses HordectlModuleTrait

Help command module implements CLI help/usage

Interfaces, Classes, Traits and Enums

Horde_Cli_Modular_Module
Horde_Cli_Modular_ModuleUsage

Table of Contents

$_parentModule  : mixed
$_parsed  : mixed
$_parser  : mixed
$_positional  : mixed
__construct()  : mixed
getBaseOptions()  : mixed
getOptionGroupDescription()  : mixed
getOptionGroupOptions()  : mixed
getOptionGroupTitle()  : mixed
getParentModule()  : Horde_Cli_Modular_Module
getPositionalArgs()  : array<string|int, mixed>
Get the list of possible arguments for this module's position
getTitle()  : string
Default implementation of getTitle
getUsage()  : mixed
handle()  : mixed
Decide if this module handles the commandline
handleCommandline()  : mixed
Handle commandline given to this module
hasOptionGroup()  : mixed
isRootModule()  : mixed
setParentModule()  : mixed

Properties

Methods

__construct()

public __construct(Horde_Injector $dependencies) : mixed
Parameters
$dependencies : Horde_Injector
Return values
mixed —

getOptionGroupDescription()

public getOptionGroupDescription() : mixed
Return values
mixed —

getOptionGroupOptions()

public getOptionGroupOptions([mixed $action = null ]) : mixed
Parameters
$action : mixed = null
Return values
mixed —

getParentModule()

public getParentModule() : Horde_Cli_Modular_Module
Return values
Horde_Cli_Modular_Module —

getPositionalArgs()

Get the list of possible arguments for this module's position

public getPositionalArgs() : array<string|int, mixed>

If a module implements a positional, it will be extracted before the commandline is evaluated

Default implementation, override as needed

Return values
array<string|int, mixed> —

getTitle()

Default implementation of getTitle

public getTitle() : string

Override this as needed

Return values
string —

The title of the module

handle()

Decide if this module handles the commandline

public handle([array<string|int, mixed> $argv = [] ]) : mixed
Parameters
$argv : array<string|int, mixed> = []
Tags
params

array $argv The arguments for the parser to digest

Return values
mixed —

handleCommandline()

Handle commandline given to this module

public handleCommandline(array<string|int, mixed> $argv) : mixed

Commandline options and keywords belonging to parent modules have already been removed. The module's PositionalArgs will be checked in second position and removed. Options will only be regarded until the following positional argument.

Position 0 in argv is assumed to be the program name // non-interspersed parser may not tolerate position 0

Parameters
$argv : array<string|int, mixed>
Return values
mixed —

setParentModule()

public setParentModule(Horde_Cli_Modular_Module $module) : mixed
Parameters
$module : Horde_Cli_Modular_Module
Return values
mixed —

Search results