PHP Интерфейс Neos\Flow\Mvc\Routing\RoutePartInterface

!!! Warning: If you write your own RoutePart handler which does some queries to the persistence layer, be aware that *permission checks* are not yet done, i.e. you get back *all* objects, not just the objects visible to the current role.
Показать файл Открыть проект

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

Метод Описание
getDefaultValue ( ) : mixed Gets default value of the Route Part.
getName ( ) : string Returns name of the Route Part.
getOptions ( ) : array
getValue ( ) : mixed Returns value of the Route Part. Before match() is called this returns NULL.
hasDefaultValue ( ) : boolean Returns TRUE if a default value is set for this Route Part, otherwise FALSE.
hasValue ( ) : boolean Returns TRUE if a value is set for this Route Part, otherwise FALSE.
isLowerCase ( ) : boolean Getter for $this->lowerCase.
isOptional ( ) : boolean
match ( &$routePath ) : boolean Checks whether this Route Part corresponds to the given $routePath.
resolve ( array &$routeValues ) : boolean Checks whether this Route Part corresponds to the given $routeValues.
setDefaultValue ( mixed $defaultValue ) : void Sets default value of the Route Part.
setLowerCase ( boolean $lowerCase ) : void Specifies whether this Route part should be converted to lower case when resolved.
setName ( string $partName ) : void Sets name of the Route Part.
setOptional ( boolean $isOptional ) : void Specifies whether this Route part is optional.
setOptions ( array $options ) : void Defines options for this Route Part.

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

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

Gets default value of the Route Part.
public getDefaultValue ( ) : mixed
Результат mixed $defaultValue

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

Returns name of the Route Part.
public getName ( ) : string
Результат string

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

public getOptions ( ) : array
Результат array options of this Route Part.

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

Returns value of the Route Part. Before match() is called this returns NULL.
public getValue ( ) : mixed
Результат mixed

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

Returns TRUE if a default value is set for this Route Part, otherwise FALSE.
public hasDefaultValue ( ) : boolean
Результат boolean

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

Returns TRUE if a value is set for this Route Part, otherwise FALSE.
public hasValue ( ) : boolean
Результат boolean

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

Getter for $this->lowerCase.
См. также: setLowerCase()
public isLowerCase ( ) : boolean
Результат boolean TRUE if this Route part will be converted to lower case, otherwise FALSE.

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

См. также: setOptional()
public isOptional ( ) : boolean
Результат boolean TRUE if this Route part is optional, otherwise FALSE.

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

This method does not only check if the Route Part matches. It can also shorten the $routePath by the matching substring when matching is successful. This is why $routePath has to be passed by reference.
public match ( &$routePath ) : boolean
Результат boolean TRUE if Route Part matched $routePath, otherwise FALSE.

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

This method does not only check if the Route Part matches. It also removes resolved elements from $routeValues-Array. This is why $routeValues has to be passed by reference.
public resolve ( array &$routeValues ) : boolean
$routeValues array
Результат boolean TRUE if Route Part can resolve one or more $routeValues elements, otherwise FALSE.

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

Sets default value of the Route Part.
public setDefaultValue ( mixed $defaultValue ) : void
$defaultValue mixed
Результат void

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

Specifies whether this Route part should be converted to lower case when resolved.
public setLowerCase ( boolean $lowerCase ) : void
$lowerCase boolean TRUE: this Route part is converted to lower case. FALSE: this Route part is not altered.
Результат void

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

Sets name of the Route Part.
public setName ( string $partName ) : void
$partName string
Результат void

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

Specifies whether this Route part is optional.
public setOptional ( boolean $isOptional ) : void
$isOptional boolean TRUE: this Route part is optional. FALSE: this Route part is required.
Результат void

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

Options can be used to enrich a route part with parameters or settings like case sensivitity.
public setOptions ( array $options ) : void
$options array
Результат void