Cookie
in package
Отдельная HTTP-cookie (RFC 6265).
Неизменяемый носитель имени, значения и атрибутов области действия (домен,
путь, срок жизни, флаги Secure/HttpOnly/host-only). Умеет проверять свою
применимость к адресу и срок годности.
Table of Contents
Methods
- __construct() : mixed
- domain() : string
- Домен области действия.
- expires() : int|null
- Метка времени истечения.
- fromArray() : self
- Восстановить cookie из массива.
- isExpired() : bool
- Истекла ли cookie к указанному моменту.
- isSession() : bool
- Является ли cookie сессионной (без срока жизни).
- matches() : bool
- Применима ли cookie к указанному адресу.
- name() : string
- Имя cookie.
- path() : string
- Путь области действия.
- storageKey() : string
- Уникальный ключ хранения (домен + путь + имя).
- toArray() : array{name: string, value: string, domain: string, path: string, expires: int|null, secure: bool, httpOnly: bool, hostOnly: bool}
- Сериализовать cookie в массив (для сохранения в файл).
- toHeaderPair() : string
- Представление cookie для заголовка `Cookie` (`name=value`).
- value() : string
- Значение cookie.
Methods
__construct()
public
__construct(string $name, string $value, string $domain[, string $path = '/' ][, int|null $expires = null ][, bool $secure = false ][, bool $httpOnly = false ][, bool $hostOnly = false ]) : mixed
Parameters
- $name : string
-
имя cookie
- $value : string
-
значение cookie
- $domain : string
-
домен области действия (без ведущей точки)
- $path : string = '/'
-
путь области действия
- $expires : int|null = null
-
метка времени истечения (Unix) или
nullдля сессионной - $secure : bool = false
-
требуется ли защищённое соединение
- $httpOnly : bool = false
-
недоступна ли cookie из скриптов (информативно)
- $hostOnly : bool = false
-
применима ли только к точному хосту
domain()
Домен области действия.
public
domain() : string
Return values
string —домен
expires()
Метка времени истечения.
public
expires() : int|null
Return values
int|null —Unix-время или null для сессионной cookie
fromArray()
Восстановить cookie из массива.
public
static fromArray(array{name: string, value: string, domain: string, path: string, expires: int|null, secure: bool, httpOnly: bool, hostOnly: bool} $data) : self
Parameters
- $data : array{name: string, value: string, domain: string, path: string, expires: int|null, secure: bool, httpOnly: bool, hostOnly: bool}
-
представление cookie
Return values
self —восстановленная cookie
isExpired()
Истекла ли cookie к указанному моменту.
public
isExpired(int $now) : bool
Parameters
- $now : int
-
текущее Unix-время
Return values
bool —true, если cookie просрочена
isSession()
Является ли cookie сессионной (без срока жизни).
public
isSession() : bool
Return values
bool —true, если срок жизни не задан
matches()
Применима ли cookie к указанному адресу.
public
matches(Uri $uri, int $now) : bool
Parameters
- $uri : Uri
-
адрес запроса
- $now : int
-
текущее Unix-время
Return values
bool —true, если cookie нужно отправить
name()
Имя cookie.
public
name() : string
Return values
string —имя
path()
Путь области действия.
public
path() : string
Return values
string —путь
storageKey()
Уникальный ключ хранения (домен + путь + имя).
public
storageKey() : string
Return values
string —ключ
toArray()
Сериализовать cookie в массив (для сохранения в файл).
public
toArray() : array{name: string, value: string, domain: string, path: string, expires: int|null, secure: bool, httpOnly: bool, hostOnly: bool}
Return values
array{name: string, value: string, domain: string, path: string, expires: int|null, secure: bool, httpOnly: bool, hostOnly: bool} —представление cookie
toHeaderPair()
Представление cookie для заголовка `Cookie` (`name=value`).
public
toHeaderPair() : string
Return values
string —пара «имя=значение»
value()
Значение cookie.
public
value() : string
Return values
string —значение