PHP Interface 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.

Datei anzeigen Open project: neos/flow-development-collection

Public Methods

Method	Description
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.

Method Details

getDefaultValue() public method

Gets default value of the Route Part.

public getDefaultValue ( ) : mixed
return	mixed	$defaultValue

getName() public method

Returns name of the Route Part.

public getName ( ) : string
return	string

getOptions() public method

public getOptions ( ) : array
return	array	options of this Route Part.

getValue() public method

Returns value of the Route Part. Before match() is called this returns NULL.

public getValue ( ) : mixed
return	mixed

hasDefaultValue() public method

Returns TRUE if a default value is set for this Route Part, otherwise FALSE.

public hasDefaultValue ( ) : boolean
return	boolean

hasValue() public method

Returns TRUE if a value is set for this Route Part, otherwise FALSE.

public hasValue ( ) : boolean
return	boolean

isLowerCase() public method

Getter for $this->lowerCase.

isOptional() public method

match() public method

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
return	boolean	TRUE if Route Part matched $routePath, otherwise FALSE.

resolve() public method

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
return	boolean	TRUE if Route Part can resolve one or more $routeValues elements, otherwise FALSE.

setDefaultValue() public method

Sets default value of the Route Part.

public setDefaultValue ( mixed $defaultValue ) : void
$defaultValue	mixed
return	void

setLowerCase() public method

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.
return	void

setName() public method

Sets name of the Route Part.

public setName ( string $partName ) : void
$partName	string
return	void

setOptional() public method

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.
return	void

setOptions() public method

Options can be used to enrich a route part with parameters or settings like case sensivitity.

public setOptions ( array $options ) : void
$options	array
return	void

public isLowerCase ( ) : boolean
return	boolean	TRUE if this Route part will be converted to lower case, otherwise FALSE.

public isOptional ( ) : boolean
return	boolean	TRUE if this Route part is optional, otherwise FALSE.