class URL extends Facade

Properties

static protected $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 
spy()

Convert the facade into a Mockery spy.

from  Facade
static 
partialMock()

Initiate a partial mock on the facade.

from  Facade
static 
shouldReceive()

Initiate a mock expectation on the facade.

from  Facade
static 
expects()

Initiate a mock expectation on the facade.

from  Facade
static 
createFreshMockInstance()

Create a fresh mock instance for the given class.

from  Facade
static 
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 
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|null $name = null)

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 
getFacadeApplication()

Get the application instance behind the facade.

from  Facade
static void
setFacadeApplication(mixed $app)

Set the application instance.

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

Handle dynamic, static calls to the object.

from  Facade
static string
full()

No description

static string
current()

No description

static string
previous(string|bool $fallback = 'false')

No description

static string
previousPath(string|bool $fallback = 'false')

No description

static string
to(string $path, array|string $extra = '[]', bool|null $secure = 'null')

No description

static string
query(string $path, array $query = '[]', array|string $extra = '[]', bool|null $secure = 'null')

No description

static string
secure(string $path, array $parameters = '[]')

No description

static string
asset(string $path, bool|null $secure = 'null')

No description

static string
secureAsset(string $path)

No description

static string
assetFrom(string $root, string $path, bool|null $secure = 'null')

No description

static string
formatScheme(bool|null $secure = 'null')

No description

static string
signedRoute(BackedEnum|string $name, mixed $parameters = '[]', DateTimeInterface|int|null $expiration = 'null', bool $absolute = 'true')

No description

static string
temporarySignedRoute(BackedEnum|string $name, DateTimeInterface|int $expiration, array $parameters = '[]', bool $absolute = 'true')

No description

static bool
hasValidSignature(Request $request, bool $absolute = 'true', Closure|array $ignoreQuery = '[]')

No description

static bool
hasValidRelativeSignature(Request $request, Closure|array $ignoreQuery = '[]')

No description

static bool
hasCorrectSignature(Request $request, bool $absolute = 'true', Closure|array $ignoreQuery = '[]')

No description

static bool
signatureHasNotExpired(Request $request)

No description

static string
route(BackedEnum|string $name, mixed $parameters = '[]', bool $absolute = 'true')

No description

static string
toRoute(Route $route, mixed $parameters, bool $absolute)

No description

static string
action(array|string $action, array|string $parameters = '[]', bool $absolute = 'true')

No description

static array
formatParameters(mixed $parameters)

No description

static string
formatRoot(string $scheme, string|null $root = 'null')

No description

static string
format(string $root, string $path, Route|null $route = 'null')

No description

static bool
isValidUrl(string $path)

No description

static void
resolveDefaultsUsing(Closure|null $resolver)

No description

static void
defaults(array $defaults)

No description

static array
getDefaultParameters()

No description

static void
useDefaults(array|null $defaults)

No description

static void
forceScheme(string|null $scheme)

No description

static void
forceHttps(bool $force = 'true')

No description

static void
resolveOriginUsing(Closure|null $resolver)

No description

static void
useOrigin(string|null $root)

No description

static void
useAssetOrigin(string|null $root)

No description

static UrlGenerator
formatHostUsing(Closure $callback)

No description

static UrlGenerator
formatPathUsing(Closure $callback)

No description

static Closure
pathFormatter()

No description

static Request
getRequest()

No description

static void
setRequest(Request $request)

No description

static UrlGenerator
setRoutes(RouteCollectionInterface $routes)

No description

static UrlGenerator
setSessionResolver(callable $sessionResolver)

No description

static UrlGenerator
setKeyResolver(callable $keyResolver)

No description

static UrlGenerator
withKeyResolver(callable $keyResolver)

No description

static UrlGenerator
resolveMissingNamedRoutesUsing(callable $missingNamedRouteResolver)

No description

static string|null
getRootControllerNamespace()

No description

static UrlGenerator
setRootControllerNamespace(string $rootNamespace)

No description

static void
macro(string $name, callable|object $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

Details

in Facade at line 55
static void resolved(Closure $callback)

Run a Closure when the facade has been resolved.

Boot-only. The callback is registered on the worker-global container and runs for every subsequent resolution of the facade accessor.

Parameters

Closure $callback

Return Value

void

in Facade at line 71
static spy()

Convert the facade into a Mockery spy.

in Facade at line 89
static partialMock()

Initiate a partial mock on the facade.

Tests only. Swaps the resolved facade instance for the worker lifetime.

in Facade at line 105
static shouldReceive()

Initiate a mock expectation on the facade.

Tests only. Swaps the resolved facade instance for the worker lifetime.

in Facade at line 121
static expects()

Initiate a mock expectation on the facade.

Tests only. Swaps the resolved facade instance for the worker lifetime.

in Facade at line 135
static protected createFreshMockInstance()

Create a fresh mock instance for the given class.

in Facade at line 147
static protected createMock()

Create a fresh mock instance for the given class.

in Facade at line 157
static protected bool isMock()

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

Return Value

bool

in Facade at line 168
static protected string|null getMockableClass()

Get the mockable class for the bound instance.

Return Value

string|null

in Facade at line 184
static swap(mixed $instance)

Hotswap the underlying instance behind the facade.

Tests only. Replaces the worker-wide resolved facade instance and container binding; runtime use races across coroutines and changes every subsequent facade call.

Parameters

mixed $instance

in Facade at line 196
static bool isFake()

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

Return Value

bool

in Facade at line 207
static mixed getFacadeRoot()

Get the root object behind the facade.

Return Value

mixed

at line 62
static protected string getFacadeAccessor()

Get the registered name of the component.

Return Value

string

in Facade at line 223
static protected mixed resolveFacadeInstance(string $name)

Resolve the facade root instance from the container.

Parameters

string $name

Return Value

mixed

in Facade at line 246
static void clearResolvedInstance(string|null $name = null)

Clear a resolved facade instance.

Boot or tests only. Clears a worker-wide facade cache entry; concurrent coroutines may still hold the previous resolved instance.

Parameters

string|null $name

Return Value

void

in Facade at line 257
static void clearResolvedInstances()

Clear all of the resolved instances.

Boot or tests only. Clears the worker-wide facade cache; concurrent coroutines may still hold previously resolved instances.

Return Value

void

in Facade at line 265
static Collection defaultAliases()

Get the application default aliases.

Return Value

Collection

in Facade at line 324
static getFacadeApplication()

Get the application instance behind the facade.

in Facade at line 337
static void setFacadeApplication(mixed $app)

Set the application instance.

Tests only. Replaces the worker-wide facade application reference; runtime use races across coroutines and breaks every facade lookup.

Parameters

mixed $app

Return Value

void

in Facade at line 347
static __callStatic(string $method, array $args)

Handle dynamic, static calls to the object.

Parameters

string $method
array $args

Exceptions

RuntimeException

at line 60
static string full()

No description

Return Value

string

at line 60
static string current()

No description

Return Value

string

at line 60
static string previous(string|bool $fallback = 'false')

No description

Parameters

string|bool $fallback

Return Value

string

at line 60
static string previousPath(string|bool $fallback = 'false')

No description

Parameters

string|bool $fallback

Return Value

string

at line 60
static string to(string $path, array|string $extra = '[]', bool|null $secure = 'null')

No description

Parameters

string $path
array|string $extra
bool|null $secure

Return Value

string

at line 60
static string query(string $path, array $query = '[]', array|string $extra = '[]', bool|null $secure = 'null')

No description

Parameters

string $path
array $query
array|string $extra
bool|null $secure

Return Value

string

at line 60
static string secure(string $path, array $parameters = '[]')

No description

Parameters

string $path
array $parameters

Return Value

string

at line 60
static string asset(string $path, bool|null $secure = 'null')

No description

Parameters

string $path
bool|null $secure

Return Value

string

at line 60
static string secureAsset(string $path)

No description

Parameters

string $path

Return Value

string

at line 60
static string assetFrom(string $root, string $path, bool|null $secure = 'null')

No description

Parameters

string $root
string $path
bool|null $secure

Return Value

string

at line 60
static string formatScheme(bool|null $secure = 'null')

No description

Parameters

bool|null $secure

Return Value

string

at line 60
static string signedRoute(BackedEnum|string $name, mixed $parameters = '[]', DateTimeInterface|int|null $expiration = 'null', bool $absolute = 'true')

No description

Parameters

BackedEnum|string $name
mixed $parameters
DateTimeInterface|int|null $expiration
bool $absolute

Return Value

string

at line 60
static string temporarySignedRoute(BackedEnum|string $name, DateTimeInterface|int $expiration, array $parameters = '[]', bool $absolute = 'true')

No description

Parameters

BackedEnum|string $name
DateTimeInterface|int $expiration
array $parameters
bool $absolute

Return Value

string

at line 60
static bool hasValidSignature(Request $request, bool $absolute = 'true', Closure|array $ignoreQuery = '[]')

No description

Parameters

Request $request
bool $absolute
Closure|array $ignoreQuery

Return Value

bool

at line 60
static bool hasValidRelativeSignature(Request $request, Closure|array $ignoreQuery = '[]')

No description

Parameters

Request $request
Closure|array $ignoreQuery

Return Value

bool

at line 60
static bool hasCorrectSignature(Request $request, bool $absolute = 'true', Closure|array $ignoreQuery = '[]')

No description

Parameters

Request $request
bool $absolute
Closure|array $ignoreQuery

Return Value

bool

at line 60
static bool signatureHasNotExpired(Request $request)

No description

Parameters

Request $request

Return Value

bool

at line 60
static string route(BackedEnum|string $name, mixed $parameters = '[]', bool $absolute = 'true')

No description

Parameters

BackedEnum|string $name
mixed $parameters
bool $absolute

Return Value

string

at line 60
static string toRoute(Route $route, mixed $parameters, bool $absolute)

No description

Parameters

Route $route
mixed $parameters
bool $absolute

Return Value

string

at line 60
static string action(array|string $action, array|string $parameters = '[]', bool $absolute = 'true')

No description

Parameters

array|string $action
array|string $parameters
bool $absolute

Return Value

string

at line 60
static array formatParameters(mixed $parameters)

No description

Parameters

mixed $parameters

Return Value

array

at line 60
static string formatRoot(string $scheme, string|null $root = 'null')

No description

Parameters

string $scheme
string|null $root

Return Value

string

at line 60
static string format(string $root, string $path, Route|null $route = 'null')

No description

Parameters

string $root
string $path
Route|null $route

Return Value

string

at line 60
static bool isValidUrl(string $path)

No description

Parameters

string $path

Return Value

bool

at line 60
static void resolveDefaultsUsing(Closure|null $resolver)

No description

Parameters

Closure|null $resolver

Return Value

void

at line 60
static void defaults(array $defaults)

No description

Parameters

array $defaults

Return Value

void

at line 60
static array getDefaultParameters()

No description

Return Value

array

at line 60
static void useDefaults(array|null $defaults)

No description

Parameters

array|null $defaults

Return Value

void

at line 60
static void forceScheme(string|null $scheme)

No description

Parameters

string|null $scheme

Return Value

void

at line 60
static void forceHttps(bool $force = 'true')

No description

Parameters

bool $force

Return Value

void

at line 60
static void resolveOriginUsing(Closure|null $resolver)

No description

Parameters

Closure|null $resolver

Return Value

void

at line 60
static void useOrigin(string|null $root)

No description

Parameters

string|null $root

Return Value

void

at line 60
static void useAssetOrigin(string|null $root)

No description

Parameters

string|null $root

Return Value

void

at line 60
static UrlGenerator formatHostUsing(Closure $callback)

No description

Parameters

Closure $callback

Return Value

UrlGenerator

at line 60
static UrlGenerator formatPathUsing(Closure $callback)

No description

Parameters

Closure $callback

Return Value

UrlGenerator

at line 60
static Closure pathFormatter()

No description

Return Value

Closure

at line 60
static Request getRequest()

No description

Return Value

Request

at line 60
static void setRequest(Request $request)

No description

Parameters

Request $request

Return Value

void

at line 60
static UrlGenerator setRoutes(RouteCollectionInterface $routes)

No description

Parameters

RouteCollectionInterface $routes

Return Value

UrlGenerator

at line 60
static UrlGenerator setSessionResolver(callable $sessionResolver)

No description

Parameters

callable $sessionResolver

Return Value

UrlGenerator

at line 60
static UrlGenerator setKeyResolver(callable $keyResolver)

No description

Parameters

callable $keyResolver

Return Value

UrlGenerator

at line 60
static UrlGenerator withKeyResolver(callable $keyResolver)

No description

Parameters

callable $keyResolver

Return Value

UrlGenerator

at line 60
static UrlGenerator resolveMissingNamedRoutesUsing(callable $missingNamedRouteResolver)

No description

Parameters

callable $missingNamedRouteResolver

Return Value

UrlGenerator

at line 60
static string|null getRootControllerNamespace()

No description

Return Value

string|null

at line 60
static UrlGenerator setRootControllerNamespace(string $rootNamespace)

No description

Parameters

string $rootNamespace

Return Value

UrlGenerator

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

No description

Parameters

string $name
callable|object $macro

Return Value

void

at line 60
static void mixin(object $mixin, bool $replace = 'true')

No description

Parameters

object $mixin
bool $replace

Return Value

void

at line 60
static bool hasMacro(string $name)

No description

Parameters

string $name

Return Value

bool

at line 60
static void flushMacros()

No description

Return Value

void