helpCtrl
extends jControllerCmdLine
in package
a base class for controllers used in command line application
Tags
Table of Contents
- $help : array<string|int, mixed>
- help for each action it should be an array('method'=>'help',...);
- $pluginParams : array<string|int, mixed>
- parameters for plugins of the coordinator
- $sensitiveParameters : array<string|int, string>
- sensitive parameters
- $_options : array<string|int, mixed>
- founded options
- $_parameters : array<string|int, mixed>
- founded parameters
- $allowed_options : array<string|int, mixed>
- allowed options
- $allowed_parameters : array<string|int, mixed>
- allowed parameters
- $request : jRequest
- the request object
- __construct() : mixed
- index() : mixed
- boolParam() : bool
- same as param(), but convert the value to a boolean value. If it isn't a numerical value, return null.
- floatParam() : float
- same as param(), but convert the value to a float value. If it isn't a numerical value, return null.
- getResponse() : jResponse|jResponseHtml|jResponseRedirect|jResponseJson
- get a response object.
- intParam() : int
- same as param(), but convert the value to an integer value. If it isn't a numerical value, return null.
- option() : mixed
- param() : mixed
- Gets the value of a request parameter. If not defined, gets its default value.
- params() : array<string|int, mixed>
Properties
$help
help for each action it should be an array('method'=>'help',...);
public
array<string|int, mixed>
$help
= array()
$pluginParams
parameters for plugins of the coordinator
public
array<string|int, mixed>
$pluginParams
= array()
this array should contains all parameters needed by installed plugins for each action, see the documentation of each plugins to know this parameters. keys : name of an action or * for parameters to all action values : array that contains all plugin parameters
$sensitiveParameters
sensitive parameters
public
array<string|int, string>
$sensitiveParameters
= array()
List of names of parameters that can have sensitive values like password etc. This list is used by the logger for example, to replace values by a dummy value. See also sensitiveParameters into error_handling section of the configuration.
Tags
$_options
founded options
protected
array<string|int, mixed>
$_options
Tags
$_parameters
founded parameters
protected
array<string|int, mixed>
$_parameters
Tags
$allowed_options
allowed options
protected
array<string|int, mixed>
$allowed_options
= array('index' => array())
$allowed_parameters
allowed parameters
protected
array<string|int, mixed>
$allowed_parameters
= array('index' => array('cmd_name' => alse))
$request
the request object
protected
jRequest
$request
Methods
__construct()
public
__construct(jRequest $request) : mixed
Parameters
- $request : jRequest
-
the current request object
Return values
mixed —index()
public
index() : mixed
Return values
mixed —boolParam()
same as param(), but convert the value to a boolean value. If it isn't a numerical value, return null.
protected
boolParam(string $parName[, mixed $parDefaultValue = null ][, bool $useDefaultIfEmpty = false ]) : bool
Parameters
- $parName : string
-
the name of the request parameter
- $parDefaultValue : mixed = null
-
the default returned value if the parameter doesn't exists
- $useDefaultIfEmpty : bool = false
-
true: says to return the default value the value is ""
Return values
bool —the request parameter value
floatParam()
same as param(), but convert the value to a float value. If it isn't a numerical value, return null.
protected
floatParam(string $parName[, mixed $parDefaultValue = null ][, bool $useDefaultIfEmpty = false ]) : float
Parameters
- $parName : string
-
the name of the request parameter
- $parDefaultValue : mixed = null
-
the default returned value if the parameter doesn't exists
- $useDefaultIfEmpty : bool = false
-
true: says to return the default value the value is ""
Return values
float —the request parameter value
getResponse()
get a response object.
protected
getResponse([string $name = '' ][, bool $useOriginal = false ]) : jResponse|jResponseHtml|jResponseRedirect|jResponseJson
Parameters
- $name : string = ''
-
the name of the response type (ex: "html")
- $useOriginal : bool = false
-
true:don't use the response object redefined by the application
Return values
jResponse|jResponseHtml|jResponseRedirect|jResponseJson —the response object
intParam()
same as param(), but convert the value to an integer value. If it isn't a numerical value, return null.
protected
intParam(string $parName[, mixed $parDefaultValue = null ][, bool $useDefaultIfEmpty = false ]) : int
Parameters
- $parName : string
-
the name of the request parameter
- $parDefaultValue : mixed = null
-
the default returned value if the parameter doesn't exists
- $useDefaultIfEmpty : bool = false
-
true: says to return the default value the value is ""
Return values
int —the request parameter value
option()
protected
option(mixed $name) : mixed
Parameters
- $name : mixed
Return values
mixed —param()
Gets the value of a request parameter. If not defined, gets its default value.
protected
param(string $parName[, mixed $parDefaultValue = null ][, bool $useDefaultIfEmpty = false ]) : mixed
Parameters
- $parName : string
-
the name of the request parameter
- $parDefaultValue : mixed = null
-
the default returned value if the parameter doesn't exists
- $useDefaultIfEmpty : bool = false
-
true: says to return the default value if the parameter value is ""
Return values
mixed —the request parameter value
params()
protected
params() : array<string|int, mixed>
Return values
array<string|int, mixed> —all request parameters