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

Возвращает

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

exposeHeaders()source public

exposeHeaders( array $headers )

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

Параметры

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

Возвращает

$this

maxAge()source public

maxAge( integer $age )

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

Параметры

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

Возвращает

$this

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

$_headerssource

protected array

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

[]

$_isSslsource

protected boolean

Было ли подключение по протоколу SSL.

$_originsource

protected string

Значение заголовка 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.8/class-Cake.Http.CorsBuilder.html