Класс CookieCollection

convertCookieToArray()source protected

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

Преобразовать файл cookie в массив его свойств.

В основном полезно в случаях, когда нужна обратная совместимость.

Параметры

Cake\Http\Cookie\CookieInterface $cookie

Объект файла cookie.

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

массив

get()source public

get( string $url )

Получить сохранённые файлы cookie для URL.

Находит соответствующие сохранённые файлы cookie и возвращает простой массив имени => значение

Параметры

строка $url

URL для поиска файлов cookie.

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

массив

Переопределяет

Cake\Http\Cookie\CookieCollection::get()

getAll()source public

getAll( )

Получить все сохранённые файлы cookie в виде массивов.

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

массив

store()source public

store( Cake\Http\Client\Response $response , string $url )

Сохранить файлы cookie из ответа.

Сохранить файлы cookie, которые не истекли. Если файл cookie истек и он сейчас хранится, он будет удалён.

Параметры

Cake\Http\Client\Response $response

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

строка $url

URL запроса, используемый для значений по умолчанию хоста/пути.

__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, соответствующие пути/домену/сроку действия, к запросу.

Это позволяет использовать CookieCollections в качестве «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 Collection из массива заголовков 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

getIterator()source public

getIterator( )

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

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

ArrayIterator

Реализация

IteratorAggregate::getIterator()

has()source public

has( string $name )

Проверить, существует ли файл cookie с заданным именем

Параметры

строка $name

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

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

логическое значение
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