PHP Class Jarves\Configuration\Route

Inheritance: extends Model
Datei anzeigen Open project: jarves/jarves Class Usage Examples

Protected Properties

Property Type Description
$attributes
$controller string Overwrites the controller for this route. Per default the controller of the plugin is used.
$defaults RouteDefault[]
$elementToArray
$id string
$methods string[] Per default all methods are allowed. Use 'GET', 'POST', or 'GET|POST' to limit it.
$pattern string
$requirements RouteRequirement[]

Public Methods

Method Description
addDefault ( RouteDefault $default = null )
addRequirement ( RouteRequirement $requirement = null )
getArrayDefaults ( ) : array
getArrayRequirements ( ) : array
getController ( ) : string
getDefault ( string $key ) : RouteDefault
getDefaultValue ( string $key ) : string
getDefaults ( ) : RouteDefault[]
getId ( ) : string
getMethods ( ) : string[]
getPattern ( ) : string
getRequirements ( ) : RouteRequirement[]
setController ( string $controller )
setDefaults ( array $defaults = null )
setId ( string $id )
setMethods ( string[] $methods )
setPattern ( string $pattern )
setRequirements ( array $requirements = null )

Method Details

addDefault() public method

public addDefault ( RouteDefault $default = null )
$default RouteDefault

addRequirement() public method

public addRequirement ( RouteRequirement $requirement = null )
$requirement RouteRequirement

getArrayDefaults() public method

public getArrayDefaults ( ) : array
return array

getArrayRequirements() public method

public getArrayRequirements ( ) : array
return array

getController() public method

public getController ( ) : string
return string

getDefault() public method

public getDefault ( string $key ) : RouteDefault
$key string
return RouteDefault

getDefaultValue() public method

public getDefaultValue ( string $key ) : string
$key string
return string

getDefaults() public method

public getDefaults ( ) : RouteDefault[]
return RouteDefault[]

getId() public method

public getId ( ) : string
return string

getMethods() public method

public getMethods ( ) : string[]
return string[]

getPattern() public method

public getPattern ( ) : string
return string

getRequirements() public method

public getRequirements ( ) : RouteRequirement[]
return RouteRequirement[]

setController() public method

public setController ( string $controller )
$controller string

setDefaults() public method

public setDefaults ( array $defaults = null )
$defaults array

setId() public method

public setId ( string $id )
$id string

setMethods() public method

public setMethods ( string[] $methods )
$methods string[]

setPattern() public method

public setPattern ( string $pattern )
$pattern string

setRequirements() public method

public setRequirements ( array $requirements = null )
$requirements array

Property Details

$attributes protected_oe property

protected $attributes

$controller protected_oe property

Overwrites the controller for this route. Per default the controller of the plugin is used.
protected string $controller
return string

$defaults protected_oe property

protected RouteDefault[],Jarves\Configuration $defaults
return RouteDefault[]

$elementToArray protected_oe property

protected $elementToArray

$id protected_oe property

protected string $id
return string

$methods protected_oe property

Per default all methods are allowed. Use 'GET', 'POST', or 'GET|POST' to limit it.
protected string[] $methods
return string[]

$pattern protected_oe property

protected string $pattern
return string

$requirements protected_oe property

protected RouteRequirement[],Jarves\Configuration $requirements
return RouteRequirement[]