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(string $key) Определение существования элемента в кэше.	from Repository
bool	missing(string $key) Определение отсутствия элемента в кэше.	from Repository
mixed	get(string $key, mixed $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
mixed	pull(string $key, mixed $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) Сохранение элемента в кэше на неопределенный срок.
mixed	remember(string $key, DateTimeInterface\|DateInterval\|int\|null $ttl, Closure $callback) Получение элемента из кэша или выполнение заданного замыкания и сохранение результата.	from Repository
mixed	sear(string $key, Closure $callback) Получение элемента из кэша или выполнение заданного замыкания и сохранение результата навсегда.	from Repository
mixed	rememberForever(string $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.	из Репозитория
bool	supportsTags() Определить, поддерживает ли текущее хранилище теги.	из Репозитория
int\|null	getDefaultCacheTime() Получить значение по умолчанию для времени кэширования.	из Репозитория
$this	setDefaultCacheTime(int\|null $seconds) Установить значение по умолчанию для времени кэширования в секундах.	из Репозитория
Store	getStore() Получить реализацию хранилища кэша.	из Репозитория
void	event(object\|string $event) Вызвать событие для этого экземпляра кэша.	из TaggedCache
Dispatcher	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	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) Получить ключ ссылки для сегмента.

Details

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

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

Parameters

DateTimeInterface|DateInterval|int

$delay

Return Value

int

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

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

Parameters

DateTimeInterface|DateInterval|int

$delay

Return Value

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(string $key)

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

Параметры

string

$key

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

bool

bool missing(string $key)

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

Параметры

string

$key

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

bool

mixed get(string $key, mixed $default = null)

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

Параметры

string	$key
mixed	$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

mixed pull(string $key, mixed $default = null)

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

Параметры

string	$key
mixed	$default

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

mixed

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

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

mixed remember(string $key, DateTimeInterface|DateInterval|int|null $ttl, Closure $callback)

Получает элемент из кэша или выполняет заданный Closure, сохраняя результат.

Параметры

string	$key
DateTimeInterface\|DateInterval\|int\|null	$ttl
Closure	$callback

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

mixed

mixed sear(string $key, Closure $callback)

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

Параметры

string	$key
Closure	$callback

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

mixed

mixed rememberForever(string $key, Closure $callback)

Получает элемент из кэша или выполняет заданный Closure, сохраняя результат на неопределённое время.

Параметры

string	$key
Closure	$callback

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

mixed

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)

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

Parameters

int|null

$seconds

Return Value

$this

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

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

Return Value

Хранилище

protected void event(object|string $event)

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

Parameters

object|string

$event

Return Value

void

Диспечер getEventDispatcher()

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

Return Value

Диспечер

void setEventDispatcher(Диспечер $events)

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

Parameters

Диспечер

$events

Return Value

void

bool offsetExists(string $key)

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

Parameters

string

$key

Return Value

bool

mixed offsetGet(string $key)

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

Parameters

string

$key

Return Value

mixed

void offsetSet(string $key, mixed $value)

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

Parameters

string	$key
mixed	$value

Return Value

void

void offsetUnset(string $key)

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

Parameters

string

$key

Return Value

void

void __clone()

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

Return Value

void

bool flush()

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

Return Value

bool

string taggedItemKey(string $key)

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

Parameters

string

$key

Return Value

string

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

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

Return Value

Набор тегов

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

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

Parameters

string	$namespace
string	$key

Return Value

void

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

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

Parameters

string	$namespace
string	$key

Return Value

void

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

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

Parameters

string	$namespace
string	$key
string	$reference

Return Value

void

protected void deleteForeverKeys()

Удалить все элементы, хранящиеся на всегда.

Return Value

void

protected void deleteStandardKeys()

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

Return Value

void

protected void deleteKeysByReference(string $reference)

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

Parameters

string

$reference

Return Value

void

protected void deleteValues(string $referenceKey)

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

Parameters

string

$referenceKey

Return Value

void

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

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

Parameters

string	$segment
string	$suffix

Return Value

string

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