| Methods |
public
|
__construct(UriInterface|Stringable|string $uri = '')
Create a new parsed URI instance.
Create a new parsed URI instance.
|
#
|
public
static
|
of(UriInterface|Stringable|string $uri = ''): static
Create a new URI instance.
Create a new URI instance.
|
#
|
public
static
|
to(string $path): static
Get a URI instance of an absolute URL for the given path.
Get a URI instance of an absolute URL for the given path.
|
#
|
public
static
|
route(BackedEnum|string $name, mixed $parameters = [], bool $absolute = true): static
Get a URI instance for a named route.
Get a URI instance for a named route.
Throws
|
#
|
public
static
|
signedRoute(
BackedEnum|string $name,
mixed $parameters = [],
DateTimeInterface|DateInterval|int|null $expiration = null,
bool $absolute = true,
): static
Create a signed route URI instance for a named route.
Create a signed route URI instance for a named route.
Throws
|
#
|
public
static
|
temporarySignedRoute(
BackedEnum|string $name,
DateTimeInterface|DateInterval|int $expiration,
array $parameters = [],
bool $absolute = true,
): static
Create a temporary signed route URI instance for a named route.
Create a temporary signed route URI instance for a named route.
|
#
|
public
static
|
action(string|array $action, mixed $parameters = [], bool $absolute = true): static
Get a URI instance for a controller action.
Get a URI instance for a controller action.
Throws
|
#
|
public
|
scheme(): ?string
Get the URI's scheme.
|
#
|
public
|
user(bool $withPassword = false): ?string
Get the user from the URI.
Get the user from the URI.
|
#
|
public
|
password(): ?string
Get the password from the URI.
Get the password from the URI.
|
#
|
public
|
host(): ?string
Get the URI's host.
|
#
|
public
|
port(): ?int
Get the URI's port.
|
#
|
public
|
path(): ?string
Get the URI's path.
Get the URI's path.
Empty or missing paths are returned as a single "/".
|
#
|
public
|
pathSegments(): Collection
Get the URI's path segments.
Get the URI's path segments.
Empty or missing paths are returned as an empty collection.
|
#
|
public
|
query(): UriQueryString
Get the URI's query string.
Get the URI's query string.
|
#
|
public
|
fragment(): ?string
Get the URI's fragment.
|
#
|
public
|
withScheme(Stringable|string $scheme): static
Specify the scheme of the URI.
Specify the scheme of the URI.
|
#
|
public
|
withUser(Stringable|string|null $user, Stringable|string|null $password = null): static
Specify the user and password for the URI.
Specify the user and password for the URI.
|
#
|
public
|
withHost(Stringable|string $host): static
Specify the host of the URI.
Specify the host of the URI.
|
#
|
public
|
withPort(?int $port): static
Specify the port of the URI.
Specify the port of the URI.
|
#
|
public
|
withPath(Stringable|string $path): static
Specify the path of the URI.
Specify the path of the URI.
|
#
|
public
|
withQuery(array $query, bool $merge = true): static
Merge new query parameters into the URI.
Merge new query parameters into the URI.
|
#
|
public
|
withQueryIfMissing(array $query): static
Merge new query parameters into the URI if they are not already in the query string.
Merge new query parameters into the URI if they are not already in the query string.
|
#
|
public
|
pushOntoQuery(string $key, mixed $value): static
Push a value onto the end of a query string parameter that is a list.
Push a value onto the end of a query string parameter that is a list.
|
#
|
public
|
withoutQuery(array|string $keys): static
Remove the given query parameters from the URI.
Remove the given query parameters from the URI.
|
#
|
public
|
replaceQuery(array $query): static
Specify new query parameters for the URI.
Specify new query parameters for the URI.
|
#
|
public
|
withFragment(string $fragment): static
Specify the fragment of the URI.
Specify the fragment of the URI.
|
#
|
public
|
redirect(int $status = 302, array $headers = []): RedirectResponse
Create a redirect HTTP response for the given URI.
Create a redirect HTTP response for the given URI.
|
#
|
public
|
toResponse(Request $request): Response
Create an HTTP response that represents the object.
Create an HTTP response that represents the object.
Implements
|
#
|
public
|
toHtml(): string
Get content as a string of HTML.
Get content as a string of HTML.
Implements
|
#
|
public
|
decode(): string
Get the decoded string representation of the URI.
Get the decoded string representation of the URI.
|
#
|
public
|
value(): string
Get the string representation of the URI.
Get the string representation of the URI.
|
#
|
public
|
isEmpty(): bool
Determine if the URI is currently an empty string.
Determine if the URI is currently an empty string.
|
#
|
public
|
dump(mixed ...$args): $this
Dump the string representation of the URI.
Dump the string representation of the URI.
|
#
|
public
static
|
setUrlGeneratorResolver(Closure $urlGeneratorResolver): void
Set the URL generator resolver.
Set the URL generator resolver.
|
#
|
public
|
getUri(): UriInterface
Get the underlying URI instance.
Get the underlying URI instance.
|
#
|
public
|
__toString(): string
Get the string representation of the URI.
Get the string representation of the URI.
Implements
|
#
|