Класс CookieCollection

__construct()source public

__construct( array $cookies = [] )

Конструктор

Параметры

массив $cookies необязательно []

Массив объектов cookie

add()source public

add( Cake\Http\Cookie\CookieInterface $cookie )

Добавить файл cookie и получить обновлённую коллекцию.

Файлы cookie хранятся по идентификатору. Это означает, что могут быть дублирующиеся файлы cookie, если коллекция файлов cookie используется для файлов cookie на нескольких доменах. Это может повлиять на поведение get(), has() и remove().

Параметры

Cake\Http\Cookie\CookieInterface $cookie

Экземпляр cookie для добавления.

Возвращает

Cake\Http\Cookie\CookieCollection

addFromResponse()source public

addFromResponse( Psr\Http\Message\ResponseInterface $response , Psr\Http\Message\RequestInterface $request )

Создать новую коллекцию, включающую файлы cookie из ответа.

Параметры

Psr\Http\Message\ResponseInterface $response

Ответ для извлечения файлов cookie.

Psr\Http\Message\RequestInterface $request

Запрос для получения контекста cookie.

Возвращает

Cake\Http\Cookie\CookieCollection

addToRequest()source public

addToRequest( Psr\Http\Message\RequestInterface $request , array $extraCookies = [] )

Добавить файлы cookie, соответствующие пути/домену/сроку действия, в запрос.

Это позволяет использовать CookieCollection в качестве «банка файлов cookie» в ситуации с HTTP-клиентом. Файлы cookie, соответствующие домену и пути запроса, которые не истекли на момент вызова этого метода, будут применены к запросу.

Параметры

Psr\Http\Message\RequestInterface $request

Запрос для обновления.

массив $extraCookies необязательно []

Ассоциативный массив дополнительных файлов cookie для добавления в запрос. Это полезно, когда у вас есть данные о файлах cookie извне коллекции, которые вы хотите отправить.

Возвращает

Psr\Http\Message\RequestInterface
Обновлённый запрос.

checkCookies()source protected

checkCookies( array $cookies )

Проверяет, содержатся ли в массиве только допустимые объекты cookie

Параметры

массив $cookies

Массив объектов cookie

Исключения

InvalidArgumentException

count()source public

count( )

Получить количество файлов cookie в коллекции.

Возвращает

целое число

Реализация

Countable::count()

createFromHeader()source public static

createFromHeader( array $header )

Создать коллекцию файлов cookie из массива заголовков Set-Cookie

Параметры

массив $header

Массив значений заголовка set-cookie.

Возвращает

Cake\Http\Cookie\CookieCollection

createFromServerRequest()source public static

createFromServerRequest( Psr\Http\Message\ServerRequestInterface $request )

Создать новую коллекцию из файлов cookie в ServerRequest

Параметры

Psr\Http\Message\ServerRequestInterface $request

Запрос для извлечения данных о файлах cookie

Возвращает

Cake\Http\Cookie\CookieCollection

findMatchingCookies()source protected

findMatchingCookies( string $scheme , string $host , string $path )

Найти файлы cookie, соответствующие схеме, хосту и пути

Параметры

строка $scheme

Схема http для соответствия

строка $host

Хост для соответствия.

строка $path

Путь для соответствия

Возвращает

массив
Массив пар имя/значение cookie

get()source public

get( string $name )

Получить первый файл cookie по имени.

Параметры

строка $name

Имя файла cookie.

Возвращает

Cake\Http\Cookie\CookieInterface|null

getIterator()source public

getIterator( )

Получить итератор

Возвращает

ArrayIterator

Реализация

IteratorAggregate::getIterator()

has()source public

has( string $name )

Проверка наличия cookie с заданным именем

Параметры

string $name

Имя cookie для проверки.

Возвращает

boolean
True, если cookie существует, иначе false.

parseSetCookieHeader()source protected static

parseSetCookieHeader( array $values )

Разбор заголовков Set-Cookie в массив

Параметры

array $values

Список значений заголовков Set-Cookie.

Возвращает

Cake\Http\Cookie\Cookie[]
Массив объектов cookie

remove()source public

remove( string $name )

Создает новую коллекцию со всеми cookie, соответствующими $name, удаленными.

Если cookie нет в коллекции, этот метод ничего не сделает.

Параметры

string $name

Имя cookie для удаления.

Возвращает

Cake\Http\Cookie\CookieCollection

removeExpiredCookies()source protected

removeExpiredCookies( string $host , string $path )

Удаление истекших cookie из коллекции.

Параметры

string $host

Хост для проверки истекших cookie.

string $path

Путь для проверки истекших cookie.

setRequestDefaults()source protected

setRequestDefaults( array $cookies , string $host , string $path )

Применение пути и хоста к набору cookie, если они не заданы.

Параметры

array $cookies

Массив cookie для обновления.

string $host

Хост для установки.

string $path

Путь для установки.

Возвращает

array
Массив обновленных cookie.

[]