Класс CorsBuilder

Объект-помощник для определения заголовков Cross Origin Request.

Каждый из методов этого объекта предоставляет интерфейс «fluent». После того, как вы установите все необходимые заголовки, можно использовать метод 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
Нормализует происхождение до регулярных выражений и помещает их в массив.
allowCredentials() public
Разрешить передачу куки в запросах CORS.
allowHeaders() public
Разрешить передачу определённых заголовков в запросах CORS.
allowMethods() public
Установить список разрешённых HTTP-методов.
allowOrigin() public
Установить список разрешённых доменов.
build() public
Применить очереди заголовков к ответу.
exposeHeaders() public
Определить заголовки, которые клиентская библиотека/браузер может раскрыть для скриптинга.
maxAge() public
Определить время, в течение которого предварительный запрос OPTIONS действителен.

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

__construct()source public

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

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

Параметры

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

_normalizeDomains()source protected

_normalizeDomains( array $domains )

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

Параметры

массив $domains: Доменные имена для нормализации.

Возвращает

массив

allowCredentials()source public

allowCredentials( )

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

Возвращает

$this

allowHeaders()source public

allowHeaders( array $headers )

Разрешить передачу определённых заголовков в запросах CORS.

Параметры

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

Возвращает

$this

allowMethods()source public

allowMethods( array $methods )

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

Параметры

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

Возвращает

$this

allowOrigin()source public

allowOrigin( string|array $domain )

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

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

Параметры

строка|массив $domain: Разрешённые домены

Возвращает

$this

build()source public

build( )

Применить очереди заголовков к ответу.

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

Возвращает

Cake\Network\Response

exposeHeaders()source public

exposeHeaders( array $headers )

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

Параметры

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

Возвращает

$this

maxAge()source public

maxAge( integer $age )

Определить время, в течение которого предварительный запрос OPTIONS действителен.

Параметры

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

Возвращает

$this

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

$_headerssource

protected массив

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

[]

$_isSslsource

protected логическое значение

Было ли подключение по защищённому протоколу SSL.

$_originsource

protected строка

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

$_responsesource

protected Cake\Network\Response

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

© 2005–2016 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.
http://api.cakephp.org/3.2/class-Cake.Network.CorsBuilder.html