1. class
  2. Illuminate
  3. \
  4. Support
  5. \
  6. Uri

Uri

class Uri implements Htmlable, Responsable, Stringable (View source)

Traits

Conditionable
Dumpable
Tappable

Properties

protected $uri

The URI instance.
static protected $urlGeneratorResolver

The URL generator resolver.

Methods

$this|TWhenReturnType
when($value = null, callable|null $callback = null, callable|null $default = null)

Apply the callback if the given "value" is (or resolves to) truthy.

from  Conditionable
$this|TUnlessReturnType
unless($value = null, callable|null $callback = null, callable|null $default = null)

Apply the callback if the given "value" is (or resolves to) falsy.

from  Conditionable
never
dd(mixed ...$args)

Dump the given arguments and terminate execution.

from  Dumpable
$this
dump(mixed ...$args)

Dump the string representation of the URI.

tap($callback = null)

Call the given Closure with this instance then return the instance.

from  Tappable
__construct(UriInterface|Stringable|string $uri = '')

Create a new parsed URI instance.

static Uri
of(UriInterface|Stringable|string $uri = '')

Create a new URI instance.

static Uri
to(string $path)

Get a URI instance of an absolute URL for the given path.

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

Get a URI instance for a named route.

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

Create a signed route URI instance for a named route.

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

Create a temporary signed route URI instance for a named route.

string|null
scheme()

Get the URI's scheme.

string|null
user(bool $withPassword = false)

Get the user from the URI.

string|null
password()

Get the password from the URI.

string|null
host()

Get the URI's host.

int|null
port()

Get the URI's port.

string|null
path()

Get the URI's path.

UriQueryString
query()

Get the URI's query string.

string|null
fragment()

Get the URI's fragment.

Uri
withScheme(Stringable|string $scheme)

Specify the scheme of the URI.

Uri
withUser(Stringable|string|null $user, Stringable|string|null $password = null)

Specify the user and password for the URI.

Uri
withHost(Stringable|string $host)

Specify the host of the URI.

Uri
withPort(int|null $port)

Specify the port of the URI.

Uri
withPath(Stringable|string $path)

Specify the path of the URI.

Uri
withQuery(array $query, bool $merge = true)

Merge new query parameters into the URI.

Uri
withQueryIfMissing(array $query)

Merge new query parameters into the URI if they are not already in the query string.

Uri
pushOntoQuery(string $key, mixed $value)

Push a value onto the end of a query string parameter that is a list.

Uri
withoutQuery(array|string $keys)

Remove the given query parameters from the URI.

Uri
replaceQuery(array $query)

Specify new query parameters for the URI.

Uri
withFragment(string $fragment)

Specify the fragment of the URI.

RedirectResponse
redirect(int $status = 302, array $headers = [])

Create a redirect HTTP response for the given URI.

Response
toResponse(Request $request)

Create an HTTP response that represents the object.

string
toHtml()

Get content as a string of HTML.

string
decode()

Get the decoded string representation of the URI.

string
value()

Get the string representation of the URI.

bool
isEmpty()

Determine if the URI is currently an empty string.

static void
setUrlGeneratorResolver(Closure $urlGeneratorResolver)

Set the URL generator resolver.

UriInterface
getUri()

Get the underlying URI instance.

string
__toString()

Get the string representation of the URI.

Details

in Conditionable at line 21
$this|TWhenReturnType when($value = null, callable|null $callback = null, callable|null $default = null)

Apply the callback if the given "value" is (or resolves to) truthy.

Parameters

$value
callable|null $callback
callable|null $default

Return Value

$this|TWhenReturnType

in Conditionable at line 53
$this|TUnlessReturnType unless($value = null, callable|null $callback = null, callable|null $default = null)

Apply the callback if the given "value" is (or resolves to) falsy.

Parameters

$value
callable|null $callback
callable|null $default

Return Value

$this|TUnlessReturnType

in Dumpable at line 13
never dd(mixed ...$args)

Dump the given arguments and terminate execution.

Parameters

mixed ...$args

Return Value

never

at line 361
$this dump(mixed ...$args)

Dump the string representation of the URI.

Parameters

mixed ...$args

Return Value

$this

in Tappable at line 13
tap($callback = null)

Call the given Closure with this instance then return the instance.

Parameters

$callback

at line 35
__construct(UriInterface|Stringable|string $uri = '')

Create a new parsed URI instance.

Parameters

UriInterface|Stringable|string $uri

at line 43
static Uri of(UriInterface|Stringable|string $uri = '')

Create a new URI instance.

Parameters

UriInterface|Stringable|string $uri

Return Value

Uri

at line 51
static Uri to(string $path)

Get a URI instance of an absolute URL for the given path.

Parameters

string $path

Return Value

Uri

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

Get a URI instance for a named route.

Parameters

BackedEnum|string $name
mixed $parameters
bool $absolute

Return Value

Uri

Exceptions

InvalidArgumentException

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

Create a signed route URI instance for a named route.

Parameters

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

Return Value

Uri

Exceptions

InvalidArgumentException

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

Create a temporary signed route URI instance for a named route.

Parameters

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

Return Value

Uri

at line 104
string|null scheme()

Get the URI's scheme.

Return Value

string|null

at line 112
string|null user(bool $withPassword = false)

Get the user from the URI.

Parameters

bool $withPassword

Return Value

string|null

at line 122
string|null password()

Get the password from the URI.

Return Value

string|null

at line 130
string|null host()

Get the URI's host.

Return Value

string|null

at line 138
int|null port()

Get the URI's port.

Return Value

int|null

at line 148
string|null path()

Get the URI's path.

Empty or missing paths are returned as a single "/".

Return Value

string|null

at line 158
UriQueryString query()

Get the URI's query string.

Return Value

UriQueryString

at line 166
string|null fragment()

Get the URI's fragment.

Return Value

string|null

at line 174
Uri withScheme(Stringable|string $scheme)

Specify the scheme of the URI.

Parameters

Stringable|string $scheme

Return Value

Uri

at line 182
Uri withUser(Stringable|string|null $user, Stringable|string|null $password = null)

Specify the user and password for the URI.

Parameters

Stringable|string|null $user
Stringable|string|null $password

Return Value

Uri

at line 190
Uri withHost(Stringable|string $host)

Specify the host of the URI.

Parameters

Stringable|string $host

Return Value

Uri

at line 198
Uri withPort(int|null $port)

Specify the port of the URI.

Parameters

int|null $port

Return Value

Uri

at line 206
Uri withPath(Stringable|string $path)

Specify the path of the URI.

Parameters

Stringable|string $path

Return Value

Uri

at line 214
Uri withQuery(array $query, bool $merge = true)

Merge new query parameters into the URI.

Parameters

array $query
bool $merge

Return Value

Uri

at line 244
Uri withQueryIfMissing(array $query)

Merge new query parameters into the URI if they are not already in the query string.

Parameters

array $query

Return Value

Uri

at line 260
Uri pushOntoQuery(string $key, mixed $value)

Push a value onto the end of a query string parameter that is a list.

Parameters

string $key
mixed $value

Return Value

Uri

at line 277
Uri withoutQuery(array|string $keys)

Remove the given query parameters from the URI.

Parameters

array|string $keys

Return Value

Uri

at line 285
Uri replaceQuery(array $query)

Specify new query parameters for the URI.

Parameters

array $query

Return Value

Uri

at line 293
Uri withFragment(string $fragment)

Specify the fragment of the URI.

Parameters

string $fragment

Return Value

Uri

at line 301
RedirectResponse redirect(int $status = 302, array $headers = [])

Create a redirect HTTP response for the given URI.

Parameters

int $status
array $headers

Return Value

RedirectResponse

at line 312
Response toResponse(Request $request)

Create an HTTP response that represents the object.

Parameters

Request $request

Return Value

Response

at line 322
string toHtml()

Get content as a string of HTML.

Return Value

string

at line 330
string decode()

Get the decoded string representation of the URI.

Return Value

string

at line 342
string value()

Get the string representation of the URI.

Return Value

string

at line 350
bool isEmpty()

Determine if the URI is currently an empty string.

Return Value

bool

at line 371
static void setUrlGeneratorResolver(Closure $urlGeneratorResolver)

Set the URL generator resolver.

Parameters

Closure $urlGeneratorResolver

Return Value

void

at line 379
UriInterface getUri()

Get the underlying URI instance.

Return Value

UriInterface

at line 387
string __toString()

Get the string representation of the URI.

Return Value

string