Request
class Request extends Request implements Arrayable, ArrayAccess (View source)
Traits
Properties
| static protected array | $macros | The registered string macros. |
from Macroable |
| protected InputBag|null | $json | The decoded JSON content for the request. |
|
| protected array | $convertedFiles | All of the converted files for the request. |
|
| protected Closure | $userResolver | The user resolver callback. |
|
| protected Closure | $routeResolver | The route resolver callback. |
Methods
Filter the given array of rules into an array of rules that are included in precognitive headers.
Determine if the request is attempting to be precognitive.
Determine if the current request probably expects a JSON response.
Determine if the current request is asking for JSON.
Determines whether the current requests accepts a given content type.
Return the most suitable content type from the given array based on content negotiation.
Determine if the current request accepts any content type.
Determine if the given content types match.
Get the data format expected in the response.
Flash only some of the input to the session.
Flash only some of the input to the session.
Retrieve all data from the instance.
Retrieve data from the instance.
Determine if the instance contains any of the given keys.
Apply the callback if the instance contains the given key.
Determine if the instance contains a non-empty value for the given key.
Determine if the instance contains an empty value for the given key.
Determine if the instance contains a non-empty value for any of the given keys.
Apply the callback if the instance contains a non-empty value for the given key.
Determine if the instance is missing a given key.
Apply the callback if the instance is missing the given key.
Determine if the given key is an empty string for "filled".
Retrieve data from the instance as a Stringable instance.
Retrieve data from the instance as a Stringable instance.
Retrieve data as a boolean value.
Retrieve data as an integer value.
Retrieve data as a float value.
Retrieve data from the instance as a Carbon instance.
Retrieve data from the instance as an enum.
Retrieve data from the instance as an array of enums.
Determine if the given enum class is backed.
Retrieve data from the instance as an array.
Retrieve data from the instance as a collection.
Get a subset containing the provided keys with values from the instance data.
Get all of the data except for a specified array of items.
Retrieve a server variable from the request.
Retrieve a header from the request.
Retrieve an input item from the request.
Retrieve input from the request as a Fluent object instance.
Retrieve a query string item from the request.
Retrieve a request payload item from the request.
Retrieve a cookie from the request.
Convert the given array of Symfony UploadedFiles to custom Laravel UploadedFiles.
Check that the given file is a valid file instance.
Retrieve a file from the request.
Retrieve a parameter item from a given source.
Apply the callback if the given "value" is (or resolves to) truthy.
Apply the callback if the given "value" is (or resolves to) falsy.
Mix another object into the class.
Dynamically handle calls to the class.
Dynamically handle calls to the class.
Return the Request instance.
Get the request method.
Get the root URL for the application.
Get the URL (no query string) for the request.
Get the full URL for the request.
Get the full URL for the request with the added query string parameters.
Get the full URL for the request without the given query string parameters.
Get the current path info for the request.
Get the current decoded path info for the request.
Get a segment from the URI (1 based index).
Get all of the segments for the request path.
Determine if the current request URI matches a pattern.
Determine if the route name matches a given pattern.
Determine if the current request URL and query string match a pattern.
Get the host name.
Get the HTTP host being requested.
Get the scheme and HTTP host.
Determine if the request is the result of an AJAX call.
Determine if the request is the result of a PJAX call.
Determine if the request is the result of a prefetch call.
Determine if the request is over HTTPS.
Get the client IP address.
Get the client IP addresses.
Get the client user agent.
Merge new input into the current request's input array.
Merge new input into the request's input, but only when that key is missing from the request.
Replace the input values for the current request.
This method belongs to Symfony HttpFoundation and is not usually needed when using Laravel.
Get the JSON payload for the request.
Get the input source for the request.
Create a new request instance from the given Laravel request.
Create an Illuminate request from a Symfony instance.
{@inheritdoc}
Filter the given array of files, removing any empty values.
{@inheritdoc}
{@inheritdoc}
Set the locale for the request instance.
Set the default locale for the request instance.
Get the user making the request.
Get the route handling the request.
Get a unique fingerprint for the request / route / IP address.
Set the JSON payload for the request.
Get the user resolver callback.
Get the route resolver callback.
Get all of the input and files for the request.
Determine if the given offset exists.
Get the value at the given offset.
Set the value at the given offset.
Remove the value at the given offset.
Check if an input element is set on the request.
Get an input element from the request.
No description
No description
No description
Details
array
filterPrecognitiveRules(array $rules)
Filter the given array of rules into an array of rules that are included in precognitive headers.
bool
accepts(string|array $contentTypes)
Determines whether the current requests accepts a given content type.
string|null
prefers(string|array $contentTypes)
Return the most suitable content type from the given array based on content negotiation.
string|array|null
old(string|null $key = null, Model|string|array|null $default = null)
Retrieve an old input item.
abstract protected mixed
data(string|null $key = null, mixed $default = null)
Retrieve data from the instance.
$this|mixed
whenHas(string $key, callable $callback, callable|null $default = null)
Apply the callback if the instance contains the given key.
bool
filled(string|array $key)
Determine if the instance contains a non-empty value for the given key.
bool
isNotFilled(string|array $key)
Determine if the instance contains an empty value for the given key.
bool
anyFilled(string|array $keys)
Determine if the instance contains a non-empty value for any of the given keys.
$this|mixed
whenFilled(string $key, callable $callback, callable|null $default = null)
Apply the callback if the instance contains a non-empty value for the given key.
$this|mixed
whenMissing(string $key, callable $callback, callable|null $default = null)
Apply the callback if the instance is missing the given key.
protected bool
isEmptyString(string $key)
Determine if the given key is an empty string for "filled".
Stringable
str(string $key, mixed $default = null)
Retrieve data from the instance as a Stringable instance.
Stringable
string(string $key, mixed $default = null)
Retrieve data from the instance as a Stringable instance.
bool
boolean(string|null $key = null, bool $default = false)
Retrieve data as a boolean value.
Returns true when value is "1", "true", "on", and "yes". Otherwise, returns false.
Carbon|null
date(string $key, string|null $format = null, string|null $tz = null)
Retrieve data from the instance as a Carbon instance.
array
only(array|mixed $keys)
Get a subset containing the provided keys with values from the instance data.
string|array|null
server(string|null $key = null, string|array|null $default = null)
Retrieve a server variable from the request.
string|array|null
header(string|null $key = null, string|array|null $default = null)
Retrieve a header from the request.
mixed
input(string|null $key = null, mixed $default = null)
Retrieve an input item from the request.
Fluent
fluent(array|string|null $key = null)
Retrieve input from the request as a Fluent object instance.
string|array|null
query(string|null $key = null, string|array|null $default = null)
Retrieve a query string item from the request.
string|array|null
post(string|null $key = null, string|array|null $default = null)
Retrieve a request payload item from the request.
string|array|null
cookie(string|null $key = null, string|array|null $default = null)
Retrieve a cookie from the request.
protected array
convertUploadedFiles(array $files)
Convert the given array of Symfony UploadedFiles to custom Laravel UploadedFiles.
UploadedFile|UploadedFile[]|array|null
file(string|null $key = null, mixed $default = null)
Retrieve a file from the request.
protected string|array|null
retrieveItem(string $source, string|null $key, string|array|null $default)
Retrieve a parameter item from a given source.
$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.
$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.
string
fullUrlWithQuery(array $query)
Get the full URL for the request with the added query string parameters.
string
fullUrlWithoutQuery(array|string $keys)
Get the full URL for the request without the given query string parameters.
string|null
segment(int $index, string|null $default = null)
Get a segment from the URI (1 based index).
bool
fullUrlIs(mixed ...$patterns)
Determine if the current request URL and query string match a pattern.
$this
mergeIfMissing(array $input)
Merge new input into the request's input, but only when that key is missing from the request.
mixed
get(string $key, mixed $default = null)
This method belongs to Symfony HttpFoundation and is not usually needed when using Laravel.
Instead, you may use the "input" method.
InputBag|mixed
json(string|null $key = null, mixed $default = null)
Get the JSON payload for the request.
static Request
createFrom(Request $from, Request|null $to = null)
Create a new request instance from the given Laravel request.
static Request
createFromBase(Request $request)
Create an Illuminate request from a Symfony instance.
Request
duplicate(array|null $query = null, array|null $request = null, array|null $attributes = null, array|null $cookies = null, array|null $files = null, array|null $server = null)
{@inheritdoc}
protected mixed
filterFiles(mixed $files)
Filter the given array of files, removing any empty values.
Route|object|string|null
route(string|null $param = null, mixed $default = null)
Get the route handling the request.