Class Message

Base class for other HTTP requests/responses

Defines some common helper methods, constants and properties.

Direct Subclasses

Namespace: Cake\Http\Client
Location: Http/Client/Message.php

Constants summary

  • string

    METHOD_DELETE
    'DELETE'

  • string

    METHOD_GET
    'GET'

  • string

    METHOD_HEAD
    'HEAD'

  • string

    METHOD_OPTIONS
    'OPTIONS'

  • string

    METHOD_PATCH
    'PATCH'

  • string

    METHOD_POST
    'POST'

  • string

    METHOD_PUT
    'PUT'

  • string

    METHOD_TRACE
    'TRACE'

  • integer

    STATUS_ACCEPTED
    202

  • integer

    STATUS_CREATED
    201

  • integer

    STATUS_FOUND
    302

  • integer

    STATUS_MOVED_PERMANENTLY
    301

  • integer

    STATUS_NON_AUTHORITATIVE_INFORMATION
    203

  • integer

    STATUS_NO_CONTENT
    204

  • integer

    STATUS_OK
    200

  • integer

    STATUS_SEE_OTHER
    303

  • integer

    STATUS_TEMPORARY_REDIRECT
    307

Properties summary

  • $_body protected
    string|null
    Body for the message.
  • $_cookies protected
    array
    The array of cookies in the response.

Magic properties summary

Method Summary

  • body() public
    Get/set the body for the message.
  • cookies() public
    Get all cookies
  • headers() public deprecated
    Get all headers

Method Detail

body()source 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.

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

Properties detail

$_bodysource

protected string|null

Body for the message.

$_cookiessource

protected array

The array of cookies in the response.

[]

Magic properties detail

$headerssource

public 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.Message.html