Arbit - project tracking

Arbit - project tracking

API documentation :: Docs For Class arbitFrameworkCronCliTool

Packages:

Interfaces:

Classes:

Core::arbitFrameworkCronCliTool

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

Class arbitFrameworkCronCliTool

CLI tool class, which handles cron tasks

CLI tool class, which handles cron tasks

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

Member Variables

protected array $actions = array(
'execute' => array(
'action' => 'execute',
'description' => 'Execute all pending cron tasks',
),)
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 cron tool, which triggers and monitors the execution of periodic tasks."
Short description of the purpose of the current CLI tool

Short description of the purpose of the current CLI tool
protected string $name = 'Arbit cron 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

public void __construct( )
Create cli tool and configure basic in and out handling
protected arbitController createController( $request , $options )
Get controller

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

__construct

void __construct( )

Create cli tool and configure basic in and out handling

Create cli tool and configure basic in and out handling

Redefinition of:
Method Description
arbitFrameworkCliTool::__construct() Create cli tool and configure basic in and out handling

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
Documentation generated on Mon, 05 Apr 2010 14:01:46 +0200 by phpDocumentor 1.4.3

Arbit - project tracking, licensed under GPL 3