Class Request
Implements methods for HTTP requests.
Used by Cake\Http\Client to contain request information for making requests.
- Cake\Http\Client\Message
-
Cake\Http\Client\Request
implements
Psr\Http\Message\RequestInterface
uses
Zend\Diactoros\RequestTrait
Inherited Constants
Inherited Magic 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
Get/Set cookie values. -
header() public
Get/Set headers into the request. -
method() public
Get/Set the HTTP method. -
url() public
Get/Set the url for the request. -
version() public
Get/Set HTTP version.
Method Detail
__construct() 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() protected ¶
addHeaders( array $headers )
Add an array of headers to the request.
Parameters
- array $headers
- The headers to add.
body() 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
Either $this or the body value.
Overrides
cookie() 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']);
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
Either $this or the cookie value.
header() 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']);
Warning This method mutates the request in-place for backwards compatibility reasons, and is not part of the PSR7 interface.
Deprecated
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
Either $this when setting or header value when getting.
method() public ¶
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
Parameters
- string|null $method optional null
- The method for the request.
Returns
$this|string Either this or the current method.
Throws
url() public ¶
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
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() public ¶
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
Parameters
- string|null $version optional null
- The HTTP version.
Returns
$this|string Either $this or the HTTP version.