1. class
  2. Hypervel
  3. \
  4. Support
  5. \
  6. Facades
  7. \
  8. URL

URL

class URL extends Facade

Properties

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

Convert the facade into a Mockery spy.

from  Facade
static MockInterface
partialMock()

Initiate a partial mock on the facade.

from  Facade
static CompositeExpectation|Expectation|HigherOrderMessage
shouldReceive()

Initiate a mock expectation on the facade.

from  Facade
static CompositeExpectation|Expectation|ExpectsHigherOrderMessage
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|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 Container|null
getFacadeApplication()

Get the application instance behind the facade.

from  Facade
static void
setFacadeApplication(Container|null $app)

Set the application instance.

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

Handle dynamic, static calls to the object.

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

No description

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

No description

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

No description

static string
current()

No description

static void
defaults(array $defaults)

No description

static void
flushMacros()

No description

static void
flushState()

No description

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

No description

static void
forceScheme(string|null $scheme)

No description

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

No description

static UrlGenerator
formatHostUsing(Closure $callback)

No description

static array
formatParameters(mixed $parameters)

No description

static UrlGenerator
formatPathUsing(Closure $callback)

No description

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

No description

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

No description

static string
full()

No description

static array
getDefaultParameters()

No description

static string|null
getForcedScheme()

No description

static Request
getRequest()

No description

static string|null
getRootControllerNamespace()

No description

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

No description

static bool
hasMacro(string $name)

No description

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

No description

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

No description

static bool
isValidUrl(string $path)

No description

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

No description

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

No description

static Closure
pathFormatter()

No description

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

No description

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

No description

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

No description

static void
resolveDefaultsUsing(Closure|null $resolver)

No description

static UrlGenerator
resolveMissingNamedRoutesUsing(callable $missingNamedRouteResolver)

No description

static void
resolveOriginUsing(Closure|null $resolver)

No description

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

No description

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

No description

static string
secureAsset(string $path)

No description

static UrlGenerator
setKeyResolver(callable $keyResolver)

No description

static void
setRequest(Request $request)

No description

static UrlGenerator
setRootControllerNamespace(string $rootNamespace)

No description

static UrlGenerator
setRoutes(RouteCollectionInterface $routes)

No description

static UrlGenerator
setSessionResolver(callable $sessionResolver)

No description

static bool
signatureHasNotExpired(Request $request)

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, mixed $parameters = '[]', bool $absolute = 'true')

No description

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

No description

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

No description

static void
useAssetOrigin(string|null $root)

No description

static void
useDefaults(array|null $defaults)

No description

static void
useOrigin(string|null $root)

No description

static UrlGenerator
withKeyResolver(callable $keyResolver)

No description

Details

in Facade at line 61
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 81
static MockInterface|null spy()

Convert the facade into a Mockery spy.

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

Return Value

MockInterface|null

in Facade at line 99
static MockInterface partialMock()

Initiate a partial mock on the facade.

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

Return Value

MockInterface

in Facade at line 115
static CompositeExpectation|Expectation|HigherOrderMessage shouldReceive()

Initiate a mock expectation on the facade.

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

Return Value

CompositeExpectation|Expectation|HigherOrderMessage

in Facade at line 131
static CompositeExpectation|Expectation|ExpectsHigherOrderMessage expects()

Initiate a mock expectation on the facade.

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

Return Value

CompositeExpectation|Expectation|ExpectsHigherOrderMessage

in Facade at line 145
static protected MockInterface createFreshMockInstance()

Create a fresh mock instance for the given class.

Return Value

MockInterface

in Facade at line 157
static protected MockInterface createMock()

Create a fresh mock instance for the given class.

Return Value

MockInterface

in Facade at line 167
static protected bool isMock()

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

Return Value

bool

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

Get the mockable class for the bound instance.

Return Value

string|null

in Facade at line 194
static void 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

Return Value

void

in Facade at line 206
static bool isFake()

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

Return Value

bool

in Facade at line 217
static mixed getFacadeRoot()

Get the root object behind the facade.

Return Value

mixed

at line 67
static protected string getFacadeAccessor()

Get the registered name of the component.

Return Value

string

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

Resolve the facade root instance from the container.

Parameters

string $name

Return Value

mixed

in Facade at line 256
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 267
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 275
static Collection defaultAliases()

Get the application default aliases.

Return Value

Collection

in Facade at line 335
static Container|null getFacadeApplication()

Get the application instance behind the facade.

Return Value

Container|null

in Facade at line 346
static void setFacadeApplication(Container|null $app)

Set the application instance.

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

Parameters

Container|null $app

Return Value

void

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

Handle dynamic, static calls to the object.

Parameters

string $method
array $args

Return Value

mixed

Exceptions

RuntimeException

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

No description

Parameters

array|string $action
mixed $parameters
bool $absolute

Return Value

string

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

No description

Parameters

string $path
bool|null $secure

Return Value

string

at line 62
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 62
static string current()

No description

Return Value

string

at line 62
static void defaults(array $defaults)

No description

Parameters

array $defaults

Return Value

void

at line 62
static void flushMacros()

No description

Return Value

void

at line 62
static void flushState()

No description

Return Value

void

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

No description

Parameters

bool $force

Return Value

void

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

No description

Parameters

string|null $scheme

Return Value

void

at line 62
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 62
static UrlGenerator formatHostUsing(Closure $callback)

No description

Parameters

Closure $callback

Return Value

UrlGenerator

at line 62
static array formatParameters(mixed $parameters)

No description

Parameters

mixed $parameters

Return Value

array

at line 62
static UrlGenerator formatPathUsing(Closure $callback)

No description

Parameters

Closure $callback

Return Value

UrlGenerator

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

No description

Parameters

string $scheme
string|null $root

Return Value

string

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

No description

Parameters

bool|null $secure

Return Value

string

at line 62
static string full()

No description

Return Value

string

at line 62
static array getDefaultParameters()

No description

Return Value

array

at line 62
static string|null getForcedScheme()

No description

Return Value

string|null

at line 62
static Request getRequest()

No description

Return Value

Request

at line 62
static string|null getRootControllerNamespace()

No description

Return Value

string|null

at line 62
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 62
static bool hasMacro(string $name)

No description

Parameters

string $name

Return Value

bool

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

No description

Parameters

Request $request
Closure|array $ignoreQuery

Return Value

bool

at line 62
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 62
static bool isValidUrl(string $path)

No description

Parameters

string $path

Return Value

bool

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

No description

Parameters

string $name
callable|object $macro

Return Value

void

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

No description

Parameters

object $mixin
bool $replace

Return Value

void

at line 62
static Closure pathFormatter()

No description

Return Value

Closure

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

No description

Parameters

string|bool $fallback

Return Value

string

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

No description

Parameters

string|bool $fallback

Return Value

string

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

No description

Parameters

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

Return Value

string

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

No description

Parameters

Closure|null $resolver

Return Value

void

at line 62
static UrlGenerator resolveMissingNamedRoutesUsing(callable $missingNamedRouteResolver)

No description

Parameters

callable $missingNamedRouteResolver

Return Value

UrlGenerator

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

No description

Parameters

Closure|null $resolver

Return Value

void

at line 62
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 62
static string secure(string $path, mixed $parameters = '[]')

No description

Parameters

string $path
mixed $parameters

Return Value

string

at line 62
static string secureAsset(string $path)

No description

Parameters

string $path

Return Value

string

at line 62
static UrlGenerator setKeyResolver(callable $keyResolver)

No description

Parameters

callable $keyResolver

Return Value

UrlGenerator

at line 62
static void setRequest(Request $request)

No description

Parameters

Request $request

Return Value

void

at line 62
static UrlGenerator setRootControllerNamespace(string $rootNamespace)

No description

Parameters

string $rootNamespace

Return Value

UrlGenerator

at line 62
static UrlGenerator setRoutes(RouteCollectionInterface $routes)

No description

Parameters

RouteCollectionInterface $routes

Return Value

UrlGenerator

at line 62
static UrlGenerator setSessionResolver(callable $sessionResolver)

No description

Parameters

callable $sessionResolver

Return Value

UrlGenerator

at line 62
static bool signatureHasNotExpired(Request $request)

No description

Parameters

Request $request

Return Value

bool

at line 62
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 62
static string temporarySignedRoute(BackedEnum|string $name, DateTimeInterface|int $expiration, mixed $parameters = '[]', bool $absolute = 'true')

No description

Parameters

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

Return Value

string

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

No description

Parameters

string $path
mixed $extra
bool|null $secure

Return Value

string

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

No description

Parameters

Route $route
mixed $parameters
bool $absolute

Return Value

string

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

No description

Parameters

string|null $root

Return Value

void

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

No description

Parameters

array|null $defaults

Return Value

void

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

No description

Parameters

string|null $root

Return Value

void

at line 62
static UrlGenerator withKeyResolver(callable $keyResolver)

No description

Parameters

callable $keyResolver

Return Value

UrlGenerator