Arbit - project tracking

Arbit - project tracking

API documentation :: Docs For Class arbitFrameworkAdminCliTool

Packages:

Interfaces:

Classes:

Core::arbitFrameworkAdminCliTool

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

Class arbitFrameworkAdminCliTool

CLI tool class, which handles various adimistrative tasks.

CLI tool class, which handles various adimistrative tasks.

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

Member Variables

protected array $actions = array(
'clear-cache' => array(
'action' => 'clearCache',
'description' => 'Clear caches',
),'list-caches'=>array('action'=>'listCaches','description'=>'List available cache types. Might depend on the specfied projects.',),'verify'=>array('action'=>'verifyBackend','description'=>'Verify the integrity of the used storage backend.',),'validate-user'=>array('action'=>'validateUser','description'=>'Validate the user the command is run for.',),)
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.   )
protected string $description = "Arbit administration tool, able to perform different administrative actions, like cache clearing, cache priming and similar.\n\nThe available actions are:"
Short description of the purpose of the current CLI tool

Short description of the purpose of the current CLI tool
protected string $name = 'Arbit administration tool'
Name of CLI tool

Name of CLI tool

Inherited Member Variables

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

Method Summary

protected arbitController createController( $request , $options )
Get controller
protected void registerOptions( )
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 arbitFrameworkActionCliTool
protected bool arbitFrameworkActionCliTool::processDefaultOptions()
Process default options Handle the default options. stop afterwards, and false if the execution may continue.
protected void arbitFrameworkActionCliTool::registerDefaultOptions()
Register options Register a set of options, which are special for this CLI tool. left empty, if no additional options are required.
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

createController

arbitController createController( arbitRequest $request , $options )

Get controller

Get controller Return controller to execute for the current command

Parameters:
Name Type Description
$request arbitRequest
$options array
Redefinition of:
Method Description
arbitFrameworkCliTool::createController() Get controller

registerOptions

void registerOptions( )

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::registerOptions() Register options Register a set of options, which are special for this CLI tool. left empty, if no additional options are required.
Documentation generated on Mon, 05 Apr 2010 14:01:28 +0200 by phpDocumentor 1.4.3

Arbit - project tracking, licensed under GPL 3