CookieJar

class CookieJar implements QueueingFactory (View source)

Свойства

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

Методы

int

secondsUntil(DateTimeInterface|DateInterval|int $delay)

Получить количество секунд до заданного DateTime.

из InteractsWithTime

int

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

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

из InteractsWithTime

DateTimeInterface|int

parseDateInterval(DateTimeInterface|DateInterval|int $delay)

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

из InteractsWithTime

int

currentTime()

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

из 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 void

flushMacros()

Очистить существующие макросы.

из 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)

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

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

Истечь срок действия заданного куки.

Подробности

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

Получить количество секунд до заданного DateTime.

Параметры

DateTimeInterface|DateInterval|int

$delay

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

int

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

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

Параметры

DateTimeInterface|DateInterval|int

$delay

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

int

END_OF_DOCUMENT_MARKER

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

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

Параметры

DateTimeInterface|DateInterval|int

$delay

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

DateTimeInterface|int

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 void flushMacros()

Очистить существующие макрокоманды.

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

void

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)

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

Параметры

...

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

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)

Создать куки, который действует "вечно" (400 дней).

Параметры

...

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

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

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

Параметры

...

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

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

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

Параметры

...

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

bool

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

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

Параметры

...

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

Cookie|null

void queue(mixed ...$parameters)

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

Параметры

...

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

void

void expire(string $name, string|null $path = null, string|null $domain = null)

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

Параметры

...

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

void

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

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

Параметры

...

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

void

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

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

Параметры

...

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

array

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

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

Параметры

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

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

$this

array getQueuedCookies()

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

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

array

$this flushQueuedCookies()

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

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

$this

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