Documentation

Url extends Facade
in package

Facade base class Adds the ability to define a fallback instance.

Tags
see
UrlGenerator

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.
action()  :
asset()  :
buildUrl()  :
clearResolvedInstance()  : void
Clear a resolved facade instance.
clearResolvedInstances()  : void
Clear all of the resolved instances.
current()  :
full()  :
getFacadeApplication()  : Application
Get the application instance behind the facade.
getFacadeRoot()  : mixed
Get the root object behind the facade.
previous()  :
route()  :
secure()  :
setFacadeApplication()  : void
Set the application instance.
setRootControllerNamespace()  :
shouldReceive()  : Expectation
Initiate a mock expectation on the facade.
spy()  : void
Convert the facade into a Mockery spy.
swap()  : void
Hotswap the underlying instance behind the facade.
to()  :
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.
getFacadeInstance()  : mixed
If the accessor is not found via getFacadeAccessor, use this instance as a fallback.
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

action()

public static action(string $action, mixed $parameters, bool $absolute = true) :
Parameters
$action : string
$parameters : mixed
$absolute = true : bool
Return values

asset()

public static asset(string $path, bool $secure = null) :
Parameters
$path : string
$secure = null : bool
Return values

buildUrl()

public static buildUrl(array<string|int, mixed> $url, array<string|int, mixed> $replace = [], mixed $flags, array<string|int, mixed> $$newUrl = []) :
Parameters
$url : array<string|int, mixed>
$replace = [] : array<string|int, mixed>
$flags : mixed
$$newUrl = [] : array<string|int, mixed>
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

current()

public static current() :
Return values

full()

public static full() :
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

previous()

public static previous(mixed $fallback) :
Parameters
$fallback : mixed
Return values

route()

public static route(string $name, mixed $parameters, bool $absolute = true) :
Parameters
$name : string
$parameters : mixed
$absolute = true : bool
Return values

secure()

public static secure(string $path, array<string|int, mixed> $parameters = []) :
Parameters
$path : string
$parameters = [] : array<string|int, mixed>
Return values

setFacadeApplication()

Set the application instance.

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

setRootControllerNamespace()

public static setRootControllerNamespace(string $rootNamespace) :
Parameters
$rootNamespace : string
Return values

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

swap()

Hotswap the underlying instance behind the facade.

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

to()

public static to(string $path, mixed $extra, bool $secure = null) :
Parameters
$path : string
$extra : mixed
$secure = null : bool
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

getFacadeInstance()

If the accessor is not found via getFacadeAccessor, use this instance as a fallback.

protected static getFacadeInstance() : mixed
Return values
mixed

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