phpDocumentor

Route

Interface Route

Table of Contents

addMiddleware()  : self
getArgument()  : string|null
Retrieve a specific route argument
getArguments()  : array<string|int, string>
Get route arguments
getCallable()  : callable|string
Get route callable
getName()  : null|string
Get route name
getPattern()  : string
Get route pattern
setArgument()  : self
Set a route argument
setArguments()  : self
Replace route arguments
setCallable()  : self
Set route callable
setName()  : self
Set route name

Methods

addMiddleware()

public addMiddleware(MiddlewareInterface $middleware) : self
Parameters
$middleware : MiddlewareInterface
Return values
self

getArgument()

Retrieve a specific route argument

public getArgument(string $name[, string|null $default = null ]) : string|null
Parameters
$name : string
$default : string|null = null
Return values
string|null

getArguments()

Get route arguments

public getArguments() : array<string|int, string>
Return values
array<string|int, string>

getCallable()

Get route callable

public getCallable() : callable|string
Return values
callable|string

getName()

Get route name

public getName() : null|string
Return values
null|string

getPattern()

Get route pattern

public getPattern() : string
Return values
string

setArgument()

Set a route argument

public setArgument(string $name, string $value) : self
Parameters
$name : string
$value : string
Return values
self

setArguments()

Replace route arguments

public setArguments(array<string|int, string> $arguments) : self
Parameters
$arguments : array<string|int, string>
Return values
self

setCallable()

Set route callable

public setCallable(callable|string $callable) : self
Parameters
$callable : callable|string
Return values
self

setName()

Set route name

public setName(string $name) : self
Parameters
$name : string
Return values
self

Search results