Docs4dev
Docs
laravel / 10 / api / 10.x / illuminate / support / facades / route.html

Route

class Route extends Facade (View source)

Properties

static protected Application $app

The application instance being facaded.

 from Facade
static protected array $resolvedInstance

The resolved object instances.

 from Facade
static protected bool $cached

Indicates if the resolved instance should be cached.

 from Facade

Methods

static void resolved(Closure $callback)

Run a Closure when the facade has been resolved.

 from Facade
static MockInterface spy()

Convert the facade into a Mockery spy.

 from Facade
static MockInterface partialMock()

Initiate a partial mock on the facade.

 from Facade
static Expectation shouldReceive()

Initiate a mock expectation on the facade.

 from Facade
static Expectation expects()

Initiate a mock expectation on the facade.

 from Facade
static MockInterface createFreshMockInstance()

Create a fresh mock instance for the given class.

 from Facade
static MockInterface createMock()

Create a fresh mock instance for the given class.

 from Facade
static bool isMock()

Determines whether a mock is set as the instance of the facade.

 from Facade
static string|null getMockableClass()

Get the mockable class for the bound instance.

 from Facade
static void swap(mixed $instance)

Hotswap the underlying instance behind the facade.

 from Facade
static bool isFake()

Determines whether a "fake" has been set as the facade instance.

 from Facade
static mixed getFacadeRoot()

Get the root object behind the facade.

 from Facade
static string getFacadeAccessor()

Get the registered name of the component.
static mixed resolveFacadeInstance(string $name)

Resolve the facade root instance from the container.

 from Facade
static void clearResolvedInstance(string $name)

Clear a resolved facade instance.

 from Facade
static void clearResolvedInstances()

Clear all of the resolved instances.

 from Facade
static Collection defaultAliases()

Get the application default aliases.

 from Facade
static Application getFacadeApplication()

Get the application instance behind the facade.

 from Facade
static void setFacadeApplication(Application $app)

Set the application instance.

 from Facade
static mixed __callStatic(string $method, array $args)

Handle dynamic, static calls to the object.

 from Facade
static Route get(string $uri, array|string|callable|null $action = null)

No description
static Route post(string $uri, array|string|callable|null $action = null)

No description
static Route put(string $uri, array|string|callable|null $action = null)

No description
static Route patch(string $uri, array|string|callable|null $action = null)

No description
static Route delete(string $uri, array|string|callable|null $action = null)

No description
static Route options(string $uri, array|string|callable|null $action = null)

No description
static Route any(string $uri, array|string|callable|null $action = null)

No description
static Route fallback(array|string|callable|null $action)

No description
static Route redirect(string $uri, string $destination, int $status = 302)

No description
static Route permanentRedirect(string $uri, string $destination)

No description
static Route view(string $uri, string $view, array $data = [], int|array $status = 200, array $headers = [])

No description
static Route match(array|string $methods, string $uri, array|string|callable|null $action = null)

No description
static void resources(array $resources, array $options = [])

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

No description
static void apiResources(array $resources, array $options = [])

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

No description
static void singletons(array $singletons, array $options = [])

No description
static PendingSingletonResourceRegistration singleton(string $name, string $controller, array $options = [])

No description
static void apiSingletons(array $singletons, array $options = [])

No description
static PendingSingletonResourceRegistration apiSingleton(string $name, string $controller, array $options = [])

No description
static Router group(array $attributes, Closure|array|string $routes)

No description
static array mergeWithLastGroup(array $new, bool $prependExistingPrefix = true)

No description
static string getLastGroupPrefix()

No description
static Route addRoute(array|string $methods, string $uri, array|string|callable|null $action)

No description
static Route newRoute(array|string $methods, string $uri, mixed $action)

No description
static Response respondWithRoute(string $name)

No description
static Response dispatch(Request $request)

No description
static Response dispatchToRoute(Request $request)

No description
static array gatherRouteMiddleware(Route $route)

No description
static array resolveMiddleware(array $middleware, array $excluded = [])

No description
static Response prepareResponse(Request $request, mixed $response)

No description
static Response toResponse(Request $request, mixed $response)

No description
static Route substituteBindings(Route $route)

No description
static void substituteImplicitBindings(Route $route)

No description
static void matched(string|callable $callback)

No description
static array getMiddleware()

No description
static Router aliasMiddleware(string $name, string $class)

No description
static bool hasMiddlewareGroup(string $name)

No description
static array getMiddlewareGroups()

No description
static Router middlewareGroup(string $name, array $middleware)

No description
static Router prependMiddlewareToGroup(string $group, string $middleware)

No description
static Router pushMiddlewareToGroup(string $group, string $middleware)

No description
static Router removeMiddlewareFromGroup(string $group, string $middleware)

No description
static Router flushMiddlewareGroups()

No description
static void bind(string $key, string|callable $binder)

No description
static void model(string $key, string $class, Closure|null $callback = null)

No description
static Closure|null getBindingCallback(string $key)

No description
static array getPatterns()

No description
static void pattern(string $key, string $pattern)

No description
static void patterns(array $patterns)

No description
static bool hasGroupStack()

No description
static array getGroupStack()

No description
static mixed input(string $key, string|null $default = null)

No description
static Request getCurrentRequest()

No description
static Route|null getCurrentRoute()

No description
static Route|null current()

No description
static bool has(string|array $name)

No description
static string|null currentRouteName()

No description
static bool is(mixed $patterns)

No description
static bool currentRouteNamed(mixed $patterns)

No description
static string|null currentRouteAction()

No description
static bool uses(array $patterns)

No description
static bool currentRouteUses(string $action)

No description
static void singularResourceParameters(bool $singular = true)

No description
static void resourceParameters(array $parameters = [])

No description
static array|null resourceVerbs(array $verbs = [])

No description
static RouteCollectionInterface getRoutes()

No description
static void setRoutes(RouteCollection $routes)

No description
static void setCompiledRoutes(array $routes)

No description
static array uniqueMiddleware(array $middleware)

No description
static Router setContainer(Container $container)

No description
static void macro(string $name, object|callable $macro)

No description
static void mixin(object $mixin, bool $replace = true)

No description
static bool hasMacro(string $name)

No description
static void flushMacros()

No description
static mixed macroCall(string $method, array $parameters)

No description
static RouteRegistrar attribute(string $key, mixed $value)

No description
static RouteRegistrar whereAlpha(array|string $parameters)

No description
static RouteRegistrar whereAlphaNumeric(array|string $parameters)

No description
static RouteRegistrar whereNumber(array|string $parameters)

No description
static RouteRegistrar whereUlid(array|string $parameters)

No description
static RouteRegistrar whereUuid(array|string $parameters)

No description
static RouteRegistrar whereIn(array|string $parameters, array $values)

No description
static RouteRegistrar as(string $value)

No description
static RouteRegistrar controller(string $controller)

No description
static RouteRegistrar domain(string $value)

No description
static RouteRegistrar middleware(array|string|null $middleware)

No description
static RouteRegistrar name(string $value)

No description
static RouteRegistrar namespace(string|null $value)

No description
static RouteRegistrar prefix(string $prefix)

No description
static RouteRegistrar scopeBindings()

No description
static RouteRegistrar where(array $where)

No description
static RouteRegistrar withoutMiddleware(array|string $middleware)

No description
static RouteRegistrar withoutScopedBindings()

No description

Details

static void resolved(Closure $callback)

Run a Closure when the facade has been resolved.

Parameters

Closure $callback

Return Value

void

static MockInterface spy()

Convert the facade into a Mockery spy.

Return Value

MockInterface

static MockInterface partialMock()

Initiate a partial mock on the facade.

Return Value

MockInterface

static Expectation shouldReceive()

Initiate a mock expectation on the facade.

Return Value

Expectation

static Expectation expects()

Initiate a mock expectation on the facade.

Return Value

Expectation

static protected MockInterface createFreshMockInstance()

Create a fresh mock instance for the given class.

Return Value

MockInterface

static protected MockInterface createMock()

Create a fresh mock instance for the given class.

Return Value

MockInterface

static protected bool isMock()

Determines whether a mock is set as the instance of the facade.

Return Value

bool

static protected string|null getMockableClass()

Get the mockable class for the bound instance.

Return Value

string|null

static void swap(mixed $instance)

Hotswap the underlying instance behind the facade.

Parameters

mixed $instance

Return Value

void

static protected bool isFake()

Determines whether a "fake" has been set as the facade instance.

Return Value

bool

static mixed getFacadeRoot()

Get the root object behind the facade.

Return Value

mixed

static protected string getFacadeAccessor()

Get the registered name of the component.

Return Value

string

static protected mixed resolveFacadeInstance(string $name)

Resolve the facade root instance from the container.

Parameters

string $name

Return Value

mixed

static void clearResolvedInstance(string $name)

Clear a resolved facade instance.

Parameters

string $name

Return Value

void

static void clearResolvedInstances()

Clear all of the resolved instances.

Return Value

void

static Collection defaultAliases()

Get the application default aliases.

Return Value

Collection

static Application getFacadeApplication()

Get the application instance behind the facade.

Return Value

Application

static void setFacadeApplication(Application $app)

Set the application instance.

Parameters

Application $app

Return Value

void

static mixed __callStatic(string $method, array $args)

Handle dynamic, static calls to the object.

Parameters

string $method
array $args

Return Value

mixed

Exceptions

RuntimeException

static Route get(string $uri, array|string|callable|null $action = null)

No description

Parameters

string $uri
array|string|callable|null $action

Return Value

Route

static Route post(string $uri, array|string|callable|null $action = null)

No description

Parameters

string $uri
array|string|callable|null $action

Return Value

Route

static Route put(string $uri, array|string|callable|null $action = null)

No description

Parameters

string $uri
array|string|callable|null $action

Return Value

Route

static Route patch(string $uri, array|string|callable|null $action = null)

No description

Parameters

string $uri
array|string|callable|null $action

Return Value

Route

static Route delete(string $uri, array|string|callable|null $action = null)

No description

Parameters

string $uri
array|string|callable|null $action

Return Value

Route

static Route options(string $uri, array|string|callable|null $action = null)

No description

Parameters

string $uri
array|string|callable|null $action

Return Value

Route

static Route any(string $uri, array|string|callable|null $action = null)

No description

Parameters

string $uri
array|string|callable|null $action

Return Value

Route

static Route fallback(array|string|callable|null $action)

No description

Parameters

array|string|callable|null $action

Return Value

Route

static Route redirect(string $uri, string $destination, int $status = 302)

No description

Parameters

string $uri
string $destination
int $status

Return Value

Route

static Route permanentRedirect(string $uri, string $destination)

No description

Parameters

string $uri
string $destination

Return Value

Route

static Route view(string $uri, string $view, array $data = [], int|array $status = 200, array $headers = [])

No description

Parameters

string $uri
string $view
array $data
int|array $status
array $headers

Return Value

Route

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

No description

Parameters

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

Return Value

Route

static void resources(array $resources, array $options = [])

No description

Parameters

array $resources
array $options

Return Value

void

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

No description

Parameters

string $name
string $controller
array $options

Return Value

PendingResourceRegistration

static void apiResources(array $resources, array $options = [])

No description

Parameters

array $resources
array $options

Return Value

void

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

No description

Parameters

string $name
string $controller
array $options

Return Value

PendingResourceRegistration

static void singletons(array $singletons, array $options = [])

No description

Parameters

array $singletons
array $options

Return Value

void

static PendingSingletonResourceRegistration singleton(string $name, string $controller, array $options = [])

No description

Parameters

string $name
string $controller
array $options

Return Value

PendingSingletonResourceRegistration

static void apiSingletons(array $singletons, array $options = [])

No description

Parameters

array $singletons
array $options

Return Value

void

static PendingSingletonResourceRegistration apiSingleton(string $name, string $controller, array $options = [])

No description

Parameters

string $name
string $controller
array $options

Return Value

PendingSingletonResourceRegistration

static Router group(array $attributes, Closure|array|string $routes)

No description

Parameters

array $attributes
Closure|array|string $routes

Return Value

Router

static array mergeWithLastGroup(array $new, bool $prependExistingPrefix = true)

No description

Parameters

array $new
bool $prependExistingPrefix

Return Value

array

static string getLastGroupPrefix()

No description

Return Value

string

static Route addRoute(array|string $methods, string $uri, array|string|callable|null $action)

No description

Parameters

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

Return Value

Route

static Route newRoute(array|string $methods, string $uri, mixed $action)

No description

Parameters

array|string $methods
string $uri
mixed $action

Return Value

Route

static Response respondWithRoute(string $name)

No description

Parameters

string $name

Return Value

Response

static Response dispatch(Request $request)

No description

Parameters

Request $request

Return Value

Response

static Response dispatchToRoute(Request $request)

No description

Parameters

Request $request

Return Value

Response

static array gatherRouteMiddleware(Route $route)

No description

Parameters

Route $route

Return Value

array

static array resolveMiddleware(array $middleware, array $excluded = [])

No description

Parameters

array $middleware
array $excluded

Return Value

array

static Response prepareResponse(Request $request, mixed $response)

No description

Parameters

Request $request
mixed $response

Return Value

Response

static Response toResponse(Request $request, mixed $response)

No description

Parameters

Request $request
mixed $response

Return Value

Response

static Route substituteBindings(Route $route)

No description

Parameters

Route $route

Return Value

Route

static void substituteImplicitBindings(Route $route)

No description

Parameters

Route $route

Return Value

void

static void matched(string|callable $callback)

No description

Parameters

string|callable $callback

Return Value

void

static array getMiddleware()

No description

Return Value

array

static Router aliasMiddleware(string $name, string $class)

No description

Parameters

string $name
string $class

Return Value

Router

static bool hasMiddlewareGroup(string $name)

No description

Parameters

string $name

Return Value

bool

static array getMiddlewareGroups()

No description

Return Value

array

static Router middlewareGroup(string $name, array $middleware)

No description

Parameters

string $name
array $middleware

Return Value

Router

static Router prependMiddlewareToGroup(string $group, string $middleware)

No description

Parameters

string $group
string $middleware

Return Value

Router

static Router pushMiddlewareToGroup(string $group, string $middleware)

No description

Parameters

string $group
string $middleware

Return Value

Router

static Router removeMiddlewareFromGroup(string $group, string $middleware)

No description

Parameters

string $group
string $middleware

Return Value

Router

static Router flushMiddlewareGroups()

No description

Return Value

Router

static void bind(string $key, string|callable $binder)

No description

Parameters

string $key
string|callable $binder

Return Value

void

static void model(string $key, string $class, Closure|null $callback = null)

No description

Parameters

string $key
string $class
Closure|null $callback

Return Value

void

static Closure|null getBindingCallback(string $key)

No description

Parameters

string $key

Return Value

Closure|null

static array getPatterns()

No description

Return Value

array

static void pattern(string $key, string $pattern)

No description

Parameters

string $key
string $pattern

Return Value

void

static void patterns(array $patterns)

No description

Parameters

array $patterns

Return Value

void

static bool hasGroupStack()

No description

Return Value

bool

static array getGroupStack()

No description

Return Value

array

static mixed input(string $key, string|null $default = null)

No description

Parameters

string $key
string|null $default

Return Value

mixed

static Request getCurrentRequest()

No description

Return Value

Request

static Route|null getCurrentRoute()

No description

Return Value

Route|null

static Route|null current()

No description

Return Value

Route|null

static bool has(string|array $name)

No description

Parameters

string|array $name

Return Value

bool

static string|null currentRouteName()

No description

Return Value

string|null

static bool is(mixed $patterns)

No description

Parameters

mixed $patterns

Return Value

bool

static bool currentRouteNamed(mixed $patterns)

No description

Parameters

mixed $patterns

Return Value

bool

static string|null currentRouteAction()

No description

Return Value

string|null

static bool uses(array $patterns)

No description

Parameters

array $patterns

Return Value

bool

static bool currentRouteUses(string $action)

No description

Parameters

string $action

Return Value

bool

static void singularResourceParameters(bool $singular = true)

No description

Parameters

bool $singular

Return Value

void

static void resourceParameters(array $parameters = [])

No description

Parameters

array $parameters

Return Value

void

static array|null resourceVerbs(array $verbs = [])

No description

Parameters

array $verbs

Return Value

array|null

static RouteCollectionInterface getRoutes()

No description

Return Value

RouteCollectionInterface

static void setRoutes(RouteCollection $routes)

No description

Parameters

RouteCollection $routes

Return Value

void

static void setCompiledRoutes(array $routes)

No description

Parameters

array $routes

Return Value

void

static array uniqueMiddleware(array $middleware)

No description

Parameters

array $middleware

Return Value

array

static Router setContainer(Container $container)

No description

Parameters

Container $container

Return Value

Router

static void macro(string $name, object|callable $macro)

No description

Parameters

string $name
object|callable $macro

Return Value

void

static void mixin(object $mixin, bool $replace = true)

No description

Parameters

object $mixin
bool $replace

Return Value

void

static bool hasMacro(string $name)

No description

Parameters

string $name

Return Value

bool

static void flushMacros()

No description

Return Value

void

static mixed macroCall(string $method, array $parameters)

No description

Parameters

string $method
array $parameters

Return Value

mixed

static RouteRegistrar attribute(string $key, mixed $value)

No description

Parameters

string $key
mixed $value

Return Value

RouteRegistrar

static RouteRegistrar whereAlpha(array|string $parameters)

No description

Parameters

array|string $parameters

Return Value

RouteRegistrar

static RouteRegistrar whereAlphaNumeric(array|string $parameters)

No description

Parameters

array|string $parameters

Return Value

RouteRegistrar

static RouteRegistrar whereNumber(array|string $parameters)

No description

Parameters

array|string $parameters

Return Value

RouteRegistrar

static RouteRegistrar whereUlid(array|string $parameters)

No description

Parameters

array|string $parameters

Return Value

RouteRegistrar

static RouteRegistrar whereUuid(array|string $parameters)

No description

Parameters

array|string $parameters

Return Value

RouteRegistrar

static RouteRegistrar whereIn(array|string $parameters, array $values)

No description

Parameters

array|string $parameters
array $values

Return Value

RouteRegistrar

static RouteRegistrar as(string $value)

No description

Parameters

string $value

Return Value

RouteRegistrar

static RouteRegistrar controller(string $controller)

No description

Parameters

string $controller

Return Value

RouteRegistrar

static RouteRegistrar domain(string $value)

No description

Parameters

string $value

Return Value

RouteRegistrar

static RouteRegistrar middleware(array|string|null $middleware)

No description

Parameters

array|string|null $middleware

Return Value

RouteRegistrar

static RouteRegistrar name(string $value)

No description

Parameters

string $value

Return Value

RouteRegistrar

static RouteRegistrar namespace(string|null $value)

No description

Parameters

string|null $value

Return Value

RouteRegistrar

static RouteRegistrar prefix(string $prefix)

No description

Parameters

string $prefix

Return Value

RouteRegistrar

static RouteRegistrar scopeBindings()

No description

Return Value

RouteRegistrar

static RouteRegistrar where(array $where)

No description

Parameters

array $where

Return Value

RouteRegistrar

static RouteRegistrar withoutMiddleware(array|string $middleware)

No description

Parameters

array|string $middleware

Return Value

RouteRegistrar

static RouteRegistrar withoutScopedBindings()

No description

Return Value

RouteRegistrar

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/10.x/Illuminate/Support/Facades/Route.html