RouteRegistrar
class RouteRegistrar (View source)
Traits
Properties
| protected Router | $router | The router instance. |
|
| protected array | $attributes | The attributes to pass on to the router. |
|
| protected string[] | $passthru | The methods to dynamically pass through to the router. |
|
| protected string[] | $allowedAttributes | The attributes that can be set through this class. |
|
| protected array | $aliases | The attributes that are aliased. |
Methods
Specify that the given route parameters must be alphabetic.
Specify that the given route parameters must be alphanumeric.
Specify that the given route parameters must be numeric.
Specify that the given route parameters must be ULIDs.
Specify that the given route parameters must be UUIDs.
Specify that the given route parameters must be one of the given values.
Apply the given regular expression to the given parameters.
Set the value for a given attribute.
Route a resource to a controller.
Route an API resource to a controller.
Route a singleton resource to a controller.
Route an API singleton resource to a controller.
Register a new route with the router.
Compile the action into an array including the attributes.
Dynamically handle calls into the route registrar.
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
Details
$this
whereAlpha(array|string $parameters)
Specify that the given route parameters must be alphabetic.
$this
whereAlphaNumeric(array|string $parameters)
Specify that the given route parameters must be alphanumeric.
$this
whereNumber(array|string $parameters)
Specify that the given route parameters must be numeric.
$this
whereUlid(array|string $parameters)
Specify that the given route parameters must be ULIDs.
$this
whereUuid(array|string $parameters)
Specify that the given route parameters must be UUIDs.
$this
whereIn(array|string $parameters, array $values)
Specify that the given route parameters must be one of the given values.
protected $this
assignExpressionToParameters(array|string $parameters, string $expression)
Apply the given regular expression to the given parameters.
void
__construct(Router $router)
Create a new route registrar instance.
$this
attribute(string $key, mixed $value)
Set the value for a given attribute.
PendingResourceRegistration
resource(string $name, string $controller, array $options = [])
Route a resource to a controller.
PendingResourceRegistration
apiResource(string $name, string $controller, array $options = [])
Route an API resource to a controller.
PendingSingletonResourceRegistration
singleton(string $name, string $controller, array $options = [])
Route a singleton resource to a controller.
PendingSingletonResourceRegistration
apiSingleton(string $name, string $controller, array $options = [])
Route an API singleton resource to a controller.
$this
group(Closure|array|string $callback)
Create a route group with shared attributes.
Route
match(array|string $methods, string $uri, Closure|array|string|null $action = null)
Register a new route with the given verbs.
protected Route
registerRoute(string $method, string $uri, Closure|array|string|null $action = null)
Register a new route with the router.
protected array
compileAction(Closure|array|string|null $action)
Compile the action into an array including the attributes.
Route|$this
__call(string $method, array $parameters)
Dynamically handle calls into the route registrar.
Route
any(string $uri, Closure|array|string|null $action = null)
No description
Route
delete(string $uri, Closure|array|string|null $action = null)
No description
Route
get(string $uri, Closure|array|string|null $action = null)
No description
Route
options(string $uri, Closure|array|string|null $action = null)
No description
Route
patch(string $uri, Closure|array|string|null $action = null)
No description
Route
post(string $uri, Closure|array|string|null $action = null)
No description
Route
put(string $uri, Closure|array|string|null $action = null)
No description
RouteRegistrar
as(string $value)
No description
RouteRegistrar
controller(string $controller)
No description
RouteRegistrar
domain(BackedEnum|string $value)
No description
RouteRegistrar
middleware(array|string|null $middleware)
No description
RouteRegistrar
missing(Closure $missing)
No description
RouteRegistrar
name(BackedEnum|string $value)
No description
RouteRegistrar
namespace(string|null $value)
No description
RouteRegistrar
prefix(string $prefix)
No description
RouteRegistrar
scopeBindings()
No description
RouteRegistrar
where(array $where)
No description
RouteRegistrar
withoutMiddleware(array|string $middleware)
No description
RouteRegistrar
withoutScopedBindings()
No description