PHP Класс ZF\Console\Route

Наследование: extends Zend\Console\RouteMatcher\DefaultRouteMatcher
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$description string
$matches null | array
$name string
$optionsDescription array
$route string
$shortDescription string

Открытые методы

Метод Описание
__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

Описание методов

__construct() публичный Метод

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 getDescription ( ) : string
Результат string

getMatchedParam() публичный Метод

Retrieve a matched parameter
public getMatchedParam ( string $param, mixed $default = null ) : mixed
$param string
$default mixed
Результат mixed

getMatches() публичный Метод

public getMatches ( ) : null | array
Результат null | array

getName() публичный Метод

public getName ( ) : string
Результат string

getOptionsDescription() публичный Метод

public getOptionsDescription ( ) : array
Результат array

getRoute() публичный Метод

public getRoute ( ) : string
Результат string

getShortDescription() публичный Метод

public getShortDescription ( ) : string
Результат string

isMatched() публичный Метод

public isMatched ( ) : boolean
Результат boolean

match() публичный Метод

If matched, set the matches in the route
public match ( array $params ) : array | null
$params array
Результат array | null

matchedParam() публичный Метод

Was the parameter matched?
public matchedParam ( string $param ) : boolean
$param string
Результат boolean

setDescription() публичный Метод

public setDescription ( string $description ) : self
$description string
Результат self

setOptionsDescription() публичный Метод

public setOptionsDescription ( array $descriptions ) : self
$descriptions array
Результат self

setShortDescription() публичный Метод

public setShortDescription ( string $description ) : self
$description string
Результат self

Описание свойств

$description защищенное свойство

protected string $description
Результат string

$matches защищенное свойство

protected null|array $matches
Результат null | array

$name защищенное свойство

protected string $name
Результат string

$optionsDescription защищенное свойство

protected array $optionsDescription
Результат array

$route защищенное свойство

protected string $route
Результат string

$shortDescription защищенное свойство

protected string $shortDescription
Результат string