Spec-Zone.ru › Laravel 11

RedisTaggedCache

class RedisTaggedCache extends TaggedCache (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

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

from TaggedCache

Методы

int secondsUntil(DateTimeInterface|DateInterval|int $delay)

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

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

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

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)

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

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)

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

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)

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

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

{@inheritdoc}

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

{@inheritdoc}

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

{@inheritdoc}

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

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

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

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

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

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

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

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

из TaggedCache
TagSet getTags()

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

из TaggedCache
void flushValues()

Очистить отдельные записи кэша для тегов.

bool flushStale()

Удалить все устаревшие ссылки из набора тегов.

Подробности

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

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

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

Параметры

DateTimeInterface|DateInterval|int $delay

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

DateTimeInterface|int

protected int currentTime()

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

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

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

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

Параметры

array $values
int $seconds

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

bool

protected bool putManyForever(array $values)

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

Параметры

array $values

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

bool
END_OF_DOCUMENT_MARKER

bool setMultiple($values, $ttl = null)

{@inheritdoc}

Параметры

$values
$ttl

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

bool

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

Хранилище getStore()

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

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

Хранилище

Репозиторий setStore(Хранилище $store)

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

Параметры

Хранилище $store

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

Репозиторий

protected void event(object|string $event)

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

Параметры

object|string $event

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

void

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

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

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

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

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

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

Параметры

Диспетчер событий $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 flushValues()

Очистить отдельные записи кэша для тегов.

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

void

bool flushStale()

Удалить все устаревшие записи ссылок из набора тегов.

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

bool

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

Spec-Zone.ru

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