Overview

Packages

  • Kolab
    • Cli

Classes

  • Horde_Kolab_Cli
  • Horde_Kolab_Cli_Data_Ledger
  • Horde_Kolab_Cli_Exception
  • Horde_Kolab_Cli_Module_Account
  • Horde_Kolab_Cli_Module_Base
  • Horde_Kolab_Cli_Module_Data
  • Horde_Kolab_Cli_Module_Folder
  • Horde_Kolab_Cli_Module_Format
  • Horde_Kolab_Cli_Module_Ledger
  • Horde_Kolab_Cli_Module_List
  • Horde_Kolab_Cli_Translation

Interfaces

  • Horde_Kolab_Cli_Module
  • Overview
  • Package
  • Class
  • Tree

Class Horde_Kolab_Cli_Module_Format

The Horde_Kolab_Cli_Module_Format:: handles the Kolab format.

Copyright 2011-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_Kolab_Cli_Module_Format implements Horde_Kolab_Cli_Module
Package: Kolab\Cli
Category: Horde
License: LGPL 2.1
Author: Gunnar Wrobel wrobel@pardus.de
Link: http://pear.horde.org/index.php?package=Kolab_Cli
Located at Horde/Kolab/Cli/Module/Format.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.
public null
# handleArguments( mixed & $options, mixed & $arguments, array & $world )

Handle the options and arguments.

Handle the options and arguments.

Parameters

$options
$options An array of options.
$arguments
$arguments An array of arguments.
$world
$world A list of initialized dependencies.

Returns

null

Implementation of

Horde_Kolab_Cli_Module::handleArguments()
public null
# run( Horde_Cli $cli, mixed $options, mixed $arguments, array & $world )

Run the module.

Run the module.

Parameters

$cli
The CLI handler.
$options
An array of options.
$arguments
An array of arguments.
$world
$world A list of initialized dependencies.

Returns

null
API documentation generated by ApiGen