Класс CorsBuilder

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

Каждый из методов в этом объекте обеспечивает интерфейс флуента. После того, как вы установили все необходимые заголовки, метод 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 )

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

Параметры

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

Возвращает

$this

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

$_headerssource

protected массив

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

[]

$_isSslsource

protected булево

Является ли запрос защищенным SSL.

$_originsource

protected строка

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

$_responsesource

protected Cake\Http\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.4/class-Cake.Network.CorsBuilder.html