CakePHP
  • Documentation
    • Book
    • API
    • Videos
    • Reporting Security Issues
    • Privacy Policy
    • Logos & Trademarks
  • Business Solutions
  • Swag
  • Road Trip
  • Team
  • Community
    • Community
    • Get Involved
    • Issues (Github)
    • Bakery
    • Featured Resources
    • Training
    • Meetups
    • My CakePHP
    • CakeFest
    • Newsletter
    • Linkedin
    • YouTube
    • Facebook
    • Twitter
    • Mastodon
    • Help & Support
    • Forum
    • Stack Overflow
    • IRC
    • Slack
    • Paid Support
CakePHP

C CakePHP 4.6 Strawberry API

  • Project:
    • CakePHP
      • CakePHP
      • Authentication
      • Authorization
      • Chronos
      • Elastic Search
      • Queue
  • Version:
    • 4.6
      • 5.2
      • 5.1
      • 5.0
      • 4.6
      • 4.5
      • 4.4
      • 4.3
      • 4.2
      • 4.1
      • 4.0
      • 3.10
      • 3.9
      • 3.8
      • 3.7
      • 3.6
      • 3.5
      • 3.4
      • 3.3
      • 3.2
      • 3.1
      • 3.0
      • 2.10
      • 2.9
      • 2.8
      • 2.7
      • 2.6
      • 2.5
      • 2.4
      • 2.3
      • 2.2
      • 2.1
      • 2.0
      • 1.3
      • 1.2

Namespaces

  • Global
  • Cake
    • Auth
    • Cache
    • Collection
    • Command
    • Console
    • Controller
    • Core
    • Database
    • Datasource
    • Error
    • Event
    • Filesystem
    • Form
    • Http
      • Client
        • Adapter
        • Auth
        • Exception
      • Cookie
      • Exception
      • Middleware
      • Session
      • TestSuite
    • I18n
    • Log
    • Mailer
    • Network
    • ORM
    • Routing
    • Shell
    • TestSuite
    • Utility
    • Validation
    • View

Class Request

Implements methods for HTTP requests.

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

Namespace: Cake\Http\Client

Constants

  • string
    METHOD_DELETE ¶
    'DELETE'

    HTTP DELETE method

  • string
    METHOD_GET ¶
    'GET'

    HTTP GET method

  • string
    METHOD_HEAD ¶
    'HEAD'

    HTTP HEAD method

  • string
    METHOD_OPTIONS ¶
    'OPTIONS'

    HTTP OPTIONS method

  • string
    METHOD_PATCH ¶
    'PATCH'

    HTTP PATCH method

  • string
    METHOD_POST ¶
    'POST'

    HTTP POST method

  • string
    METHOD_PUT ¶
    'PUT'

    HTTP PUT method

  • string
    METHOD_TRACE ¶
    'TRACE'

    HTTP TRACE method

  • int
    STATUS_ACCEPTED ¶
    202

    HTTP 202 code

  • int
    STATUS_CREATED ¶
    201

    HTTP 201 code

  • int
    STATUS_FOUND ¶
    302

    HTTP 302 code

  • int
    STATUS_MOVED_PERMANENTLY ¶
    301

    HTTP 301 code

  • int
    STATUS_NON_AUTHORITATIVE_INFORMATION ¶
    203

    HTTP 203 code

  • int
    STATUS_NO_CONTENT ¶
    204

    HTTP 204 code

  • int
    STATUS_OK ¶
    200

    HTTP 200 code

  • int
    STATUS_PERMANENT_REDIRECT ¶
    308

    HTTP 308 code

  • int
    STATUS_SEE_OTHER ¶
    303

    HTTP 303 code

  • int
    STATUS_TEMPORARY_REDIRECT ¶
    307

    HTTP 307 code

Property Summary

  • $_cookies protected
    array

    The array of cookies in the response.

  • $headerNames protected
    array

    Map of normalized header name to original name used to register header.

  • $headers protected
    array

    List of all registered headers, as key => array of values.

Method Summary

  • __construct() public

    Constructor

  • addHeaders() protected

    Add an array of headers to the request.

  • cookies() public

    Get all cookies

  • getBody() public

    Gets the body of the message.

  • getHeader() public

    Retrieves a message header value by the given case-insensitive name.

  • getHeaderLine() public

    Retrieves a comma-separated string of the values for a single header.

  • getHeaders() public

    Retrieves all message headers.

  • getMethod() public

    Retrieves the HTTP method of the request.

  • getProtocolVersion() public

    Retrieves the HTTP protocol version as a string.

  • getRequestTarget() public

    Retrieves the message's request target.

  • getUri() public

    Retrieves the URI instance.

  • hasHeader() public

    Checks if a header exists by the given case-insensitive name.

  • setContent() protected

    Set the body/payload for the message.

  • withAddedHeader() public

    Return an instance with the specified header appended with the given value.

  • withBody() public

    Return an instance with the specified message body.

  • withHeader() public

    Return an instance with the provided header, replacing any existing values of any headers with the same case-insensitive name.

  • withMethod() public

    Return an instance with the provided HTTP method.

  • withProtocolVersion() public

    Return an instance with the specified HTTP protocol version.

  • withRequestTarget() public

    Create a new instance with a specific request-target.

  • withUri() public

    Returns an instance with the provided URI.

  • withoutHeader() public

    Return an instance without the specified header.

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

The HTTP method to use.

array $headers optional

The HTTP headers to set.

array|string|null $data optional

The request body to use.

addHeaders() ¶ protected

addHeaders(array<string, string> $headers): void

Add an array of headers to the request.

Parameters
array<string, string> $headers

The headers to add.

Returns
void

cookies() ¶ public

cookies(): array

Get all cookies

Returns
array

getBody() ¶ public

getBody(): StreamInterface

Gets the body of the message.

Returns
StreamInterface

getHeader() ¶ public

getHeader(string $header): string[]

Retrieves a message header value by the given case-insensitive name.

This method returns an array of all the header values of the given case-insensitive header name.

If the header does not appear in the message, this method MUST return an empty array.

Parameters
string $header

Case-insensitive header field name.

Returns
string[]

getHeaderLine() ¶ public

getHeaderLine(string $name): string

Retrieves a comma-separated string of the values for a single header.

This method returns all of the header values of the given case-insensitive header name as a string concatenated together using a comma.

NOTE: Not all header values may be appropriately represented using comma concatenation. For such headers, use getHeader() instead and supply your own delimiter when concatenating.

If the header does not appear in the message, this method MUST return an empty string.

Parameters
string $name

Case-insensitive header field name.

Returns
string

getHeaders() ¶ public

getHeaders(): array

Retrieves all message headers.

The keys represent the header name as it will be sent over the wire, and each value is an array of strings associated with the header.

// Represent the headers as a string foreach ($message->getHeaders() as $name => $values) { echo $name . ": " . implode(", ", $values); }

// Emit headers iteratively: foreach ($message->getHeaders() as $name => $values) { foreach ($values as $value) { header(sprintf('%s: %s', $name, $value), false); } }

Returns
array

getMethod() ¶ public

getMethod(): string

Retrieves the HTTP method of the request.

Returns
string

getProtocolVersion() ¶ public

getProtocolVersion(): string

Retrieves the HTTP protocol version as a string.

The string MUST contain only the HTTP version number (e.g., "1.1", "1.0").

Returns
string

getRequestTarget() ¶ public

getRequestTarget(): string

Retrieves the message's request target.

Retrieves the message's request-target either as it will appear (for clients), as it appeared at request (for servers), or as it was specified for the instance (see withRequestTarget()).

In most cases, this will be the origin-form of the composed URI, unless a value was provided to the concrete implementation (see withRequestTarget() below).

If no URI is available, and no request-target has been specifically provided, this method MUST return the string "/".

Returns
string

getUri() ¶ public

getUri(): UriInterface

Retrieves the URI instance.

This method MUST return a UriInterface instance.

Returns
UriInterface
Links
http://tools.ietf.org/html/rfc3986#section-4.3

hasHeader() ¶ public

hasHeader(string $header): bool

Checks if a header exists by the given case-insensitive name.

Parameters
string $header

Case-insensitive header name.

Returns
bool

setContent() ¶ protected

setContent(array|string $content): $this

Set the body/payload for the message.

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

Parameters
array|string $content

The body for the request.

Returns
$this

withAddedHeader() ¶ public

withAddedHeader(string $name, string|string[] $value): static

Return an instance with the specified header appended with the given value.

Existing values for the specified header will be maintained. The new value(s) will be appended to the existing list. If the header did not exist previously, it will be added.

This method MUST be implemented in such a way as to retain the immutability of the message, and MUST return an instance that has the new header and/or value.

Parameters
string $name

Case-insensitive header field name to add.

string|string[] $value

Header value(s).

Returns
static
Throws
Exception\InvalidArgumentException
For invalid header names or values.

withBody() ¶ public

withBody(StreamInterface $body): static

Return an instance with the specified message body.

The body MUST be a StreamInterface object.

This method MUST be implemented in such a way as to retain the immutability of the message, and MUST return a new instance that has the new body stream.

Parameters
StreamInterface $body

Body.

Returns
static
Throws
Exception\InvalidArgumentException
When the body is not valid.

withHeader() ¶ public

withHeader(string $name, string|string[] $value): static

Return an instance with the provided header, replacing any existing values of any headers with the same case-insensitive name.

While header names are case-insensitive, the casing of the header will be preserved by this function, and returned from getHeaders().

This method MUST be implemented in such a way as to retain the immutability of the message, and MUST return an instance that has the new and/or updated header and value.

Parameters
string $name

Case-insensitive header field name.

string|string[] $value

Header value(s).

Returns
static
Throws
Exception\InvalidArgumentException
For invalid header names or values.

withMethod() ¶ public

withMethod(string $method): static

Return an instance with the provided HTTP method.

While HTTP method names are typically all uppercase characters, HTTP method names are case-sensitive and thus implementations SHOULD NOT modify the given string.

This method MUST be implemented in such a way as to retain the immutability of the message, and MUST return an instance that has the changed request method.

Parameters
string $method

Case-insensitive method.

Returns
static
Throws
Exception\InvalidArgumentException
For invalid HTTP methods.

withProtocolVersion() ¶ public

withProtocolVersion(string $version): static

Return an instance with the specified HTTP protocol version.

The version string MUST contain only the HTTP version number (e.g., "1.1", "1.0").

This method MUST be implemented in such a way as to retain the immutability of the message, and MUST return an instance that has the new protocol version.

Parameters
string $version

HTTP protocol version

Returns
static

withRequestTarget() ¶ public

withRequestTarget(string $requestTarget): static

Create a new instance with a specific request-target.

If the request needs a non-origin-form request-target — e.g., for specifying an absolute-form, authority-form, or asterisk-form — this method may be used to create an instance with the specified request-target, verbatim.

This method MUST be implemented in such a way as to retain the immutability of the message, and MUST return a new instance that has the changed request target.

Parameters
string $requestTarget
Returns
static
Throws
Exception\InvalidArgumentException
If the request target is invalid.
Links
http://tools.ietf.org/html/rfc7230#section-2.7 (for the various request-target forms allowed in request messages)

withUri() ¶ public

withUri(UriInterface $uri, bool $preserveHost = false): static

Returns an instance with the provided URI.

This method will update the Host header of the returned request by default if the URI contains a host component. If the URI does not contain a host component, any pre-existing Host header will be carried over to the returned request.

You can opt-in to preserving the original state of the Host header by setting $preserveHost to true. When $preserveHost is set to true, the returned request will not update the Host header of the returned message -- even if the message contains no Host header. This means that a call to getHeader('Host') on the original request MUST equal the return value of a call to getHeader('Host') on the returned request.

This method MUST be implemented in such a way as to retain the immutability of the message, and MUST return an instance that has the new UriInterface instance.

Parameters
UriInterface $uri

New request URI to use.

bool $preserveHost optional

Preserve the original state of the Host header.

Returns
static
Links
http://tools.ietf.org/html/rfc3986#section-4.3

withoutHeader() ¶ public

withoutHeader(string $name): static

Return an instance without the specified header.

Header resolution MUST be done without case-sensitivity.

This method MUST be implemented in such a way as to retain the immutability of the message, and MUST return an instance that removes the named header.

Parameters
string $name

Case-insensitive header field name to remove.

Returns
static

Property Detail

$_cookies ¶ protected

The array of cookies in the response.

Type
array

$headerNames ¶ protected

Map of normalized header name to original name used to register header.

Type
array

$headers ¶ protected

List of all registered headers, as key => array of values.

Type
array
OpenHub
Pingping
Linode
  • Business Solutions
  • Showcase
  • Documentation
  • Book
  • API
  • Videos
  • Reporting Security Issues
  • Privacy Policy
  • Logos & Trademarks
  • Community
  • Get Involved
  • Issues (Github)
  • Bakery
  • Featured Resources
  • Training
  • Meetups
  • My CakePHP
  • CakeFest
  • Newsletter
  • Linkedin
  • YouTube
  • Facebook
  • Twitter
  • Mastodon
  • Help & Support
  • Forum
  • Stack Overflow
  • IRC
  • Slack
  • Paid Support

Generated using CakePHP API Docs