PHP Class ZF\Console\Route

Inheritance: extends Zend\Console\RouteMatcher\DefaultRouteMatcher
Afficher le fichier Open project: zfcampus/zf-console Class Usage Examples

Protected Properties

Свойство Type Description
$description string
$matches null | array
$name string
$optionsDescription array
$route string
$shortDescription string

Méthodes publiques

Méthode Description
__construct ( string $name, string $route, array $constraints = [], array $defaults = [], array $aliases = [], array $filters = null, array $validators = null )
getDescription ( ) : string
getMatchedParam ( string $param, mixed $default = null ) : mixed Retrieve a matched parameter
getMatches ( ) : null | array
getName ( ) : string
getOptionsDescription ( ) : array
getRoute ( ) : string
getShortDescription ( ) : string
isMatched ( ) : boolean
match ( array $params ) : array | null Override match()
matchedParam ( string $param ) : boolean Was the parameter matched?
setDescription ( string $description ) : self
setOptionsDescription ( array $descriptions ) : self
setShortDescription ( string $description ) : self

Method Details

__construct() public méthode

public __construct ( string $name, string $route, array $constraints = [], array $defaults = [], array $aliases = [], array $filters = null, array $validators = null )
$name string
$route string Route string to match
$constraints array Argument constraints (optional)
$defaults array Argument default values (optional)
$aliases array
$filters array Filters to use for specific arguments (optional)
$validators array Filters to use for specific arguments (optional)

getDescription() public méthode

public getDescription ( ) : string
Résultat string

getMatchedParam() public méthode

Retrieve a matched parameter
public getMatchedParam ( string $param, mixed $default = null ) : mixed
$param string
$default mixed
Résultat mixed

getMatches() public méthode

public getMatches ( ) : null | array
Résultat null | array

getName() public méthode

public getName ( ) : string
Résultat string

getOptionsDescription() public méthode

public getOptionsDescription ( ) : array
Résultat array

getRoute() public méthode

public getRoute ( ) : string
Résultat string

getShortDescription() public méthode

public getShortDescription ( ) : string
Résultat string

isMatched() public méthode

public isMatched ( ) : boolean
Résultat boolean

match() public méthode

If matched, set the matches in the route
public match ( array $params ) : array | null
$params array
Résultat array | null

matchedParam() public méthode

Was the parameter matched?
public matchedParam ( string $param ) : boolean
$param string
Résultat boolean

setDescription() public méthode

public setDescription ( string $description ) : self
$description string
Résultat self

setOptionsDescription() public méthode

public setOptionsDescription ( array $descriptions ) : self
$descriptions array
Résultat self

setShortDescription() public méthode

public setShortDescription ( string $description ) : self
$description string
Résultat self

Property Details

$description protected_oe property

protected string $description
Résultat string

$matches protected_oe property

protected null|array $matches
Résultat null | array

$name protected_oe property

protected string $name
Résultat string

$optionsDescription protected_oe property

protected array $optionsDescription
Résultat array

$route protected_oe property

protected string $route
Résultat string

$shortDescription protected_oe property

protected string $shortDescription
Résultat string