1. class
  2. Illuminate
  3. \
  4. Http
  5. \
  6. Client
  7. \
  8. Request

Request

class Request implements ArrayAccess (View source)

Traits

Macroable

Properties

static protected array $macros

The registered string macros.

 from  Macroable
protected RequestInterface $request

The underlying PSR request.
protected array $data

The decoded payload for the request.

Methods

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

Register a custom macro.

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

Mix another object into the class.

from  Macroable
static bool
hasMacro(string $name)

Checks if macro is registered.

from  Macroable
static void
flushMacros()

Flush the existing macros.

from  Macroable
static mixed
__callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

from  Macroable
mixed
__call(string $method, array $parameters)

Dynamically handle calls to the class.

from  Macroable
__construct(RequestInterface $request)

Create a new request instance.

string
method()

Get the request method.

string
url()

Get the URL of the request.

bool
hasHeader(string $key, mixed $value = null)

Determine if the request has a given header.

bool
hasHeaders(array|string $headers)

Determine if the request has the given headers.

array
header(string $key)

Get the values for the header with the given name.

array
headers()

Get the request headers.

string
body()

Get the body of the request.

bool
hasFile(string $name, string|null $value = null, string|null $filename = null)

Determine if the request contains the given file.

array
data()

Get the request's data (form parameters or JSON).

array
parameters()

Get the request's form parameters.

array
json()

Get the JSON decoded body of the request.

bool
isForm()

Determine if the request is simple form data.

bool
isJson()

Determine if the request is JSON.

bool
isMultipart()

Determine if the request is multipart.

$this
withData(array $data)

Set the decoded data on the request.

RequestInterface
toPsrRequest()

Get the underlying PSR compliant request instance.

bool
offsetExists(string $offset)

Determine if the given offset exists.

mixed
offsetGet(string $offset)

Get the value for a given offset.

void
offsetSet(string $offset, mixed $value)

Set the value at the given offset.

void
offsetUnset(string $offset)

Unset the value at the given offset.

Details

in Macroable at line 29
static void macro(string $name, object|callable $macro)

Register a custom macro.

Parameters

string $name
object|callable $macro

Return Value

void

in Macroable at line 43
static void mixin(object $mixin, bool $replace = true)

Mix another object into the class.

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

in Macroable at line 62
static bool hasMacro(string $name)

Checks if macro is registered.

Parameters

string $name

Return Value

bool

in Macroable at line 72
static void flushMacros()

Flush the existing macros.

Return Value

void

in Macroable at line 86
static mixed __callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

in Macroable at line 112
mixed __call(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

at line 34
__construct(RequestInterface $request)

Create a new request instance.

Parameters

RequestInterface $request

at line 44
string method()

Get the request method.

Return Value

string

at line 54
string url()

Get the URL of the request.

Return Value

string

at line 66
bool hasHeader(string $key, mixed $value = null)

Determine if the request has a given header.

Parameters

string $key
mixed $value

Return Value

bool

at line 89
bool hasHeaders(array|string $headers)

Determine if the request has the given headers.

Parameters

array|string $headers

Return Value

bool

at line 110
array header(string $key)

Get the values for the header with the given name.

Parameters

string $key

Return Value

array

at line 120
array headers()

Get the request headers.

Return Value

array

at line 130
string body()

Get the body of the request.

Return Value

string

at line 143
bool hasFile(string $name, string|null $value = null, string|null $filename = null)

Determine if the request contains the given file.

Parameters

string $name
string|null $value
string|null $filename

Return Value

bool

at line 161
array data()

Get the request's data (form parameters or JSON).

Return Value

array

at line 177
protected array parameters()

Get the request's form parameters.

Return Value

array

at line 193
protected array json()

Get the JSON decoded body of the request.

Return Value

array

at line 207
bool isForm()

Determine if the request is simple form data.

Return Value

bool

at line 217
bool isJson()

Determine if the request is JSON.

Return Value

bool

at line 228
bool isMultipart()

Determine if the request is multipart.

Return Value

bool

at line 240
$this withData(array $data)

Set the decoded data on the request.

Parameters

array $data

Return Value

$this

at line 252
RequestInterface toPsrRequest()

Get the underlying PSR compliant request instance.

Return Value

RequestInterface

at line 263
bool offsetExists(string $offset)

Determine if the given offset exists.

Parameters

string $offset

Return Value

bool

at line 274
mixed offsetGet(string $offset)

Get the value for a given offset.

Parameters

string $offset

Return Value

mixed

at line 288
void offsetSet(string $offset, mixed $value)

Set the value at the given offset.

Parameters

string $offset
mixed $value

Return Value

void

Exceptions

LogicException

at line 301
void offsetUnset(string $offset)

Unset the value at the given offset.

Parameters

string $offset

Return Value

void

Exceptions

LogicException