Spec-Zone.ru › Laravel 11

TaggedCache

class TaggedCache extends Repository (View source)

Трейты

RetrievesMultipleKeys
InteractsWithTime
Macroable

Свойства

static protected array $macros

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

from Macroable
protected Store $store

Реализация хранилища кеша.

from Repository
protected Dispatcher|null $events

Реализация диспетчера событий.

from Repository
protected int|null $default

Стандартное количество секунд хранения элементов.

from Repository
protected array $config

Параметры конфигурации хранилища кеша.

from Repository
protected TagSet $tags

Экземпляр набора тегов.

Методы

int secondsUntil(DateTimeInterface|DateInterval|int $delay)

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

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

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

from InteractsWithTime
DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)

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

from InteractsWithTime
int currentTime()

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

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

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

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

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

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

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

from Macroable
static bool hasMacro(string $name)

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

from Macroable
static void flushMacros()

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

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

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

from Macroable
mixed __call(string $method, array $parameters)

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

from Macroable
void __construct(Store $store, TagSet $tags)

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

bool has(array|string $key)

Определить, существует ли элемент в кэше.

from Repository
bool missing(string $key)

Определить, не существует ли элемента в кэше.

from Repository
mixed get($key, $default = null)

Описание отсутствует

from Repository
array many(array $keys)

Получить несколько элементов из кэша по ключу.

from RetrievesMultipleKeys
iterable getMultiple($keys, $default = null)

{@inheritdoc}

from Repository
mixed handleManyResult(array $keys, string $key, mixed $value)

Обработать результат метода "many".

from Repository
pull($key, $default = null)

Описание отсутствует

from Repository
bool put(string $key, mixed $value, DateTimeInterface|DateInterval|int|null $ttl = null)

Сохранить элемент в кэше.

from Repository
bool set($key, $value, $ttl = null)

{@inheritdoc}

from Repository
bool putMany(array $values, DateTimeInterface|DateInterval|int|null $ttl = null)

Сохранить несколько элементов в кэше на заданное количество секунд.

bool putManyForever(array $values)

Сохранить несколько элементов в кэше на неопределённый срок.

from Repository
bool setMultiple($values, $ttl = null)

{@inheritdoc}

from Repository
bool add(string $key, mixed $value, DateTimeInterface|DateInterval|int|null $ttl = null)

Сохранить элемент в кэше, если ключ не существует.

from Repository
int|bool increment(string $key, mixed $value = 1)

Увеличить значение элемента в кэше.

int|bool decrement(string $key, mixed $value = 1)

Уменьшить значение элемента в кэше.

bool forever(string $key, mixed $value)

Сохранить элемент в кэше на неопределённый срок.

from Repository
remember($key, $ttl, Closure $callback)

Описание отсутствует

from Repository
sear($key, Closure $callback)

Описание отсутствует

from Repository
rememberForever($key, Closure $callback)

Описание отсутствует

from Repository
bool forget(string $key)

Удалить элемент из кеша.

из Репозитория
bool delete($key)

{@inheritdoc}

из Репозитория
bool deleteMultiple($keys)

{@inheritdoc}

из Репозитория
bool clear()

{@inheritdoc}

из Репозитория
TaggedCache tags(array|mixed $names)

Начать выполнение новой операции с метками, если хранилище её поддерживает.

из Репозитория
string itemKey(string $key)

Форматировать ключ для элемента кеша.

int getSeconds(DateTimeInterface|DateInterval|int $ttl)

Вычислить количество секунд для заданного TTL.

из Репозитория
string|null getName()

Получить имя хранилища кеша.

из Репозитория
bool supportsTags()

Определить, поддерживает ли текущее хранилище метки.

из Репозитория
int|null getDefaultCacheTime()

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

из Репозитория
$this setDefaultCacheTime(int|null $seconds)

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

из Репозитория
Store getStore()

Получить реализацию хранилища кеша.

из Репозитория
Repository setStore(Store $store)

Установить реализацию хранилища кеша.

из Репозитория
void event(object|string $event)

Вызвать событие для этого экземпляра кеша.

Dispatcher|null getEventDispatcher()

Получить экземпляр диспетчера событий.

из Репозитория
void setEventDispatcher(Dispatcher $events)

Установить экземпляр диспетчера событий.

из Репозитория
bool offsetExists(string $key)

Определить, существует ли кешированное значение.

из Репозитория
mixed offsetGet(string $key)

Получить элемент из кеша по ключу.

из Репозитория
void offsetSet(string $key, mixed $value)

Сохранить элемент в кеше на время по умолчанию.

из Репозитория
void offsetUnset(string $key)

Удалить элемент из кеша.

из Репозитория
void __clone()

Клонировать экземпляр репозитория кеша.

из Репозитория
bool flush()

Удалить все элементы из кеша.

string taggedItemKey(string $key)

Получить полностью квалифицированный ключ для помеченного элемента.

TagSet getTags()

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

Подробности

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

protected int currentTime()

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

Значение, возвращаемое функцией

int

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

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

Параметры

float $startTime
float $endTime

Значение, возвращаемое функцией

string

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

void __construct(Store $store, TagSet $tags)

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

Параметры

Store $store
TagSet $tags

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

void

bool has(array|string $key)

Определить, существует ли элемент в кэше.

Параметры

array|string $key

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

bool

bool missing(string $key)

Определить, не существует ли элемент в кэше.

Параметры

string $key

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

bool

mixed get($key, $default = null)

Нет описания

Параметры

$key
$default

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

mixed

array many(array $keys)

Получить несколько элементов из кэша по ключу.

Элементы, которых нет в кэше, будут иметь значение null.

Параметры

array $keys

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

array

iterable getMultiple($keys, $default = null)

{@inheritdoc}

Параметры

$keys
$default

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

iterable

protected mixed handleManyResult(array $keys, string $key, mixed $value)

Обработать результат метода «many».

Параметры

array $keys
string $key
mixed $value

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

mixed

pull($key, $default = null)

Нет описания

Параметры

$key
$default

bool put(string $key, mixed $value, DateTimeInterface|DateInterval|int|null $ttl = null)

Сохранить элемент в кэше.

Параметры

string $key
mixed $value
DateTimeInterface|DateInterval|int|null $ttl

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

bool

bool set($key, $value, $ttl = null)

{@inheritdoc}

Параметры

$key
$value
$ttl

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

bool

bool putMany(array $values, DateTimeInterface|DateInterval|int|null $ttl = null)

Сохранить несколько элементов в кэше на заданное количество секунд.

Параметры

array $values
DateTimeInterface|DateInterval|int|null $ttl

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

bool

protected bool putManyForever(array $values)

Сохранить несколько элементов в кэше на неопределённый срок.

Параметры

array $values

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

bool

bool setMultiple($values, $ttl = null)

{@inheritdoc}

Параметры

$values
$ttl

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

bool
END_OF_DOCUMENT_MARKER

bool add(string $key, mixed $value, DateTimeInterface|DateInterval|int|null $ttl = null)

Сохранить элемент в кэше, если ключ не существует.

Параметры

string $key
mixed $value
DateTimeInterface|DateInterval|int|null $ttl

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

bool

int|bool increment(string $key, mixed $value = 1)

Увеличить значение элемента в кэше.

Параметры

string $key
mixed $value

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

int|bool

int|bool decrement(string $key, mixed $value = 1)

Уменьшить значение элемента в кэше.

Параметры

string $key
mixed $value

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

int|bool

bool forever(string $key, mixed $value)

Сохранить элемент в кэше на неопределённый срок.

Параметры

string $key
mixed $value

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

bool

remember($key, $ttl, Closure $callback)

Без описания

Параметры

$key
$ttl
Closure $callback

sear($key, Closure $callback)

Без описания

Параметры

$key
Closure $callback

rememberForever($key, Closure $callback)

Без описания

Параметры

$key
Closure $callback

bool forget(string $key)

Удалить элемент из кэша.

Параметры

string $key

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

bool

bool delete($key)

{@inheritdoc}

Параметры

$key

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

bool

bool deleteMultiple($keys)

{@inheritdoc}

Параметры

$keys

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

bool

bool clear()

{@inheritdoc}

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

bool

TaggedCache tags(array|mixed $names)

Начать выполнение новой операции с тегами, если хранилище ее поддерживает.

Параметры

array|mixed $names

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

TaggedCache

Исключения

BadMethodCallException

protected string itemKey(string $key)

Форматировать ключ для элемента кэша.

Параметры

string $key

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

string

protected int getSeconds(DateTimeInterface|DateInterval|int $ttl)

Вычислить количество секунд для заданного TTL.

Параметры

DateTimeInterface|DateInterval|int $ttl

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

int

protected string|null getName()

Получить имя хранилища кэша.

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

string|null

bool supportsTags()

Определить, поддерживает ли текущее хранилище теги.

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

bool

int|null getDefaultCacheTime()

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

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

int|null

$this setDefaultCacheTime(int|null $seconds)

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

Параметры

int|null $seconds

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

$this

Store getStore()

Получить реализацию хранилища кэша.

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

Store

Repository setStore(Store $store)

Установить реализацию хранилища кэша.

Параметры

Store $store

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

Repository

protected void event(object|string $event)

Вызвать событие для этого экземпляра кэша.

Параметры

object|string $event

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

void

Диспетчер событий|null getEventDispatcher()

Получить экземпляр диспетчера событий.

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

Диспетчер событий|null

void setEventDispatcher(Dispatcher $events)

Установить экземпляр диспетчера событий.

Параметры

Dispatcher $events

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

void

bool offsetExists(string $key)

Определить, существует ли кэшированное значение.

Параметры

string $key

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

bool

mixed offsetGet(string $key)

Получить элемент из кэша по ключу.

Параметры

string $key

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

mixed

void offsetSet(string $key, mixed $value)

Сохранить элемент в кэше на стандартное время.

Параметры

string $key
mixed $value

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

void

void offsetUnset(string $key)

Удалить элемент из кэша.

Параметры

string $key

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

void

void __clone()

Клонировать экземпляр репозитория кэша.

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

void

bool flush()

Удалить все элементы из кэша.

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

bool

string taggedItemKey(string $key)

Получить полностью квалифицированный ключ для помеченного элемента.

Параметры

string $key

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

string

Набор тегов getTags()

Получить экземпляр набора тегов.

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

Набор тегов

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/11.x/Illuminate/Cache/TaggedCache.html

Spec-Zone.ru

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