Класс CorsBuilder

Объект-строитель, помогающий в определении заголовков, связанных с запросами Cross Origin.

Каждый из методов этого объекта предоставляет интерфейс fluent. После того, как вы установили все желаемые заголовки, метод build() может быть использован для возвращения изменённого ответа.

Получить этот объект удобнее всего через Request::cors().

Пространство имён: Cake\Http
См.: \Cake\Http\Response::cors()
Расположение: Http/CorsBuilder.php

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

$_headers protected

array
Заголовки, которые были добавлены до этого момента.
$_isSsl protected

boolean
Было ли соединение по SSL.
$_origin protected

string
Значение заголовка Origin запроса
$_response protected

Psr\Http\Message\MessageInterface
Объект ответа, к которому прикреплён этот строитель.

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

__construct() public
Конструктор.
_normalizeDomains() protected
Нормализует источник до регулярных выражений и помещает в массив.
allowCredentials() public
Разрешает отправку куки в запросах CORS.
allowHeaders() public
Белый список заголовков, которые могут быть отправлены в запросах CORS.
allowMethods() public
Устанавливает список разрешённых HTTP-методов.
allowOrigin() public
Устанавливает список разрешённых доменов.
build() public
Применяет сохранённые заголовки к ответу.
exposeHeaders() public
Определяет заголовки, которые клиентская библиотека/браузер может экспонировать для скриптов.
maxAge() public
Определяет время жизни предварительного запроса OPTIONS.

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

__construct()source public

__construct( Psr\Http\Message\MessageInterface $response , string $origin , boolean $isSsl = false )

Конструктор.

Параметры

Psr\Http\Message\MessageInterface $response: Объект ответа, к которому добавляются заголовки.
string $origin: Заголовок Origin запроса.
boolean $isSsl необязательно false: Было ли соединение по SSL.

_normalizeDomains()source protected

_normalizeDomains( array $domains )

Нормализует источник до регулярных выражений и помещает в массив.

Параметры

array $domains: Имена доменов для нормализации.

Возвращает

array

allowCredentials()source public

allowCredentials( )

Разрешает отправку куки в запросах CORS.

Возвращает

$this

allowHeaders()source public

allowHeaders( array $headers )

Белый список заголовков, которые могут быть отправлены в запросах CORS.

Параметры

array $headers: Список заголовков для принятия в запросах CORS.

Возвращает

$this

allowMethods()source public

allowMethods( array $methods )

Устанавливает список разрешённых HTTP-методов.

Параметры

array $methods: Разрешённые HTTP-методы

Возвращает

$this

allowOrigin()source public

allowOrigin( string|array $domain )

Устанавливает список разрешённых доменов.

Принимает строку или массив доменов, для которых разрешён CORS. Можно использовать *.example.com подстановочные знаки для принятия поддоменов, или * для разрешения всех доменов.

Параметры

string|array $domain: Разрешённые домены

Возвращает

$this

build()source public

build( )

Применяет сохранённые заголовки к ответу.

Если у строителя нет источника, или если нет разрешённых доменов, или если разрешённые домены не совпадают с заголовком Origin, заголовки не будут применены.

Возвращает

Psr\Http\Message\MessageInterface
Новый экземпляр ответа с новыми заголовками.

exposeHeaders()source public

exposeHeaders( array $headers )

Определяет заголовки, которые клиентская библиотека/браузер может экспонировать для скриптов.

Параметры

array $headers: Список заголовков для экспонирования в ответах CORS

Возвращает

$this

maxAge()source public

maxAge( integer $age )

Определяет время жизни предварительного запроса OPTIONS.

Параметры

integer $age: Время жизни предварительного запроса OPTIONS в секундах

Возвращает

$this

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

$_headerssource

protected массив

Заголовки, которые были добавлены до этого момента.

[]

$_isSslsource

protected boolean

Было ли соединение по SSL.

$_originsource

protected строка

Значение заголовка Origin запроса

$_responsesource

protected Psr\Http\Message\MessageInterface

Объект ответа, к которому прикреплён этот строитель.

© 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.7/class-Cake.Http.CorsBuilder.html