class Route implements IteratorAggregate (View source)

Class Route

Properties

array $requirements Property requirements.

Methods

__construct(string $name, string $pattern, array $variables = array(), array|string $allowMethods = array(), array $options = array())

Class init.

string
getPattern()

getPattern

setPattern(string $pattern)

setPattern

string
getRegex()

getRegex

setRegex(string $regex)

setRegex

string
getAllowMethods()

getMethod

setAllowMethods(array|string $methods)

setMethod

array
getVariables()

getVariables

setVariables(array $variables)

setVariables

string
getName()

getName

setName(string $name)

setName

array
getOptions()

Method to get property Options

setOptions(array $options)

Method to set property options

array
prepareOptions(array $options)

prepareOptions

mixed
getOption(string $name, mixed $default = null)

Method to get property Options

setOption(string $name, mixed $value)

Method to set property options

int
getSslPort()

Method to get property SslPort

setSslPort(int $sslPort)

Method to set property sslPort

int
getPort()

Method to get property Port

setPort(int $port)

Method to set property port

string
getScheme()

Method to get property Scheme

setScheme(string $scheme)

Method to set property scheme

string
getHost()

Method to get property Host

setHost(string $host)

Method to set property host

array
getRequirements()

Method to get property Requirements

setRequirements(array $requirements)

Method to set property requirements

boolean
getSSL()

Method to get property Ssl

setSSL(boolean $ssl)

Method to set property ssl

array
getExtraValues()

Method to get property Extra

setExtraValues(array $extra)

Method to set property extra

mixed
getExtra(string $name, mixed $default = null)

getExtra

setExtra(string $name, mixed $value)

setExtra

getIterator()

Retrieve an external iterator

array
getAllData()

getAllData

Details

at line line 118
__construct(string $name, string $pattern, array $variables = array(), array|string $allowMethods = array(), array $options = array())

Class init.

Parameters

string $name
string $pattern
array $variables
array|string $allowMethods
array $options

at line line 133
string getPattern()

getPattern

Return Value

string

at line line 145
Route setPattern(string $pattern)

setPattern

Parameters

string $pattern

Return Value

Route Return self to support chaining.

at line line 157
string getRegex()

getRegex

Return Value

string

at line line 169
Route setRegex(string $regex)

setRegex

Parameters

string $regex

Return Value

Route Return self to support chaining.

at line line 181
string getAllowMethods()

getMethod

Return Value

string

at line line 193
Route setAllowMethods(array|string $methods)

setMethod

Parameters

array|string $methods

Return Value

Route Return self to support chaining.

at line line 209
array getVariables()

getVariables

Return Value

array

at line line 221
Route setVariables(array $variables)

setVariables

Parameters

array $variables

Return Value

Route Return self to support chaining.

at line line 233
string getName()

getName

Return Value

string

at line line 245
Route setName(string $name)

setName

Parameters

string $name

Return Value

Route Return self to support chaining.

at line line 257
array getOptions()

Method to get property Options

Return Value

array

at line line 269
Route setOptions(array $options)

Method to set property options

Parameters

array $options

Return Value

Route Return self to support chaining.

at line line 290
array prepareOptions(array $options)

prepareOptions

Parameters

array $options

Return Value

array

at line line 313
mixed getOption(string $name, mixed $default = null)

Method to get property Options

Parameters

string $name
mixed $default

Return Value

mixed

at line line 331
Route setOption(string $name, mixed $value)

Method to set property options

Parameters

string $name
mixed $value

Return Value

Route Return self to support chaining.

at line line 343
int getSslPort()

Method to get property SslPort

Return Value

int

at line line 355
Route setSslPort(int $sslPort)

Method to set property sslPort

Parameters

int $sslPort

Return Value

Route Return self to support chaining.

at line line 367
int getPort()

Method to get property Port

Return Value

int

at line line 379
Route setPort(int $port)

Method to set property port

Parameters

int $port

Return Value

Route Return self to support chaining.

at line line 391
string getScheme()

Method to get property Scheme

Return Value

string

at line line 403
Route setScheme(string $scheme)

Method to set property scheme

Parameters

string $scheme

Return Value

Route Return self to support chaining.

at line line 417
string getHost()

Method to get property Host

Return Value

string

at line line 429
Route setHost(string $host)

Method to set property host

Parameters

string $host

Return Value

Route Return self to support chaining.

at line line 441
array getRequirements()

Method to get property Requirements

Return Value

array

at line line 453
Route setRequirements(array $requirements)

Method to set property requirements

Parameters

array $requirements

Return Value

Route Return self to support chaining.

at line line 465
boolean getSSL()

Method to get property Ssl

Return Value

boolean

at line line 477
Route setSSL(boolean $ssl)

Method to set property ssl

Parameters

boolean $ssl

Return Value

Route Return self to support chaining.

at line line 489
array getExtraValues()

Method to get property Extra

Return Value

array

at line line 501
Route setExtraValues(array $extra)

Method to set property extra

Parameters

array $extra

Return Value

Route Return self to support chaining.

at line line 516
mixed getExtra(string $name, mixed $default = null)

getExtra

Parameters

string $name
mixed $default

Return Value

mixed

at line line 534
Route setExtra(string $name, mixed $value)

setExtra

Parameters

string $name
mixed $value

Return Value

Route

at line line 546
Traversable getIterator()

Retrieve an external iterator

Return Value

Traversable An instance of an object implementing Iterator or Traversable

at line line 556
array getAllData()

getAllData

Return Value

array