W3cubDocs

/CakePHP 3.8

Class Request

Implements methods for HTTP requests.

Used by Cake\Http\Client to contain request information for making requests.

Cake\Http\Client\Message
Extended by Cake\Http\Client\Request implements Psr\Http\Message\RequestInterface uses Zend\Diactoros\RequestTrait
Namespace: Cake\Http\Client
Location: Http/Client/Request.php

Inherited Constants

Inherited Magic Properties

Inherited Properties

Method Summary

  • __construct() public
    Constructor
  • addHeaders() protected
    Add an array of headers to the request.
  • body() public
    Get/set the body/payload for the message.
  • cookie() public deprecated
    Get/Set cookie values.
  • header() public deprecated
    Get/Set headers into the request.
  • method() public deprecated
    Get/Set the HTTP method.
  • url() public deprecated
    Get/Set the url for the request.
  • version() public deprecated
    Get/Set HTTP version.

Method Detail

__construct()source public

__construct( string $url = '' , string $method = self::METHOD_GET , array $headers = [] , array|string|null $data = null )

Constructor

Provides backwards compatible defaults for some properties.

Parameters

string $url optional ''
The request URL
string $method optional self::METHOD_GET
The HTTP method to use.
array $headers optional []
The HTTP headers to set.
array|string|null $data optional null
The request body to use.

addHeaders()source protected

addHeaders( array $headers )

Add an array of headers to the request.

Parameters

array $headers
The headers to add.

body()source public

body( string|array|null $body = null )

Get/set the body/payload for the message.

Array data will be serialized with Cake\Http\FormData, and the content-type will be set.

Parameters

string|array|null $body optional null
The body for the request. Leave null for get

Returns

mixed
Either $this or the body value.

Overrides

Cake\Http\Client\Message::body()
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']);

Deprecated

3.5.0 No longer used. CookieCollections now add Cookie header to the request before sending. Use Cake\Http\Cookie\CookieCollection::addToRequest() to make adding cookies to a request easier.


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.

header()source public deprecated

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']);

Warning This method mutates the request in-place for backwards compatibility reasons, and is not part of the PSR7 interface.

Deprecated

3.3.0 Use withHeader() and getHeaderLine() instead.

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.

method()source public deprecated

method( string|null $method = null )

Get/Set the HTTP method.

Warning This method mutates the request in-place for backwards compatibility reasons, and is not part of the PSR7 interface.

Deprecated

3.3.0 Use getMethod() and withMethod() instead.

Parameters

string|null $method optional null
The method for the request.

Returns


$this|string Either this or the current method.

Throws

Cake\Core\Exception\Exception
On invalid methods.

url()source public deprecated

url( string|null $url = null )

Get/Set the url for the request.

Warning This method mutates the request in-place for backwards compatibility reasons, and is not part of the PSR7 interface.

Deprecated

3.3.0 Use getUri() and withUri() instead.

Parameters

string|null $url optional null
The url for the request. Leave null for get

Returns


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

version()source public deprecated

version( string|null $version = null )

Get/Set HTTP version.

Warning This method mutates the request in-place for backwards compatibility reasons, and is not part of the PSR7 interface.

Deprecated

3.3.0 Use getProtocolVersion() and withProtocolVersion() instead.

Parameters

string|null $version optional null
The HTTP version.

Returns


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

Methods inherited from Cake\Http\Client\Message

cookies()source public

cookies( )

Get all cookies

Returns

array

headers()source public deprecated

headers( )

Get all headers

Deprecated

3.3.0 Use getHeaders() instead.

Returns

array

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/3.8/class-Cake.Http.Client.Request.html