CakePHP
  • Documentation
    • Book
    • API
    • Videos
    • Logos & Trademarks
  • Business Solutions
  • Swag
  • Road Trip
  • Team
  • Community
    • Community
    • Team
    • Issues (Github)
    • YouTube Channel
    • Get Involved
    • Bakery
    • Featured Resources
    • Newsletter
    • Certification
    • My CakePHP
    • CakeFest
    • Facebook
    • Twitter
    • Help & Support
    • Forum
    • Stack Overflow
    • IRC
    • Slack
    • Paid Support
CakePHP

C CakePHP 3.1 Red Velvet API

  • Overview
  • Tree
  • Deprecated
  • Version:
    • 3.1
      • 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

  • Cake
    • Auth
      • Storage
    • Cache
      • Engine
    • Collection
      • Iterator
    • Console
      • Exception
    • Controller
      • Component
      • Exception
    • Core
      • Configure
        • Engine
      • Exception
    • Database
      • Driver
      • Exception
      • Expression
      • Schema
      • Statement
      • Type
    • Datasource
      • Exception
    • Error
    • Event
    • Filesystem
    • Form
    • I18n
      • Formatter
      • Parser
    • Log
      • Engine
    • Mailer
      • Exception
      • Transport
    • Network
      • Exception
      • Http
        • Adapter
        • Auth
        • FormData
      • Session
    • ORM
      • Association
      • Behavior
        • Translate
      • Exception
      • Locator
      • Rule
    • Routing
      • Exception
      • Filter
      • Route
    • Shell
      • Helper
      • Task
    • TestSuite
      • Fixture
      • Stub
    • Utility
      • Exception
    • Validation
    • View
      • Exception
      • Form
      • Helper
      • Widget
  • None

Classes

  • Client
  • CookieCollection
  • FormData
  • Message
  • Request
  • Response

Class Request

Implements methods for HTTP requests.

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

Cake\Network\Http\Message
Extended by Cake\Network\Http\Request
Namespace: Cake\Network\Http
Location: Network/Http/Request.php

Inherited Constants

  • METHOD_DELETE, METHOD_GET, METHOD_HEAD, METHOD_OPTIONS, METHOD_PATCH, METHOD_POST, METHOD_PUT, METHOD_TRACE, STATUS_ACCEPTED, STATUS_CREATED, STATUS_FOUND, STATUS_MOVED_PERMANENTLY, STATUS_OK, STATUS_SEE_OTHER, STATUS_TEMPORARY_REDIRECT

Properties summary

  • $_body protected
    mixed
    Request body to send.
  • $_headers protected
    array
    Headers to be sent.
  • $_method protected
    string
    The HTTP method to use.
  • $_url protected
    string
    The URL to request.

Inherited Properties

  • _cookies, _version

Method Summary

  • 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

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

method() public ¶

method( string|null $method = null )

Get/Set the HTTP method.

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() 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

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

version() public ¶

version( string|null $version = null )

Get/Set HTTP version.

Parameters
string|null $version optional null
The HTTP version.
Returns

$this|string Either $this or the HTTP version.
Overrides
Cake\Network\Http\Message::version()

Methods inherited from Cake\Network\Http\Message

_normalizeHeader() protected ¶

_normalizeHeader( string $name )

Normalize header names to Camel-Case form.

Parameters
string $name
The header name to normalize.
Returns
string
Normalized header name.

body() 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() public ¶

cookies( )

Get all cookies

Returns
array

headers() public ¶

headers( )

Get all headers

Returns
array

Properties detail

$_body ¶

protected mixed

Request body to send.

$_headers ¶

protected array

Headers to be sent.

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

$_method ¶

protected string

The HTTP method to use.

self::METHOD_GET

$_url ¶

protected string

The URL to request.

Follow @CakePHP
#IRC
OpenHub
Rackspace
  • Business Solutions
  • Showcase
  • Documentation
  • Book
  • API
  • Videos
  • Logos & Trademarks
  • Community
  • Team
  • Issues (Github)
  • YouTube Channel
  • Get Involved
  • Bakery
  • Featured Resources
  • Newsletter
  • Certification
  • My CakePHP
  • CakeFest
  • Facebook
  • Twitter
  • Help & Support
  • Forum
  • Stack Overflow
  • IRC
  • Slack
  • Paid Support

Generated using CakePHP API Docs