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

URL

class URL extends Facade (View source)

Properties

static protected Application|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
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 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 $name)

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

Get the application instance behind the facade.

from  Facade
static void
setFacadeApplication(Application|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
full()

No description

static string
current()

No description

static string
previous(mixed $fallback = false)

No description

static string
previousPath(mixed $fallback = false)

No description

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

No description

static string
query(string $path, array $query = [], mixed $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 = [], DateInterval|int|null $expiration = null, bool $absolute = true)

No description

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

No description

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

No description

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

No description

static bool
hasCorrectSignature(Request $request, bool $absolute = true, 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(string|array $action, mixed $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
defaults(array $defaults)

No description

static array
getDefaultParameters()

No description

static void
forceScheme(string|null $scheme)

No description

static void
forceHttps(bool $force = true)

No description

static void
forceRootUrl(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
getRootControllerNamespace()

No description

static UrlGenerator
setRootControllerNamespace(string $rootNamespace)

No description

static void
macro(string $name, object|callable $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 47
static void resolved(Closure $callback)

Run a Closure when the facade has been resolved.

Parameters

Closure $callback

Return Value

void

in Facade at line 65
static MockInterface spy()

Convert the facade into a Mockery spy.

Return Value

MockInterface

in Facade at line 81
static MockInterface partialMock()

Initiate a partial mock on the facade.

Return Value

MockInterface

in Facade at line 97
static Expectation shouldReceive()

Initiate a mock expectation on the facade.

Return Value

Expectation

in Facade at line 113
static Expectation expects()

Initiate a mock expectation on the facade.

Return Value

Expectation

in Facade at line 129
static protected MockInterface createFreshMockInstance()

Create a fresh mock instance for the given class.

Return Value

MockInterface

in Facade at line 143
static protected MockInterface createMock()

Create a fresh mock instance for the given class.

Return Value

MockInterface

in Facade at line 155
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 181
static void swap(mixed $instance)

Hotswap the underlying instance behind the facade.

Parameters

mixed $instance

Return Value

void

in Facade at line 195
static bool isFake()

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

Return Value

bool

in Facade at line 208
static mixed getFacadeRoot()

Get the root object behind the facade.

Return Value

mixed

at line 61
static protected string getFacadeAccessor()

Get the registered name of the component.

Return Value

string

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

Resolve the facade root instance from the container.

Parameters

string $name

Return Value

mixed

in Facade at line 252
static void clearResolvedInstance(string $name)

Clear a resolved facade instance.

Parameters

string $name

Return Value

void

in Facade at line 262
static void clearResolvedInstances()

Clear all of the resolved instances.

Return Value

void

in Facade at line 272
static Collection defaultAliases()

Get the application default aliases.

Return Value

Collection

in Facade at line 328
static Application|null getFacadeApplication()

Get the application instance behind the facade.

Return Value

Application|null

in Facade at line 339
static void setFacadeApplication(Application|null $app)

Set the application instance.

Parameters

Application|null $app

Return Value

void

in Facade at line 353
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 54
static string full()

No description

Return Value

string

at line 54
static string current()

No description

Return Value

string

at line 54
static string previous(mixed $fallback = false)

No description

Parameters

mixed $fallback

Return Value

string

at line 54
static string previousPath(mixed $fallback = false)

No description

Parameters

mixed $fallback

Return Value

string

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

No description

Parameters

string $path
array $parameters

Return Value

string

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

No description

Parameters

string $path
bool|null $secure

Return Value

string

at line 54
static string secureAsset(string $path)

No description

Parameters

string $path

Return Value

string

at line 54
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 54
static string formatScheme(bool|null $secure = null)

No description

Parameters

bool|null $secure

Return Value

string

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

No description

Parameters

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

Return Value

string

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

No description

Parameters

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

Return Value

string

at line 54
static bool hasValidSignature(Request $request, bool $absolute = true, array $ignoreQuery = [])

No description

Parameters

Request $request
bool $absolute
array $ignoreQuery

Return Value

bool

at line 54
static bool hasValidRelativeSignature(Request $request, array $ignoreQuery = [])

No description

Parameters

Request $request
array $ignoreQuery

Return Value

bool

at line 54
static bool hasCorrectSignature(Request $request, bool $absolute = true, array $ignoreQuery = [])

No description

Parameters

Request $request
bool $absolute
array $ignoreQuery

Return Value

bool

at line 54
static bool signatureHasNotExpired(Request $request)

No description

Parameters

Request $request

Return Value

bool

at line 54
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 54
static string toRoute(Route $route, mixed $parameters, bool $absolute)

No description

Parameters

Route $route
mixed $parameters
bool $absolute

Return Value

string

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

No description

Parameters

string|array $action
mixed $parameters
bool $absolute

Return Value

string

at line 54
static array formatParameters(mixed $parameters)

No description

Parameters

mixed $parameters

Return Value

array

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

No description

Parameters

string $scheme
string|null $root

Return Value

string

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

No description

Parameters

string $path

Return Value

bool

at line 54
static void defaults(array $defaults)

No description

Parameters

array $defaults

Return Value

void

at line 54
static array getDefaultParameters()

No description

Return Value

array

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

No description

Parameters

string|null $scheme

Return Value

void

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

No description

Parameters

bool $force

Return Value

void

at line 54
static void forceRootUrl(string|null $root)

No description

Parameters

string|null $root

Return Value

void

at line 54
static UrlGenerator formatHostUsing(Closure $callback)

No description

Parameters

Closure $callback

Return Value

UrlGenerator

at line 54
static UrlGenerator formatPathUsing(Closure $callback)

No description

Parameters

Closure $callback

Return Value

UrlGenerator

at line 54
static Closure pathFormatter()

No description

Return Value

Closure

at line 54
static Request getRequest()

No description

Return Value

Request

at line 54
static void setRequest(Request $request)

No description

Parameters

Request $request

Return Value

void

at line 54
static UrlGenerator setRoutes(RouteCollectionInterface $routes)

No description

Parameters

RouteCollectionInterface $routes

Return Value

UrlGenerator

at line 54
static UrlGenerator setSessionResolver(callable $sessionResolver)

No description

Parameters

callable $sessionResolver

Return Value

UrlGenerator

at line 54
static UrlGenerator setKeyResolver(callable $keyResolver)

No description

Parameters

callable $keyResolver

Return Value

UrlGenerator

at line 54
static UrlGenerator withKeyResolver(callable $keyResolver)

No description

Parameters

callable $keyResolver

Return Value

UrlGenerator

at line 54
static UrlGenerator resolveMissingNamedRoutesUsing(callable $missingNamedRouteResolver)

No description

Parameters

callable $missingNamedRouteResolver

Return Value

UrlGenerator

at line 54
static string getRootControllerNamespace()

No description

Return Value

string

at line 54
static UrlGenerator setRootControllerNamespace(string $rootNamespace)

No description

Parameters

string $rootNamespace

Return Value

UrlGenerator

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

No description

Parameters

string $name
object|callable $macro

Return Value

void

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

No description

Parameters

object $mixin
bool $replace

Return Value

void

at line 54
static bool hasMacro(string $name)

No description

Parameters

string $name

Return Value

bool

at line 54
static void flushMacros()

No description

Return Value

void