Arbit - project tracking

Arbit - project tracking

API documentation :: Docs For Class arbitFrameworkActionCliTool

Packages:

Interfaces:

Classes:

Core::arbitFrameworkActionCliTool

[ Index ] [ Core classes ] [ Core elements ] [ All elements ] [ Errors ]

Class arbitFrameworkActionCliTool

CLI tool class, which handles various adimistrative tasks.

CLI tool class, which handles various adimistrative tasks.

arbitFrameworkCliTool
   |
   --arbitFrameworkActionCliTool
Author(s):
Version:   $Revision: 1236 $
License:   GPL

Descendants

Child Class Description
arbitModulePdependAdminCliTool CLI tool class, which handles various adimistrative tasks.
arbitModulePhplocAdminCliTool CLI tool class, which handles various adimistrative tasks.
arbitModuleSourceAdminCliTool CLI tool class, which handles various adimistrative tasks.
arbitModuleTrackerAdminCliTool CLI tool class, which handles various adimistrative tasks.
arbitModulePhpcsAdminCliTool CLI tool class, which handles various adimistrative tasks.
arbitModulePhpDocAdminCliTool CLI tool class, which handles various adimistrative tasks.
arbitModulePhpunitAdminCliTool CLI tool class, which handles various adimistrative tasks.
arbitFrameworkCouchdbCliTool CLI tool class, which handles admintrative tasks regarding the CouchDB backend.
arbitFrameworkAdminCliTool CLI tool class, which handles various adimistrative tasks.
arbitFrameworkCronCliTool CLI tool class, which handles cron tasks

Member Variables

protected array $actions = array()
Available actions.

Available actions. Mapping of the CLI action identifiers to their action names, the array should be structured like:

  1.   array(
  2.       'action' => array(
  3.           'action' => (string) Method name in controller,
  4.           'description' => (string) Action description,
  5.       ), ...
  6.   )

Inherited Member Variables

From arbitFrameworkCliTool
protected arbitFrameworkCliTool::$commonOptionGroups
protected arbitFrameworkCliTool::$description
protected arbitFrameworkCliTool::$in
protected arbitFrameworkCliTool::$name
protected arbitFrameworkCliTool::$out

Method Summary

protected bool processDefaultOptions( &$options , $options )
Process default options Handle the default options. stop afterwards, and false if the execution may continue.
protected void registerDefaultOptions( )
Register options Register a set of options, which are special for this CLI tool. left empty, if no additional options are required.

Inherited Methods

From arbitFrameworkCliTool
public void arbitFrameworkCliTool::__construct()
Create cli tool and configure basic in and out handling
protected abstract arbitController arbitFrameworkCliTool::createController()
Get controller
protected void arbitFrameworkCliTool::executeRequests()
Execute request for one project
protected array arbitFrameworkCliTool::getNonCommonOptions()
Get non-common options Get options declared by specific tool implementations, which are not the common options declared by the base tool.
protected array arbitFrameworkCliTool::getOptions()
Get option values Return an array with all option values, indexed by the long names of the options.
protected string arbitFrameworkCliTool::getVersion()
Return the current version
protected void arbitFrameworkCliTool::login()
Login user Either login a default user, with full access to everything, or use the specified user to execute the request.
protected bool arbitFrameworkCliTool::processDefaultOptions()
Process default options Handle the default options. stop afterwards, and false if the execution may continue.
protected bool arbitFrameworkCliTool::processOptions()
Process module options Handle the module options. stop afterwards, and false if the execution may continue.
protected void arbitFrameworkCliTool::registerDefaultOptions()
Register default options Register a set of default options, each arbit CLI tool should always implement.
protected void arbitFrameworkCliTool::registerOptions()
Register options Register a set of options, which are special for this CLI tool. left empty, if no additional options are required.
public void arbitFrameworkCliTool::run()
Run cli command

Methods

processDefaultOptions

bool processDefaultOptions( &$options , array $options )

Process default options Handle the default options. stop afterwards, and false if the execution may continue.

Process default options Handle the default options. Returns true, if the the execution should stop afterwards, and false if the execution may continue.

Parameters:
Name Type Description
$options array
&$options array
Redefinition of:
Method Description
arbitFrameworkCliTool::processDefaultOptions() Process default options Handle the default options. stop afterwards, and false if the execution may continue.

registerDefaultOptions

void registerDefaultOptions( )

Register options Register a set of options, which are special for this CLI tool. left empty, if no additional options are required.

Register options Register a set of options, which are special for this CLI tool. May be left empty, if no additional options are required.

Redefinition of:
Method Description
arbitFrameworkCliTool::registerDefaultOptions() Register default options Register a set of default options, each arbit CLI tool should always implement.
Documentation generated on Mon, 05 Apr 2010 14:01:27 +0200 by phpDocumentor 1.4.3

Arbit - project tracking, licensed under GPL 3