Spec-Zone.ru › CakePHP 3.8

Класс Request

Реализует методы для HTTP-запросов.

Используется Cake\Http\Client для хранения информации о запросе для отправки запросов.

Cake\Http\Client\Message
Extended by Cake\Http\Client\Request реализует Psr\Http\Message\RequestInterface использует Zend\Diactoros\RequestTrait
Пространство имён: Cake\Http\Client
Расположение: Http/Client/Request.php

Наследуемые константы

  • 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_NON_AUTHORITATIVE_INFORMATION, STATUS_NO_CONTENT, STATUS_OK, STATUS_SEE_OTHER, STATUS_TEMPORARY_REDIRECT

Наследуемые магические свойства

  • headers

Наследуемые свойства

  • _body, _cookies

Краткое описание методов

  • __construct() public
    Конструктор
  • addHeaders() protected
    Добавление массива заголовков к запросу.
  • body() public
    Получение/установка тела/загрузки для сообщения.
  • cookie() public deprecated
    Получение/установка значений cookie.
  • header() public deprecated
    Получение/установка заголовков в запросе.
  • method() public deprecated
    Получение/установка HTTP-метода.
  • url() public deprecated
    Получение/установка URL для запроса.
  • version() public deprecated
    Получение/установка версии HTTP.

Подробное описание методов

__construct()source public

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

Конструктор

Предоставляет обратную совместимость по умолчанию для некоторых свойств.

Параметры

string $url необязательно ''
URL запроса
string $method необязательно self::METHOD_GET
HTTP-метод, который нужно использовать.
array $headers необязательно []
HTTP-заголовки, которые нужно установить.
array|string|null $data необязательно null
Тело запроса для использования.

addHeaders()source protected

addHeaders( array $headers )

Добавление массива заголовков к запросу.

Параметры

array $headers
Заголовки для добавления.

body()source public

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

Получение/установка тела/загрузки для сообщения.

Данные массива будут сериализованы с помощью Cake\Http\FormData, и тип содержимого будет установлен.

Параметры

string|array|null $body необязательно null
Тело запроса. Оставьте null для получения

Возвращаемое значение

mixed
Либо $this, либо значение тела.

Переопределяет

Cake\Http\Client\Message::body()

cookie()source public deprecated

cookie( string $name , string|null $value = null )

Получение/установка значений cookie.

Получение cookie

$request->cookie('session');

Установка одной cookie

$request->cookie('session', '123456');

Установка нескольких заголовков

$request->cookie(['test' => 'value', 'split' => 'banana']);

Устарело

3.5.0 Больше не используется. CookieCollections теперь добавляют Cookie заголовок в запрос перед отправкой. Используйте Cake\Http\Cookie\CookieCollection::addToRequest(), чтобы упростить добавление cookie в запрос.


Параметры

string $name
Имя cookie для получения/установки
string|null $value необязательно null
Значение или null при получении значений.

Возвращаемое значение

mixed
Либо $this, либо значение cookie.

header()source public deprecated

header( string|array|null $name = null , string|null $value = null )

Получение/установка заголовков в запросе.

Вы можете получить значение заголовка или установить один/несколько заголовков. Заголовки устанавливаются/извлекаются нечувствительным к регистру способом.

Получение заголовков

$request->header('Content-Type');

Установка одного заголовка

$request->header('Content-Type', 'application/json');

Установка нескольких заголовков

$request->header(['Connection' => 'close', 'User-Agent' => 'CakePHP']);

Предупреждение Этот метод изменяет запрос на месте по соображениям обратной совместимости, и не является частью интерфейса PSR7.

Устарело

3.3.0 Используйте withHeader() и getHeaderLine() вместо этого.

Параметры

string|array|null $name необязательно null
Имя для получения или массив для установки нескольких значений.
string|null $value необязательно null
Значение для установки заголовка.

Возвращаемое значение

mixed
$this при установке или значение заголовка при получении.

method()source public deprecated

method( string|null $method = null )

Получение/установка HTTP-метода.

Предупреждение Этот метод изменяет запрос на месте по соображениям обратной совместимости, и не является частью интерфейса PSR7.

Устарело

3.3.0 Используйте getMethod() и withMethod() вместо этого.

Параметры

string|null $method необязательно null
Метод запроса.

Возвращаемое значение


$this|string Либо этот, либо текущий метод.

Выбрасывает

Cake\Core\Exception\Exception
При неверных методах.

url()source public deprecated

url( string|null $url = null )

Получение/установка URL для запроса.

Предупреждение Этот метод изменяет запрос на месте по соображениям обратной совместимости, и не является частью интерфейса PSR7.

Устарело

3.3.0 Используйте getUri() и withUri() вместо этого.

Параметры

string|null $url необязательно null
URL запроса. Оставьте null для получения

Возвращаемое значение


$this|string Либо $this, либо значение URL.

version()source public deprecated

version( string|null $version = null )

Получение/установка версии HTTP.

Предупреждение Этот метод изменяет запрос на месте по соображениям обратной совместимости, и не является частью интерфейса PSR7.

Устарело

3.3.0 Используйте getProtocolVersion() и withProtocolVersion() вместо этого.

Параметры

string|null $version необязательно null
Версия HTTP.

Возвращаемое значение


$this|string Либо $this, либо версия HTTP.

Методы, унаследованные от Cake\Http\Client\Message

cookies()source public

cookies( )

Получение всех cookie

Возвращаемое значение

array

headers()source public deprecated

headers( )

Получение всех заголовков

Устарело

3.3.0 Используйте getHeaders() вместо этого.

Возвращаемое значение

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API