Spec-Zone.ru › Laravel 10

RedisTaggedCache

class RedisTaggedCache extends TaggedCache (View source)

Особенности

RetrievesMultipleKeys
InteractsWithTime
Macroable

Свойства

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.

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

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

из InteractsWithTime
DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)

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

из InteractsWithTime
int currentTime()

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

из 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
void __construct(Store $store, TagSet $tags)

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

из TaggedCache
bool has(array|string $key)

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

из Repository
bool missing(string $key)

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

из Repository
mixed get($key, $default = null)

Без описания

из Repository
array many(array $keys)

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

из RetrievesMultipleKeys
iterable getMultiple($keys, $default = null)

{@inheritdoc}

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

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

из Repository
pull($key, $default = null)

Без описания

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

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

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

{@inheritdoc}

из Repository
bool putMany(array $values, int $seconds)

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

из RetrievesMultipleKeys
bool putManyForever(array $values)

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

из Repository
bool setMultiple($values, $ttl = null)

{@inheritdoc}

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

Без описания

из Repository
sear($key, Closure $callback)

Без описания

из Repository
rememberForever($key, Closure $callback)

Без описания

из Repository
bool forget(string $key)

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

из Repository
bool delete($key)

{@inheritdoc}

из Repository
bool deleteMultiple($keys)

{@inheritdoc}

из хранилища
bool clear()

{@inheritdoc}

из хранилища
TaggedCache tags(array|mixed $names)

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

из хранилища
string itemKey(string $key)

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

из TaggedCache
int getSeconds(DateTimeInterface|DateInterval|int $ttl)

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

из хранилища
bool supportsTags()

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

из хранилища
int|null getDefaultCacheTime()

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

из хранилища
$this setDefaultCacheTime(int|null $seconds)

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

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

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

из хранилища
Хранилище setStore(Хранилище $store)

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

из хранилища
void event(object|string $event)

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

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

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

из хранилища
void setEventDispatcher(Диспечер событий $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
Набор тегов getTags()

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

из TaggedCache
void flushValues()

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

bool flushStale()

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

Подробности

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

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

Параметры

DateTimeInterface|DateInterval|int $delay

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

int

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

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

Параметры

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

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

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

Параметры

string $name
object|callable $macro

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

void
END_OF_DOCUMENT_MARKER

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

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
END_OF_DOCUMENT_MARKER

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

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

Dispatcher getEventDispatcher()

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

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

Dispatcher

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

TagSet getTags()

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

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

TagSet

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/10.x/Illuminate/Cache/RedisTaggedCache.html

Spec-Zone.ru

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