Spec-Zone.ru › Laravel 9

RedisTaggedCache

class RedisTaggedCache extends TaggedCache (View source)

Трейты

RetrievesMultipleKeys
InteractsWithTime
Macroable

Константы

REFERENCE_KEY_FOREVER

Ключ ссылки навсегда.

REFERENCE_KEY_STANDARD

Стандартный ключ ссылки.

Свойства

static protected array $macros

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

from Macroable
protected Store $store

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

from Repository
protected Dispatcher $events

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

from Repository
protected int|null $default

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

from Repository
protected TagSet $tags

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

from TaggedCache

Методы

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

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

from TaggedCache
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)

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

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

{@inheritdoc}

from Repository
bool putMany(array $values, int $seconds)

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

from RetrievesMultipleKeys
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)

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

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

Без описания

from Repository
sear($key, Closure $callback)

Без описания

from Repository
rememberForever($key, Closure $callback)

Без описания

from Repository
bool forget(string $key)

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

from Repository
bool delete($key)

{@inheritdoc}

from Repository
bool deleteMultiple($keys)

{@inheritdoc}

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

{@inheritdoc}

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

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

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

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

from TaggedCache
int getSeconds(DateTimeInterface|DateInterval|int $ttl)

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

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

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

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

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

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

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

from Репозиторий
Хранилище getStore()

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

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

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

from TaggedCache
Диспетчер событий getEventDispatcher()

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

from Репозиторий
void setEventDispatcher(Диспетчер событий $events)

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

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

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

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

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

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

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

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

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

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

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

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

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

string taggedItemKey(string $key)

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

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

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

from TaggedCache
void pushStandardKeys(string $namespace, string $key)

Сохранить ссылки на стандартные ключи в хранилище.

void pushForeverKeys(string $namespace, string $key)

Сохранить ссылки на ключи на постоянное время в хранилище.

void pushKeys(string $namespace, string $key, string $reference)

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

void deleteForeverKeys()

Удалить все элементы, сохранённые на постоянное время.

void deleteStandardKeys()

Удалить все стандартные элементы.

void deleteKeysByReference(string $reference)

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

void deleteValues(string $referenceKey)

Удалить ключи элементов, сохранённые по отношению к ссылке.

string referenceKey(string $segment, string $suffix)

Получить ключ ссылки для сегмента.

Подробности

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

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

Параметры

DateTimeInterface|DateInterval|int $delay

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

int

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

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

Параметры

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

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, int $seconds)

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

Параметры

array $values
int $seconds

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

bool

protected bool putManyForever(array $values)

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

Параметры

массив $values

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

bool

bool setMultiple($values, $ttl = null)

{@inheritdoc}

Параметры

$values
$ttl

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

bool

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

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

Параметры

строка $key
смешанное $value
DateTimeInterface|DateInterval|int|null $ttl

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

bool

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

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

Параметры

строка $key
смешанное $value

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

int|bool

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

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

Параметры

строка $key
смешанное $value

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

int|bool

bool forever(string $key, mixed $value)

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

Параметры

строка $key
смешанное $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)

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

Параметры

строка $key

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

bool

bool delete($key)

{@inheritdoc}

Параметры

$key

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

bool

bool deleteMultiple($keys)

{@inheritdoc}

Параметры

$keys

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

bool

bool clear()

{@inheritdoc}

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

bool

TaggedCache tags(array|mixed $names)

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

Параметры

массив|смешанное $names

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

TaggedCache

Исключения

BadMethodCallException

protected string itemKey(string $key)

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

Параметры

строка $key

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

строка

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

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

Параметры

DateTimeInterface|DateInterval|int $ttl

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

int

bool supportsTags()

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

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

bool

int|null getDefaultCacheTime()

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

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

int|null

$this setDefaultCacheTime(int|null $seconds)

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

Параметры

int|null $seconds

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

$this

Store getStore()

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

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

Store

protected void event(object|string $event)

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

Параметры

объект|строка $event

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

void
END_OF_DOCUMENT_MARKER

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

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

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

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

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

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

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

Набор тегов

protected void pushStandardKeys(string $namespace, string $key)

Сохранить стандартные ссылки на ключи в хранилище.

Параметры

string $namespace
string $key

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

void

protected void pushForeverKeys(string $namespace, string $key)

Сохранить ссылки на ключи на неопределенный срок в хранилище.

Параметры

string $namespace
string $key

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

void

protected void pushKeys(string $namespace, string $key, string $reference)

Сохранить ссылку на ключ кэша по ключу ссылки.

Параметры

string $namespace
string $key
string $reference

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

void

protected void deleteForeverKeys()

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

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

void

protected void deleteStandardKeys()

Удалить все стандартные элементы.

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

void

protected void deleteKeysByReference(string $reference)

Найти и удалить все элементы, сохраненные по ссылке.

Параметры

string $reference

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

void

protected void deleteValues(string $referenceKey)

Удалить ключи элементов, сохраненные по ссылке.

Параметры

string $referenceKey

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

void

protected string referenceKey(string $segment, string $suffix)

Получить ключ ссылки для сегмента.

Параметры

string $segment
string $suffix

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

string

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

Spec-Zone.ru

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