CookieJar

class CookieJar implements QueueingFactory (View source)

Свойства

static protected array	$macros	Зарегистрированные строковые макросы.	из Macroable
protected string	$path	Путь по умолчанию (если задан).
protected string	$domain	Домен по умолчанию (если задан).
protected bool\|null	$secure	Настройка безопасного подключения по умолчанию (по умолчанию null).
protected string	$sameSite	Параметр SameSite по умолчанию (по умолчанию lax).
protected Cookie[]	$queued	Все куки, поставленные в очередь для отправки.

Трейты

InteractsWithTime

Macroable

Методы

int

secondsUntil(DateTimeInterface|DateInterval|int $delay)

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

из InteractsWithTime

int

availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Получить отметку времени «доступно в» в формате UNIX.

из InteractsWithTime

DateTimeInterface|int

parseDateInterval(DateTimeInterface|DateInterval|int $delay)

Если заданное значение — интервал, преобразовать его в экземпляр DateTime.

из InteractsWithTime

int

currentTime()

Получить текущее системное время в формате UNIX timestamp.

из InteractsWithTime

static void

macro(string $name, object|callable $macro)

Зарегистрировать пользовательский макрос.

из Macroable

static void

mixin(object $mixin, bool $replace = true)

Добавить другой объект в класс.

из Macroable

static bool

hasMacro(string $name)

Проверить, зарегистрирован ли макрос.

из Macroable

static mixed

__callStatic(string $method, array $parameters)

Динамически обработать вызовы к классу.

из Macroable

mixed

__call(string $method, array $parameters)

Динамически обработать вызовы к классу.

из Macroable

make(string $name, string $value, int $minutes = 0, string|null $path = null, string|null $domain = null, bool|null $secure = null, bool $httpOnly = true, bool $raw = false, string|null $sameSite = null)

Создать новый экземпляр Cookie.

forever(string $name, string $value, string|null $path = null, string|null $domain = null, bool|null $secure = null, bool $httpOnly = true, bool $raw = false, string|null $sameSite = null)

Создать cookie, действительный «вечно» (пять лет).

forget(string $name, string|null $path = null, string|null $domain = null)

Сбросить срок действия заданного cookie.

bool

hasQueued(string $key, string|null $path = null)

Определить, был ли cookie помещен в очередь.

Cookie|null

queued(string $key, mixed $default = null, string|null $path = null)

Получить экземпляр queued cookie.

void

queue(array ...$parameters)

Поместить cookie в очередь для отправки с последующим ответом.

void

unqueue(string $name, string|null $path = null)

Удалить cookie из очереди.

array

getPathAndDomain(string $path, string $domain, bool|null $secure = null, string|null $sameSite = null)

Получить путь и домен, или значения по умолчанию.

$this

setDefaultPathAndDomain(string $path, string $domain, bool $secure = false, string|null $sameSite = null)

Установить путь и домен по умолчанию для cookie.

array

getQueuedCookies()

Получить cookies, помещенные в очередь для следующего запроса.

Подробности

protected int secondsUntil(DateTimeInterface|DateInterval|int $delay)

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

Параметры

DateTimeInterface|DateInterval|int

$delay

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

int

protected int availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Получить отметку времени «доступно в» в формате UNIX.

Параметры

DateTimeInterface|DateInterval|int

$delay

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

int

protected DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)

Если заданное значение — интервал, преобразовать его в экземпляр DateTime.

Параметры

DateTimeInterface|DateInterval|int

$delay

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

DateTimeInterface|int

END_OF_DOCUMENT_MARKER

protected int currentTime()

Получить текущее системное время в формате временной метки Unix.

Значение возврата

int

static void macro(string $name, object|callable $macro)

Зарегистрировать пользовательскую макрокоманду.

Параметры

string	$name
object\|callable	$macro

Значение возврата

void

static void mixin(object $mixin, bool $replace = true)

Смешать другой объект в класс.

Параметры

object	$mixin
bool	$replace

Значение возврата

void

Исключения

ReflectionException

static bool hasMacro(string $name)

Проверить, зарегистрирована ли макрокоманда.

Параметры

string

$name

Значение возврата

bool

static mixed __callStatic(string $method, array $parameters)

Динамически обработать вызовы класса.

Параметры

string	$method
array	$parameters

Значение возврата

mixed

Исключения

BadMethodCallException

mixed __call(string $method, array $parameters)

Динамически обработать вызовы класса.

Параметры

string	$method
array	$parameters

Значение возврата

mixed

Исключения

BadMethodCallException

Cookie make(string $name, string $value, int $minutes = 0, string|null $path = null, string|null $domain = null, bool|null $secure = null, bool $httpOnly = true, bool $raw = false, string|null $sameSite = null)

Создать новый экземпляр куки.

Параметры

string	$name
string	$value
int	$minutes
string\|null	$path
string\|null	$domain
bool\|null	$secure
bool	$httpOnly
bool	$raw
string\|null	$sameSite

Значение возврата

Cookie forever(string $name, string $value, string|null $path = null, string|null $domain = null, bool|null $secure = null, bool $httpOnly = true, bool $raw = false, string|null $sameSite = null)

Создать куки, который действует «вечно» (пять лет).

Параметры

string	$name
string	$value
string\|null	$path
string\|null	$domain
bool\|null	$secure
bool	$httpOnly
bool	$raw
string\|null	$sameSite

Значение возврата

Cookie forget(string $name, string|null $path = null, string|null $domain = null)

Сбросить заданный куки.

Параметры

string	$name
string\|null	$path
string\|null	$domain

Значение возврата

END_OF_DOCUMENT_MARKER

bool hasQueued(string $key, string|null $path = null)

Определить, был ли куки помещён в очередь.

Параметры

string	$key
string\|null	$path

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

bool

Cookie|null queued(string $key, mixed $default = null, string|null $path = null)

Получить экземпляр куки из очереди.

Параметры

string	$key
mixed	$default
string\|null	$path

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

Cookie|null

void queue(array ...$parameters)

Поместить куки в очередь для отправки с последующим ответом.

Параметры

array

...$parameters

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

void

void unqueue(string $name, string|null $path = null)

Удалить куки из очереди.

Параметры

string	$name
string\|null	$path

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

void

protected array getPathAndDomain(string $path, string $domain, bool|null $secure = null, string|null $sameSite = null)

Получить путь и домен или значения по умолчанию.

Параметры

string	$path
string	$domain
bool\|null	$secure
string\|null	$sameSite

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

array

$this setDefaultPathAndDomain(string $path, string $domain, bool $secure = false, string|null $sameSite = null)

Установить путь и домен по умолчанию для jar.

Параметры

string	$path
string	$domain
bool	$secure
string\|null	$sameSite

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

$this

array getQueuedCookies()

Получить куки, помещенные в очередь для следующего запроса.

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

array

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/7.x/Illuminate/Cookie/CookieJar.html