Класс CorsBuilder

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

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

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

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

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

$_headers protected

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

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

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

Cake\Http\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\Http\Response $response , string $origin , boolean $isSsl false )

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

Параметры

Cake\Http\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\Http\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\Http\Response

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

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