Class jControllerCmdLine

Description
Description | Descendents | Vars (details) | Methods (details)

a base class for controllers used in command line application

  • since: 1.0a3

Located in /controllers/jControllerCmdLine.class.php (line 19) 

jController
   |
   --jControllerCmdLine
Direct descendents
Description | Descendents | Vars (details) | Methods (details)
Class Description
helpCtrl
Variable Summary
Description | Descendents | Vars (details) | Methods (details)
array $allowed_options
array $allowed_parameters
array $help
array $_options
array $_parameters
Method Summary
Description | Descendents | Vars (details) | Methods (details)
jControllerCmdLine __construct (jRequest $request)
void option ( $name)
void param ( $parName, [ $parDefaultValue = null], [ $useDefaultIfEmpty = false])
Variables
Description | Descendents | Vars (details) | Methods (details)
array $allowed_options (line 32)

allowed options

  • see: jCmdUtils::getOptionsAndParams
  • access: protected
Redefined in descendants as:
array $allowed_parameters (line 39)

allowed parameters

  • see: jCmdUtils::getOptionsAndParams
  • access: protected
Redefined in descendants as:
array $help = array() (line 25)

help for each action

it should be an array('method'=>'help',...);

  • access: public
array $_options (line 46)

founded options

  • see: jCmdUtils::getOptionsAndParams
  • access: protected
array $_parameters (line 53)

founded parameters

  • see: jCmdUtils::getOptionsAndParams
  • access: protected

Inherited Variables

Inherited from jController

jController::$pluginParams
 jController::$request
Methods
Description | Descendents | Vars (details) Methods (details)
Constructor __construct (line 59)
jControllerCmdLine __construct (jRequest $request)
Redefinition of:
jController::__construct()
option (line 91)
  • access: protected
void option ( $name)
  • $name
param (line 80)
  • access: protected
void param ( $parName, [ $parDefaultValue = null], [ $useDefaultIfEmpty = false])
  • $parName
  • $parDefaultValue
  • $useDefaultIfEmpty
Redefinition of:
jController::param()
Gets the value of a request parameter. If not defined, gets its default value.

Inherited Methods

Inherited From jController

jController::__construct()
jController::boolParam()
jController::floatParam()
jController::getResponse()
jController::intParam()
jController::param()
jController::params()
jController::processZone()

Documentation generated on Thu, 22 Mar 2012 22:14:17 +0100 by phpDocumentor 1.4.3