CookieJar
in package
Хранилище cookie между запросами (RFC 6265).
Принимает cookie из заголовков Set-Cookie ответа, отдаёт применимые cookie
для заголовка Cookie следующего запроса, отбрасывает просроченные и умеет
сохранять/загружать постоянные cookie в файл (JSON).
Table of Contents
Methods
- all() : array<int, Cookie>
- Все хранящиеся cookie.
- clear() : void
- Очистить хранилище.
- clearSession() : void
- Удалить сессионные (без срока жизни) cookie.
- cookieHeader() : string
- Значение заголовка `Cookie` для адреса.
- count() : int
- Число хранящихся cookie.
- loadFrom() : void
- Загрузить cookie из файла (JSON), созданного {@see CookieJar::saveTo()}.
- saveTo() : void
- Сохранить постоянные cookie в файл (JSON).
- setFromResponse() : void
- Принять cookie из заголовков ответа.
- store() : void
- Сохранить cookie в хранилище (заменяя одноимённую по домену и пути).
Methods
all()
Все хранящиеся cookie.
public
all() : array<int, Cookie>
Return values
array<int, Cookie> —список cookie
clear()
Очистить хранилище.
public
clear() : void
clearSession()
Удалить сессионные (без срока жизни) cookie.
public
clearSession() : void
cookieHeader()
Значение заголовка `Cookie` для адреса.
public
cookieHeader(Uri $uri[, int|null $now = null ]) : string
Parameters
- $uri : Uri
-
адрес запроса
- $now : int|null = null
-
текущее Unix-время (по умолчанию — системное)
Return values
string —значение заголовка (пустая строка, если применимых cookie нет)
count()
Число хранящихся cookie.
public
count() : int
Return values
int —количество cookie
loadFrom()
Загрузить cookie из файла (JSON), созданного {@see CookieJar::saveTo()}.
public
loadFrom(string $path) : void
Parameters
- $path : string
-
путь к файлу
Tags
saveTo()
Сохранить постоянные cookie в файл (JSON).
public
saveTo(string $path) : void
Сессионные cookie не сохраняются.
Parameters
- $path : string
-
путь к файлу
Tags
setFromResponse()
Принять cookie из заголовков ответа.
public
setFromResponse(Uri $requestUri, Headers $headers[, int|null $now = null ]) : void
Parameters
store()
Сохранить cookie в хранилище (заменяя одноимённую по домену и пути).
public
store(Cookie $cookie) : void
Parameters
- $cookie : Cookie
-
сохраняемая cookie