Класс CookieCollection

__construct()source public

__construct( array $cookies = [] )

Конструктор

Параметры

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

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

add()source public

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

Добавление куки и получение обновлённой коллекции.

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

Параметры

Cake\Http\Cookie\CookieInterface $cookie

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

Возвращает

Cake\Http\Cookie\CookieCollection

addFromResponse()source public

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

Создание новой коллекции, содержащей куки из ответа.

Параметры

Psr\Http\Message\ResponseInterface $response

Ответ для извлечения куки.

Psr\Http\Message\RequestInterface $request

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

Возвращает

Cake\Http\Cookie\CookieCollection

addToRequest()source public

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

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

Это позволяет использовать CookieCollections как «хранилище куки» в ситуации с HTTP-клиентом. Куки, соответствующие домену + пути запроса, которые не истекли на момент вызова этого метода, будут применены к запросу.

Параметры

Psr\Http\Message\RequestInterface $request

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

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

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

Возвращает

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

checkCookies()source protected

checkCookies( array $cookies )

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

Параметры

массив $cookies

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

Выбрасывает

InvalidArgumentException

count()source public

count( )

Получение количества куки в коллекции.

Возвращает

целое число

Реализация

Countable::count()

createFromHeader()source public static

createFromHeader( array $header )

Создание коллекции куки из массива заголовков Set-Cookie

Параметры

массив $header

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

Возвращает

Cake\Http\Cookie\CookieCollection

createFromServerRequest()source public static

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

Создание новой коллекции из куки в ServerRequest

Параметры

Psr\Http\Message\ServerRequestInterface $request

Запрос для извлечения данных куки

Возвращает

Cake\Http\Cookie\CookieCollection

findMatchingCookies()source protected

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

Поиск куки, соответствующих схеме, хосту и пути

Параметры

строка $scheme

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

строка $host

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

строка $path

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

Возвращает

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

get()source public

get( string $name )

Получение первой куки по имени.

Параметры

строка $name

Имя куки.

Возвращает

Cake\Http\Cookie\CookieInterface|null

getIterator()source public

getIterator( )

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

Возвращает

ArrayIterator

Реализация

IteratorAggregate::getIterator()

has()source public

has( string $name )

Проверка существования cookie с заданным именем

Параметры

строка $name

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

Возвращаемое значение

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

parseSetCookieHeader()source protected static

parseSetCookieHeader( array $values )

Парсинг заголовков Set-Cookie в массив

Параметры

массив $values

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

Возвращаемое значение

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

remove()source public

remove( string $name )

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

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

Параметры

строка $name

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

Возвращаемое значение

Cake\Http\Cookie\CookieCollection

removeExpiredCookies()source protected

removeExpiredCookies( string $host , string $path )

Удаление просроченных cookie из коллекции.

Параметры

строка $host

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

строка $path

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

setRequestDefaults()source protected

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

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

Параметры

массив $cookies

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

строка $host

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

строка $path

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

Возвращаемое значение

массив
Массив обновлённых cookie.

[]