Spec-Zone.ru › Laravel 6

CookieJar

class CookieJar implements QueueingFactory (View source)

Свойства

static protected array $macros

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

from Macroable
protected string $path

Путь по умолчанию (если указан).

protected string $domain

Домен по умолчанию (если указан).

protected bool $secure

Настройка secure по умолчанию (по умолчанию false).

protected string $sameSite

Параметр SameSite по умолчанию (если указан).

protected Cookie[] $queued

Все куки, ожидающие отправки.

Трейты

InteractsWithTime
Macroable

Методы

int secondsUntil(DateTimeInterface|DateInterval|int $delay)

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

из InteractsWithTime
int availableAt(DateTimeInterface|DateInterval|int $delay = 0)

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

из 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
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, который действует «вечно» (пять лет).

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

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

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

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

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

Получить экземпляр очереди 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)

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

array getQueuedCookies()

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

Подробности

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

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

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

int

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

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

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.

Значение возвращаемого значения

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)

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

Параметры

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

Значение возвращаемого значения

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, действующий "вечно" (пять лет).

Параметры

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

Значение возвращаемого значения

Cookie

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

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

Параметры

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

Значение возвращаемого значения

Cookie

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

Определить, была ли кэширована cookie.

Parameters

string $key
string|null $path

Return Value

bool

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

Получить кэшированный экземпляр cookie.

Parameters

string $key
mixed $default
string|null $path

Return Value

Cookie

void queue(array ...$parameters)

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

Parameters

array ...$parameters

Return Value

void

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

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

Parameters

string $name
string|null $path

Return Value

void

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

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

Parameters

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

Return Value

array

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

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

Parameters

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

Return Value

$this

array getQueuedCookies()

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

Return Value

array

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

Spec-Zone.ru

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