PHP Class Redaxscript\Console\Parser

Since: 3.0.0
Author: Henry Ruhs
Afficher le fichier Open project: redaxmedia/redaxscript Class Usage Examples

Protected Properties

Свойство Type Description
$_argumentArray array array of parsed arguments
$_optionArray array array of parsed options
$_request object instance of the request class

Méthodes publiques

Méthode Description
__construct ( Request $request ) constructor of the class
getArgument ( string $key = null ) : mixed get item from arguments
getOption ( string $key = null ) : mixed get item from options
init ( string $mode = null ) init the class
setArgument ( string $key = null, mixed $value = null ) set item to arguments
setOption ( string $key = null, mixed $value = null ) set item to options

Méthodes protégées

Méthode Description
_parseArgument ( array $argumentArray = [] ) parse raw argument
_parseOption ( string $option = null, string $next = null, integer $offset = null ) : boolean parse raw option

Method Details

__construct() public méthode

constructor of the class
Since: 3.0.0
public __construct ( Request $request )
$request Redaxscript\Request instance of the request class

_parseArgument() protected méthode

parse raw argument
Since: 3.0.0
protected _parseArgument ( array $argumentArray = [] )
$argumentArray array raw argument to be parsed

_parseOption() protected méthode

parse raw option
Since: 3.0.0
protected _parseOption ( string $option = null, string $next = null, integer $offset = null ) : boolean
$option string raw option to be parsed
$next string raw next to be parsed
$offset integer offset of the raw option
Résultat boolean

getArgument() public méthode

get item from arguments
Since: 3.0.0
public getArgument ( string $key = null ) : mixed
$key string key of the item
Résultat mixed

getOption() public méthode

get item from options
Since: 3.0.0
public getOption ( string $key = null ) : mixed
$key string key of the item
Résultat mixed

init() public méthode

init the class
Since: 3.0.0
public init ( string $mode = null )
$mode string name of the mode

setArgument() public méthode

set item to arguments
Since: 3.0.0
public setArgument ( string $key = null, mixed $value = null )
$key string key of the item
$value mixed value of the item

setOption() public méthode

set item to options
Since: 3.0.0
public setOption ( string $key = null, mixed $value = null )
$key string key of the item
$value mixed value of the item

Property Details

$_argumentArray protected_oe property

array of parsed arguments
protected array $_argumentArray
Résultat array

$_optionArray protected_oe property

array of parsed options
protected array $_optionArray
Résultat array

$_request protected_oe property

instance of the request class
protected object $_request
Résultat object