Класс 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 )

Создание CookieCollection из массива заголовков 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 с заданным именем

Параметры

строка $name

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

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

parseSetCookieHeader()source protected static

parseSetCookieHeader( array $values )

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

Параметры

массив $values

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

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

remove()source public

remove( string $name )

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

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

Параметры

строка $name

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

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

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

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

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