Класс CorsBuilder

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

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

Самый удобный способ получить этот объект — Request::cors().

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

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

$_headers protected

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

boolean
Был ли запрос выполнен через SSL.
$_origin protected

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

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

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

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

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

__construct()source public

__construct( Cake\Network\Response $response , string $origin , boolean $isSsl false )

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

Параметры

Cake\Network\Response $response: Объект ответа, к которому нужно добавить заголовки.
string $origin: Значение заголовка Origin запроса.
boolean $isSsl optional false: Был ли запрос выполнен через SSL.

_normalizeDomains()source protected

_normalizeDomains( array $domains )

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

Параметры

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, или если нет разрешённых доменных имён, или если разрешённые доменные имена не совпадают с заголовком Origin, заголовки не будут применены.

Возвращает

Cake\Network\Response

exposeHeaders()source public

exposeHeaders( array $headers )

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

Параметры

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

Возвращает

$this

maxAge()source public

maxAge( integer $age )

Определить время жизни (max-age) предварительных запросов OPTIONS.

Параметры

integer $age: Время жизни (max-age) для запросов OPTIONS в секундах

Возвращает

$this

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

$_headerssource

protected array

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

[]

$_isSslsource

protected boolean

Был ли запрос выполнен через SSL.

$_originsource

protected string

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

$_responsesource

protected Cake\Network\Response

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

© 2005–2017 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.3/class-Cake.Network.CorsBuilder.html