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 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 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
apiResource(string $name, string $controller, array $options = [])

No description

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

No description

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

No description

static Route|null
current()

No description

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

No description

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

No description

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

No description

static Route|null
getCurrentRoute()

No description

getRoutes()

No description

static Route
match(array|string $methods, 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
patch(string $uri, array|string|callable|null $action = null)

No description

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

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
redirect(string $uri, string $destination, int $status = 302)

No description

static Route
substituteBindings(Route $route)

No description

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

No description

static RouteRegistrar
as(string $value)

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
group(Closure|string|array $attributes, Closure|string $routes)

No description

resourceVerbs(array $verbs = [])

No description

static string|null
currentRouteAction()

No description

static string|null
currentRouteName()

No description

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

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 void
pattern(string $key, string $pattern)

No description

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

No description

static void
substituteImplicitBindings(Route $route)

No description

static bool
uses(mixed $patterns)

No description

static bool
is(mixed $patterns)

No description

static bool
has(string $name)

No description

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

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 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 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 PendingResourceRegistration apiResource(string $name, string $controller, array $options = [])

No description

Parameters

string $name
string $controller
array $options

Return Value

PendingResourceRegistration

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

No description

Parameters

string $name
string $controller
array $options

Return Value

PendingResourceRegistration

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|null current()

No description

Return Value

Route|null

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 fallback(array|string|callable|null $action = null)

No description

Parameters

array|string|callable|null $action

Return Value

Route

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|null getCurrentRoute()

No description

Return Value

Route|null

static RouteCollectionInterface getRoutes()

No description

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 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 patch(string $uri, array|string|callable|null $action = null)

No description

Parameters

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

Return Value

Route

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

No description

Parameters

string $uri
string $destination

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 redirect(string $uri, string $destination, int $status = 302)

No description

Parameters

string $uri
string $destination
int $status

Return Value

Route

static Route substituteBindings(Route $route)

No description

Parameters

Route $route

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 RouteRegistrar as(string $value)

No description

Parameters

string $value

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 group(Closure|string|array $attributes, Closure|string $routes)

No description

Parameters

Closure|string|array $attributes
Closure|string $routes

Return Value

RouteRegistrar

static ResourceRegistrar resourceVerbs(array $verbs = [])

No description

Parameters

array $verbs

Return Value

ResourceRegistrar

static string|null currentRouteAction()

No description

Return Value

string|null

static string|null currentRouteName()

No description

Return Value

string|null

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

No description

Parameters

array $resources
array $options

Return Value

void

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 void pattern(string $key, string $pattern)

No description

Parameters

string $key
string $pattern

Return Value

void

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

No description

Parameters

array $resources
array $options

Return Value

void

static void substituteImplicitBindings(Route $route)

No description

Parameters

Route $route

Return Value

void

static bool uses(mixed $patterns)

No description

Parameters

mixed $patterns

Return Value

bool

static bool is(mixed $patterns)

No description

Parameters

mixed $patterns

Return Value

bool

static bool has(string $name)

No description

Parameters

string $name

Return Value

bool

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

No description

Parameters

string $key
string|null $default

Return Value

mixed