Spec-Zone.ru › Laravel 11

CookieJar

класс CookieJar реализует QueueingFactory (View source)

Черты

InteractsWithTime
Macroable

Свойства

static protected array $macros

Зарегистрированные строковые макросы.

 из Macroable
protected string $path

Путь по умолчанию (если указан).
protected string|null $domain

Домен по умолчанию (если указан).
protected bool|null $secure

Настройка безопасности по умолчанию (по умолчанию null).
protected string $sameSite

Параметр SameSite по умолчанию (по умолчанию lax).
protected Cookie[] $queued

Все файлы cookie, поставленные в очередь для отправки.

Методы

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.

 из InteractsWithTime
string runTimeForHumans(float $startTime, float $endTime = null)

Учитывая начальное время, отформатируйте общее время выполнения для удобочитаемости человеком.

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

Создать cookie, которая существует «вечно» (400 дней).
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)

Получить экземпляр файла cookie из очереди.
void queue(mixed ...$parameters)

Поставить в очередь файл cookie для отправки со следующим ответом.
void expire(string $name, string|null $path = null, string|null $domain = null)

Поставить в очередь файл cookie для истечения срока действия со следующим ответом.
void unqueue(string $name, string|null $path = null)

Удалить файл cookie из очереди.
array getPathAndDomain(string $path, string|null $domain, bool|null $secure = null, string|null $sameSite = null)

Получить путь и домен или значения по умолчанию.
$this setDefaultPathAndDomain(string $path, string|null $domain, bool|null $secure = false, string|null $sameSite = null)

Установить путь и домен по умолчанию для контейнера.
array getQueuedCookies()

Получить файлы cookie, которые были поставлены в очередь для следующего запроса.
$this flushQueuedCookies()

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

Подробности

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

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

Параметры

DateTimeInterface|DateInterval|int $delay

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

int
END_OF_DOCUMENT_MARKER

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

Получить временную метку UNIX для "доступности".

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

int

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

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

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

DateTimeInterface|int

protected int currentTime()

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

Return Value

int

protected string runTimeForHumans(float $startTime, float $endTime = null)

Учитывая начальное время, отформатировать общее время выполнения для удобного чтения человеком.

Parameters

float $startTime
float $endTime

Return Value

string

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

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

Parameters

string $name
object|callable $macro

Return Value

void

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

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

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

static bool hasMacro(string $name)

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

Parameters

string $name

Return Value

bool

static void flushMacros()

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

Return Value

void

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

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

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

mixed __call(string $method, array $parameters)

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

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

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.

Parameters

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

Return Value

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)

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

Parameters

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

Return Value

Cookie

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

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

Parameters

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

Return Value

Cookie

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

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

Parameters

string $key
string|null $path

Return Value

bool

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

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

Parameters

string $key
mixed $default
string|null $path

Return Value

Cookie|null

void queue(mixed ...$parameters)

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

Parameters

mixed ...$parameters

Return Value

void

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

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

Parameters

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

Return Value

void

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

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

Параметры

string $name
string|null $path

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

void

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

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

Параметры

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

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

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/11.x/Illuminate/Cookie/CookieJar.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API