Overview

Packages

  • Cli
    • Modular

Classes

  • Horde_Cli_Modular
  • Horde_Cli_Modular_Exception
  • Horde_Cli_Modular_ModuleProvider
  • Horde_Cli_Modular_Modules

Interfaces

  • Horde_Cli_Modular_Module
  • Overview
  • Package
  • Class
  • Tree

Interface Horde_Cli_Modular_Module

The Horde_Cli_Modular_Module:: interface characterizes a single CLI module.

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.

Package: Cli\Modular
Category: Horde
License: LGPL 2.1
Author: Gunnar Wrobel wrobel@pardus.de
Link: http://www.horde.org/libraries/Horde_Cli_Modular
Located at Horde/Cli/Modular/Module.php
Methods summary
public string
# getUsage( )

Get the usage description for this module.

Get the usage description for this module.

Returns

string
The description.
public array
# getBaseOptions( )

Get a set of base options that this module adds to the CLI argument parser.

Get a set of base options that this module adds to the CLI argument parser.

Returns

array
The options.
public boolean
# hasOptionGroup( )

Indicate if the module provides an option group.

Indicate if the module provides an option group.

Returns

boolean
True if an option group should be added.
public string
# getOptionGroupTitle( )

Return the title for the option group representing this module.

Return the title for the option group representing this module.

Returns

string
The group title.
public string
# getOptionGroupDescription( )

Return the description for the option group representing this module.

Return the description for the option group representing this module.

Returns

string
The group description.
public array
# getOptionGroupOptions( )

Return the options for this module.

Return the options for this module.

Returns

array
The group options.
API documentation generated by ApiGen