HttpRoute
in package
implements
Route
Class HttpRoute
Tags
Interfaces, Classes and Traits
- Route
- Interface Route
Table of Contents
- $internal : RouteInterface
- __construct() : mixed
- HttpRoute constructor.
- 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
Properties
$internal
private
RouteInterface
$internal
Methods
__construct()
HttpRoute constructor.
public
__construct(RouteInterface $internal) : mixed
Parameters
- $internal : RouteInterface
Return values
mixed —addMiddleware()
public
addMiddleware(MiddlewareInterface $middleware) : self
Parameters
- $middleware : MiddlewareInterface
Tags
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
Tags
Return values
string|null —getArguments()
Get route arguments
public
getArguments() : array<string|int, string>
Tags
Return values
array<string|int, string> —getCallable()
Get route callable
public
getCallable() : callable|string
Tags
Return values
callable|string —getName()
Get route name
public
getName() : null|string
Tags
Return values
null|string —getPattern()
Get route pattern
public
getPattern() : string
Tags
Return values
string —setArgument()
Set a route argument
public
setArgument(string $name, string $value) : self
Parameters
- $name : string
- $value : string
Tags
Return values
self —setArguments()
Replace route arguments
public
setArguments(array<string|int, mixed> $arguments) : self
Parameters
- $arguments : array<string|int, mixed>
Tags
Return values
self —setCallable()
Set route callable
public
setCallable(mixed $callable) : self
Parameters
- $callable : mixed
Tags
Return values
self —setName()
Set route name
public
setName(string $name) : self
Parameters
- $name : string