Documentation

Route extends Facade
in package

Tags
see
Router

Table of Contents

$app  : Application
The application instance being facaded.
$resolvedInstance  : array<string|int, mixed>
The resolved object instances.
__callStatic()  : mixed
Handle dynamic, static calls to the object.
any()  :
apiResource()  :
as()  :
clearResolvedInstance()  : void
Clear a resolved facade instance.
clearResolvedInstances()  : void
Clear all of the resolved instances.
delete()  :
domain()  :
get()  :
getFacadeApplication()  : Application
Get the application instance behind the facade.
getFacadeRoot()  : mixed
Get the root object behind the facade.
group()  :
match()  :
middleware()  :
name()  :
namespace()  :
options()  :
patch()  :
post()  :
prefix()  :
put()  :
redirect()  :
resource()  :
setFacadeApplication()  : void
Set the application instance.
shouldReceive()  : Expectation
Initiate a mock expectation on the facade.
spy()  : void
Convert the facade into a Mockery spy.
substituteBindings()  :
substituteImplicitBindings()  :
swap()  : void
Hotswap the underlying instance behind the facade.
view()  :
where()  :
createFreshMockInstance()  : Expectation
Create a fresh mock instance for the given class.
createMock()  : MockInterface
Create a fresh mock instance for the given class.
getFacadeAccessor()  : string
Get the registered name of the component.
getMockableClass()  : string|null
Get the mockable class for the bound instance.
isMock()  : bool
Determines whether a mock is set as the instance of the facade.
resolveFacadeInstance()  : mixed
Resolve the facade root instance from the container.

Properties

$resolvedInstance

The resolved object instances.

protected static array<string|int, mixed> $resolvedInstance

Methods

__callStatic()

Handle dynamic, static calls to the object.

public static __callStatic(string $method, array<string|int, mixed> $args) : mixed
Parameters
$method : string
$args : array<string|int, mixed>
Tags
throws
RuntimeException
Return values
mixed

any()

public static any(string $uri, Closure|array<string|int, mixed>|string|null $action = null) :
Parameters
$uri : string
$action = null : Closure|array<string|int, mixed>|string|null
Return values

apiResource()

public static apiResource(string $name, string $controller, array<string|int, mixed> $options = []) :
Parameters
$name : string
$controller : string
$options = [] : array<string|int, mixed>
Return values

as()

public static as(string $value) :
Parameters
$value : string
Return values

clearResolvedInstance()

Clear a resolved facade instance.

public static clearResolvedInstance(string $name) : void
Parameters
$name : string
Return values
void

clearResolvedInstances()

Clear all of the resolved instances.

public static clearResolvedInstances() : void
Return values
void

delete()

public static delete(string $uri, Closure|array<string|int, mixed>|string|null $action = null) :
Parameters
$uri : string
$action = null : Closure|array<string|int, mixed>|string|null
Return values

domain()

public static domain(string $value) :
Parameters
$value : string
Return values

get()

public static get(string $uri, Closure|array<string|int, mixed>|string|null $action = null) :
Parameters
$uri : string
$action = null : Closure|array<string|int, mixed>|string|null
Return values

getFacadeApplication()

Get the application instance behind the facade.

public static getFacadeApplication() : Application
Return values
Application

getFacadeRoot()

Get the root object behind the facade.

public static getFacadeRoot() : mixed
Return values
mixed

group()

public static group(Closure|string|array<string|int, mixed> $value, Closure|string $routes) :
Parameters
$value : Closure|string|array<string|int, mixed>
$routes : Closure|string
Return values

match()

public static match(array<string|int, mixed>|string $methods, string $uri, Closure|array<string|int, mixed>|string|null $action = null) :
Parameters
$methods : array<string|int, mixed>|string
$uri : string
$action = null : Closure|array<string|int, mixed>|string|null
Return values

middleware()

public static middleware(array<string|int, mixed>|string|null $middleware) :
Parameters
$middleware : array<string|int, mixed>|string|null
Return values

name()

public static name(string $value) :
Parameters
$value : string
Return values

namespace()

public static namespace(string $value) :
Parameters
$value : string
Return values

options()

public static options(string $uri, Closure|array<string|int, mixed>|string|null $action = null) :
Parameters
$uri : string
$action = null : Closure|array<string|int, mixed>|string|null
Return values

patch()

public static patch(string $uri, Closure|array<string|int, mixed>|string|null $action = null) :
Parameters
$uri : string
$action = null : Closure|array<string|int, mixed>|string|null
Return values

post()

public static post(string $uri, Closure|array<string|int, mixed>|string|null $action = null) :
Parameters
$uri : string
$action = null : Closure|array<string|int, mixed>|string|null
Return values

prefix()

public static prefix(string $$prefix) :
Parameters
$$prefix : string
Return values

put()

public static put(string $uri, Closure|array<string|int, mixed>|string|null $action = null) :
Parameters
$uri : string
$action = null : Closure|array<string|int, mixed>|string|null
Return values

redirect()

public static redirect(string $uri, string $destination, int $status = 301) :
Parameters
$uri : string
$destination : string
$status = 301 : int
Return values

resource()

public static resource(string $name, string $controller, array<string|int, mixed> $options = []) :
Parameters
$name : string
$controller : string
$options = [] : array<string|int, mixed>
Return values

setFacadeApplication()

Set the application instance.

public static setFacadeApplication(Application $app) : void
Parameters
$app : Application
Return values
void

shouldReceive()

Initiate a mock expectation on the facade.

public static shouldReceive() : Expectation
Return values
Expectation

spy()

Convert the facade into a Mockery spy.

public static spy() : void
Return values
void

substituteBindings()

public static substituteBindings(Route $route) :
Parameters
$route : Route
Return values

substituteImplicitBindings()

public static substituteImplicitBindings(Route $route) :
Parameters
$route : Route
Return values

swap()

Hotswap the underlying instance behind the facade.

public static swap(mixed $instance) : void
Parameters
$instance : mixed
Return values
void

view()

public static view(string $uri, string $view, array<string|int, mixed> $data = []) :
Parameters
$uri : string
$view : string
$data = [] : array<string|int, mixed>
Return values

where()

public static where(array<string|int, mixed>|string $name, string $expression = null) :
Parameters
$name : array<string|int, mixed>|string
$expression = null : string
Return values

createFreshMockInstance()

Create a fresh mock instance for the given class.

protected static createFreshMockInstance() : Expectation
Return values
Expectation

createMock()

Create a fresh mock instance for the given class.

protected static createMock() : MockInterface
Return values
MockInterface

getFacadeAccessor()

Get the registered name of the component.

protected static getFacadeAccessor() : string
Return values
string

getMockableClass()

Get the mockable class for the bound instance.

protected static getMockableClass() : string|null
Return values
string|null

isMock()

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

protected static isMock() : bool
Return values
bool

resolveFacadeInstance()

Resolve the facade root instance from the container.

protected static resolveFacadeInstance(string|object $name) : mixed
Parameters
$name : string|object
Return values
mixed

Search results