Класс CookieCollection

__construct()source public deprecated

__construct( array $cookies = [] )

Конструктор

Параметры

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

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

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

convertCookieToArray()source protected deprecated

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

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

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

Параметры

Cake\Http\Cookie\CookieInterface $cookie

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

Возвращает

get()source public deprecated

get( string $url )

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

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

Параметры

строка $url

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

Возвращает

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

getAll()source public deprecated

getAll( )

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

Возвращает

store()source public deprecated

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

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

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

Параметры

Cake\Http\Client\Response $response

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

строка $url

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

add()source public

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

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

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

Параметры

Cake\Http\Cookie\CookieInterface $cookie

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

Возвращает

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.

Возвращает

addToRequest()source public

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

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

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

Параметры

Psr\Http\Message\RequestInterface $request

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

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

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

Возвращает

checkCookies()source protected

checkCookies( array $cookies )

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

Параметры

массив $cookies

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

Выбрасывает

count()source public

count( )

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

Возвращает

Реализация

createFromHeader()source public static

createFromHeader( array $header )

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

Параметры

массив $header

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

Возвращает

createFromServerRequest()source public static

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

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

Параметры

Psr\Http\Message\ServerRequestInterface $request

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

Возвращает

findMatchingCookies()source protected

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

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

Параметры

строка $scheme

HTTP-схема для сопоставления

строка $host

Хост для сопоставления.

строка $path

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

Возвращает

getIterator()source public

getIterator( )

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

Возвращает

Реализация

has()source public

has( string $name )

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

Параметры

string $name

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

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

parseSetCookieHeader()source protected static

parseSetCookieHeader( array $values )

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

Параметры

array $values

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

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

remove()source public

remove( string $name )

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

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

Параметры

string $name

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

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

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

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

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