class RouteRegistrar (View source)

Properties

protected Router $router

The router instance.

protected array $attributes

The attributes to pass on to the router.

protected array $passthru

The methods to dynamically pass through to the router.

protected array $allowedAttributes

The attributes that can be set through this class.

protected array $aliases

The attributes that are aliased.

Methods

void
__construct(Router $router)

Create a new route registrar instance.

$this
attribute(string $key, mixed $value)

Set the value for a given attribute.

resource(string $name, string $controller, array $options = [])

Route a resource to a controller.

apiResource(string $name, string $controller, array $options = [])

Route an API resource to a controller.

void
group(Closure|string $callback)

Create a route group with shared attributes.

match(array|string $methods, string $uri, Closure|array|string|null $action = null)

Register a new route with the given verbs.

registerRoute(string $method, string $uri, Closure|array|string|null $action = null)

Register a new route with the router.

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.

get(string $uri, Closure|array|string|null $action = 'null')

No description

post(string $uri, Closure|array|string|null $action = 'null')

No description

put(string $uri, Closure|array|string|null $action = 'null')

No description

delete(string $uri, Closure|array|string|null $action = 'null')

No description

patch(string $uri, Closure|array|string|null $action = 'null')

No description

options(string $uri, Closure|array|string|null $action = 'null')

No description

any(string $uri, Closure|array|string|null $action = 'null')

No description

as(string $value)

No description

domain(string $value)

No description

middleware(array|string|null $middleware)

No description

name(string $value)

No description

namespace(string $value)

No description

prefix(string $prefix)

No description

where(array $where)

No description

Details

void __construct(Router $router)

Create a new route registrar instance.

Parameters

Router $router

Return Value

void

$this attribute(string $key, mixed $value)

Set the value for a given attribute.

Parameters

string $key
mixed $value

Return Value

$this

Exceptions

InvalidArgumentException

PendingResourceRegistration resource(string $name, string $controller, array $options = [])

Route a resource to a controller.

Parameters

string $name
string $controller
array $options

Return Value

PendingResourceRegistration

PendingResourceRegistration apiResource(string $name, string $controller, array $options = [])

Route an API resource to a controller.

Parameters

string $name
string $controller
array $options

Return Value

PendingResourceRegistration

void group(Closure|string $callback)

Create a route group with shared attributes.

Parameters

Closure|string $callback

Return Value

void

Route match(array|string $methods, string $uri, Closure|array|string|null $action = null)

Register a new route with the given verbs.

Parameters

array|string $methods
string $uri
Closure|array|string|null $action

Return Value

Route

protected Route registerRoute(string $method, string $uri, Closure|array|string|null $action = null)

Register a new route with the router.

Parameters

string $method
string $uri
Closure|array|string|null $action

Return Value

Route

protected array compileAction(Closure|array|string|null $action)

Compile the action into an array including the attributes.

Parameters

Closure|array|string|null $action

Return Value

array

Route|$this __call(string $method, array $parameters)

Dynamically handle calls into the route registrar.

Parameters

string $method
array $parameters

Return Value

Route|$this

Exceptions

BadMethodCallException

Route get(string $uri, Closure|array|string|null $action = 'null')

No description

Parameters

string $uri
Closure|array|string|null $action

Return Value

Route

Route post(string $uri, Closure|array|string|null $action = 'null')

No description

Parameters

string $uri
Closure|array|string|null $action

Return Value

Route

Route put(string $uri, Closure|array|string|null $action = 'null')

No description

Parameters

string $uri
Closure|array|string|null $action

Return Value

Route

Route delete(string $uri, Closure|array|string|null $action = 'null')

No description

Parameters

string $uri
Closure|array|string|null $action

Return Value

Route

Route patch(string $uri, Closure|array|string|null $action = 'null')

No description

Parameters

string $uri
Closure|array|string|null $action

Return Value

Route

Route options(string $uri, Closure|array|string|null $action = 'null')

No description

Parameters

string $uri
Closure|array|string|null $action

Return Value

Route

Route any(string $uri, Closure|array|string|null $action = 'null')

No description

Parameters

string $uri
Closure|array|string|null $action

Return Value

Route

RouteRegistrar as(string $value)

No description

Parameters

string $value

Return Value

RouteRegistrar

RouteRegistrar domain(string $value)

No description

Parameters

string $value

Return Value

RouteRegistrar

RouteRegistrar middleware(array|string|null $middleware)

No description

Parameters

array|string|null $middleware

Return Value

RouteRegistrar

RouteRegistrar name(string $value)

No description

Parameters

string $value

Return Value

RouteRegistrar

RouteRegistrar namespace(string $value)

No description

Parameters

string $value

Return Value

RouteRegistrar

RouteRegistrar prefix(string $prefix)

No description

Parameters

string $prefix

Return Value

RouteRegistrar

RouteRegistrar where(array $where)

No description

Parameters

array $where

Return Value

RouteRegistrar

Laravel Cloud is the best place to deploy Laravel, Nuxt, Express, Hono, Node.js, Bun, Go, Flask, Python, and more, with dedicated infrastructure available on AWS through Laravel Private Cloud.