URL

class URL extends Facade (View source)

Properties

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

getFacadeApplication()

Get the application instance behind the facade.

from Facade

static void

setFacadeApplication(Application $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

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

No description

static string

temporarySignedRoute(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(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|array $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

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 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

static void resolved(Closure $callback)

Run a Closure when the facade has been resolved.

Parameters

Closure

$callback

Return Value

void

static MockInterface spy()

Convert the facade into a Mockery spy.

Return Value

MockInterface

static MockInterface partialMock()

Initiate a partial mock on the facade.

Return Value

MockInterface

static Expectation shouldReceive()

Initiate a mock expectation on the facade.

Return Value

Expectation

static Expectation expects()

Initiate a mock expectation on the facade.

Return Value

Expectation

static protected MockInterface createFreshMockInstance()

Create a fresh mock instance for the given class.

Return Value

MockInterface

static protected MockInterface createMock()

Create a fresh mock instance for the given class.

Return Value

MockInterface

static protected bool isMock()

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

Return Value

bool

static protected string|null getMockableClass()

Get the mockable class for the bound instance.

Return Value

string|null

static void swap(mixed $instance)

Hotswap the underlying instance behind the facade.

Parameters

mixed

$instance

Return Value

void

static protected bool isFake()

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

Return Value

bool

static mixed getFacadeRoot()

Get the root object behind the facade.

Return Value

mixed

static protected string getFacadeAccessor()

Get the registered name of the component.

Return Value

string

static protected mixed resolveFacadeInstance(string $name)

Resolve the facade root instance from the container.

Parameters

string

$name

Return Value

mixed

static void clearResolvedInstance(string $name)

Clear a resolved facade instance.

Parameters

string

$name

Return Value

void

static void clearResolvedInstances()

Clear all of the resolved instances.

Return Value

void

static Collection defaultAliases()

Get the application default aliases.

Return Value

Collection

static Application getFacadeApplication()

Get the application instance behind the facade.

Return Value

Application

static void setFacadeApplication(Application $app)

Set the application instance.

Parameters

Application

$app

Return Value

void

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

Handle dynamic, static calls to the object.

Parameters

string	$method
array	$args

Return Value

mixed

Exceptions

RuntimeException

static string full()

No description

Return Value

string

static string current()

No description

Return Value

string

static string previous(mixed $fallback = false)

No description

Parameters

mixed

$fallback

Return Value

string

static string previousPath(mixed $fallback = false)

No description

Parameters

mixed

$fallback

Return Value

string

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

No description

Parameters

string	$path
mixed	$extra
bool\|null	$secure

Return Value

string

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

No description

Parameters

string	$path
array	$parameters

Return Value

string

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

No description

Parameters

string	$path
bool\|null	$secure

Return Value

string

static string secureAsset(string $path)

No description

Parameters

string

$path

Return Value

string

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

No description

Parameters

string	$root
string	$path
bool\|null	$secure

Return Value

string

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

No description

Parameters

bool|null

$secure

Return Value

string

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

No description

Parameters

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

Return Value

string

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

No description

Parameters

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

Return Value

string

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

No description

Parameters

Request	$request
bool	$absolute
array	$ignoreQuery

Return Value

bool

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

No description

Parameters

Request	$request
array	$ignoreQuery

Return Value

bool

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

No description

Parameters

Request	$request
bool	$absolute
array	$ignoreQuery

Return Value

bool

static bool signatureHasNotExpired(Request $request)

No description

Parameters

Request

$request

Return Value

bool

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

No description

Parameters

string	$name
mixed	$parameters
bool	$absolute

Return Value

string

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

No description

Parameters

Route	$route
mixed	$parameters
bool	$absolute

Return Value

string

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

No description

Parameters

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

Return Value

string

static array formatParameters(mixed|array $parameters)

No description

Parameters

mixed|array

$parameters

Return Value

array

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

No description

Parameters

string	$scheme
string\|null	$root

Return Value

string

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

No description

Parameters

string	$root
string	$path
Route\|null	$route

Return Value

string

static bool isValidUrl(string $path)

No description

Parameters

string

$path

Return Value

bool

static void defaults(array $defaults)

No description

Parameters

array

$defaults

Return Value

void

static array getDefaultParameters()

No description

Return Value

array

static void forceScheme(string|null $scheme)

No description

Parameters

string|null

$scheme

Return Value

void

static void forceRootUrl(string|null $root)

No description

Parameters

string|null

$root

Return Value

void

static UrlGenerator formatHostUsing(Closure $callback)

No description

Parameters

Closure

$callback

Return Value

UrlGenerator

static UrlGenerator formatPathUsing(Closure $callback)

No description

Parameters

Closure

$callback

Return Value

UrlGenerator

static Closure pathFormatter()

No description

Return Value

Closure

static Request getRequest()

No description

Return Value

Request

static void setRequest(Request $request)

No description

Parameters

Request

$request

Return Value

void

static UrlGenerator setRoutes(RouteCollectionInterface $routes)

No description

Parameters

RouteCollectionInterface

$routes

Return Value

UrlGenerator

static UrlGenerator setSessionResolver(callable $sessionResolver)

No description

Parameters

callable

$sessionResolver

Return Value

UrlGenerator

static UrlGenerator setKeyResolver(callable $keyResolver)

No description

Parameters

callable

$keyResolver

Return Value

UrlGenerator

static UrlGenerator withKeyResolver(callable $keyResolver)

No description

Parameters

callable

$keyResolver

Return Value

UrlGenerator

static string getRootControllerNamespace()

No description

Return Value

string

static UrlGenerator setRootControllerNamespace(string $rootNamespace)

No description

Parameters

string

$rootNamespace

Return Value

UrlGenerator

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

No description

Parameters

string	$name
object\|callable	$macro

Return Value

void

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

No description

Parameters

object	$mixin
bool	$replace

Return Value

void

static bool hasMacro(string $name)

No description

Parameters

string

$name

Return Value

bool

static void flushMacros()

No description

Return Value

void

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/10.x/Illuminate/Support/Facades/URL.html