Класс CookieCollection

__construct()source public

__construct( array $cookies [] )

Конструктор

Параметры

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

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

add()source public

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

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

Куки хранятся по id. Это означает, что могут быть дублированные куки, если коллекция куки используется для куки на нескольких доменах. Это может повлиять на поведение 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 )

Создать новую коллекцию, которая включает куки из ответа.

Параметры

Psr\Http\Message\ResponseInterface $response

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

Psr\Http\Message\RequestInterface $request

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

Возвращает

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 )

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

Параметры

массив $cookies

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

Вызывает исключение

InvalidArgumentException

count()source public

count( )

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

Возвращает

целое число

Реализация

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 )

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

Параметры

Psr\Http\Message\ServerRequestInterface $request

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

Возвращает

Cake\Http\Cookie\CookieCollection

findMatchingCookies()source protected

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

Найти куки, соответствующие схеме, хосту и пути

Параметры

строка $scheme

Соответствующая схема http

строка $host

Соответствующий хост.

строка $path

Соответствующий путь

Возвращает

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

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.

[]