PHP Class Neos\Flow\Mvc\Routing\AbstractRoutePart

Inheritance: implements Neos\Flow\Mvc\Routing\RoutePartInterface

Show file Open project: neos/flow-development-collection

Protected Properties

Property	Type	Description
$defaultValue	mixed	Default value of the Route Part.
$isOptional	boolean	Specifies whether this Route Part is optional. Which means it's put in parentheses in the routes URI pattern.
$lowerCase	boolean	Specifies whether this Route Part should be converted to lower case when resolved.
$name	string	Name of the Route Part
$options	array	Contains options for this Route Part.
$value	mixed	Value of the Route Part after decoding.

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	Getter for $this->isOptional.
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

Getter for $this->isOptional.

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 sensivity.

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

Property Details

$defaultValue protected property

Default value of the Route Part.

protected mixed $defaultValue
return	mixed

$isOptional protected property

Specifies whether this Route Part is optional. Which means it's put in parentheses in the routes URI pattern.

protected bool $isOptional
return	boolean

$lowerCase protected property

Specifies whether this Route Part should be converted to lower case when resolved.

protected bool $lowerCase
return	boolean

$name protected property

Name of the Route Part

protected string $name
return	string

$options protected property

Contains options for this Route Part.

protected array $options
return	array

$value protected property

Value of the Route Part after decoding.

protected mixed $value
return	mixed

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.