Класс CookieCollection

__construct()source public deprecated

__construct( array $cookies = [] )

Конструктор

Параметры

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

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

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

convertCookieToArray()source protected deprecated

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

Преобразовать куки в массив его свойств.

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

Параметры

Cake\Http\Cookie\CookieInterface $cookie

Объект cookie.

Возвращает

get()source public deprecated

get( string $url )

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

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

Параметры

строка $url

URL для поиска куки.

Возвращает

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

getAll()source public deprecated

getAll( )

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

Возвращает

store()source public deprecated

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

Сохранить куки из ответа.

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

Параметры

Cake\Http\Client\Response $response

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

строка $url

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

add()source public

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

Добавить куки и получить обновлённый набор.

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

Параметры

Cake\Http\Cookie\CookieInterface $cookie

Объект cookie для добавления.

Возвращает

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.

Возвращает

addToRequest()source public

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

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

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

Параметры

Psr\Http\Message\RequestInterface $request

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

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

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

Возвращает

checkCookies()source protected

checkCookies( array $cookies )

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

Параметры

массив $cookies

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

Вызывает

count()source public

count( )

Получить количество куки в наборе.

Возвращает

Реализация

createFromHeader()source public static

createFromHeader( array $header )

Создать набор куки из массива заголовков Set-Cookie

Параметры

массив $header

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

Возвращает

createFromServerRequest()source public static

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

Создать новый набор из куки в ServerRequest

Параметры

Psr\Http\Message\ServerRequestInterface $request

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

Возвращает

findMatchingCookies()source protected

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

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

Параметры

строка $scheme

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

строка $host

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

строка $path

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

Возвращает

getIterator()source public

getIterator( )

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

Возвращает

Реализация

has()source public

has( string $name )

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

Параметры

строка $name

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

Возвращает

parseSetCookieHeader()source protected static

parseSetCookieHeader( array $values )

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

Параметры

массив $values

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

Возвращает

remove()source public

remove( string $name )

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

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

Параметры

строка $name

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

Возвращает

removeExpiredCookies()source protected

removeExpiredCookies( string $host , string $path )

Удаление истекших куки из коллекции.

Параметры

строка $host

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

строка $path

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

setRequestDefaults()source protected

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

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

Параметры

массив $cookies

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

строка $host

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

строка $path

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

Возвращает