Request (class)

cookiesource public

cookie( string $name , string|null $value null )

Get/Set cookie values.

Getting a cookie

$request->cookie('session');

Setting one cookie

$request->cookie('session', '123456');

Setting multiple headers

$request->cookie(['test' => 'value', 'split' => 'banana']);

Parameters

string $name

The name of the cookie to get/set

string|null $value optional null

Either the value or null when getting values.

Returns

mixed
Either $this or the cookie value.

headersource public

header( string|array|null $name null , string|null $value null )

Get/Set headers into the request.

You can get the value of a header, or set one/many headers. Headers are set / fetched in a case insensitive way.

Getting headers

$request->header('Content-Type');

Setting one header

$request->header('Content-Type', 'application/json');

Setting multiple headers

$request->header(['Connection' => 'close', 'User-Agent' => 'CakePHP']);

Parameters

string|array|null $name optional null

The name to get, or array of multiple values to set.

string|null $value optional null

The value to set for the header.

Returns

mixed
Either $this when setting or header value when getting.

methodsource public

method( string|null $method null )

Get/Set the HTTP method.

Parameters

string|null $method optional null

The method for the request.

Returns

mixed
$this|string Either this or the current method.

Throws

Cake\Core\Exception\Exception
On invalid methods.

urlsource public

url( string|null $url null )

Get/Set the url for the request.

Parameters

string|null $url optional null

The url for the request. Leave null for get

Returns

mixed
$this|string Either $this or the url value.

versionsource public

version( string|null $version null )

Get/Set HTTP version.

Parameters

string|null $version optional null

The HTTP version.

Returns

mixed
$this|string Either $this or the HTTP version.

Overrides

Cake\Network\Http\Message::version()

_normalizeHeadersource protected

_normalizeHeader( string $name )

Normalize header names to Camel-Case form.

Parameters

string $name

The header name to normalize.

Returns

string
Normalized header name.

bodysource public

body( string|null $body null )

Get/set the body for the message.

Parameters

string|null $body optional null

The body for the request. Leave null for get

Returns

mixed
Either $this or the body value.

cookiessource public

cookies( )

Get all cookies

Returns

array
array

headerssource public

headers( )

Get all headers

Returns

array
array

[
    'Connection' => 'close',
    'User-Agent' => 'CakePHP'
]

Cake\Network\Http\Message::METHOD_GET

[]

'1.1'