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 timestamp.	from InteractsWithTime
DateTimeInterface\|int	parseDateInterval(DateTimeInterface\|DateInterval\|int $delay) Если заданное значение является интервалом, преобразовать его в экземпляр DateTime.	from InteractsWithTime
int	currentTime() Получить текущее системное время в формате UNIX timestamp.	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 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
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) Сохранить элемент в кэше.
set($key, $value, $ttl = null) {@inheritdoc}	from Repository
bool	putMany(array $values, int $seconds) Сохранить несколько элементов в кэше на заданное количество секунд.	from RetrievesMultipleKeys
bool	putManyForever(array $values) Сохранить несколько элементов в кэше на неопределенный срок.	from Repository
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) Получить элемент из кэша или выполнить заданный Closure и сохранить результат.	from Repository
mixed	sear(string $key, Closure $callback) Получить элемент из кэша или выполнить заданный Closure и сохранить результат на неопределенный срок.	from Repository
mixed	rememberForever(string $key, Closure $callback) Получить элемент из кэша или выполнить заданный Closure и сохранить результат на неопределенный срок.	from Repository
bool	forget(string $key) Удалить элемент из кэша.	from Repository

delete($key) {@inheritdoc}	from Репозиторий
deleteMultiple($keys) {@inheritdoc}	from Репозиторий
clear() {@inheritdoc}	from Репозиторий
TaggedCache	tags(array\|mixed $names) Начать выполнение новой операции с тегами, если хранилище её поддерживает.	from Репозиторий
строка	itemKey(string $key) Отформатировать ключ для элемента кэша.	from TaggedCache
целое число\|null	getDefaultCacheTime() Получить время кэширования по умолчанию.	from Репозиторий
$this	setDefaultCacheTime(int\|null $seconds) Установить время кэширования по умолчанию в секундах.	from Репозиторий
Хранилище	getStore() Получить реализацию хранилища кэша.	from Репозиторий
void	event(string $event) Вызвать событие для этого экземпляра кэша.	from TaggedCache
Диспетчер событий	getEventDispatcher() Получить экземпляр диспетчера событий.	from Репозиторий
void	setEventDispatcher(Диспетчер событий $events) Установить экземпляр диспетчера событий.	from Репозиторий
bool	offsetExists(string $key) Определить, существует ли кэшированное значение.	from Репозиторий
смешанный	offsetGet(string $key) Получить элемент из кэша по ключу.	from Репозиторий
void	offsetSet(string $key, mixed $value) Сохранить элемент в кэше на время по умолчанию.	from Репозиторий
void	offsetUnset(string $key) Удалить элемент из кэша.	from Репозиторий
целое число	getSeconds(DateTimeInterface\|DateInterval\|int $ttl) Вычислить количество секунд для данного TTL.	from Репозиторий
void	__clone() Клонировать экземпляр репозитория кэша.	from Репозиторий
bool	flush() Удалить все элементы из кэша.
строка	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) Удалить ключи элементов, которые были сохранены по отношению к ссылке.
строка	referenceKey(string $segment, string $suffix) Получить ключ ссылки для сегмента.

Подробности

protected целое число secondsUntil(DateTimeInterface|DateInterval|целое число $delay)

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

Параметры

DateTimeInterface|DateInterval|целое число

$delay

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

целое число

protected целое число availableAt(DateTimeInterface|DateInterval|целое число $delay = 0)

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

Параметры

DateTimeInterface|DateInterval|целое число

$delay

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

целое число

protected DateTimeInterface|целое число parseDateInterval(DateTimeInterface|DateInterval|целое число $delay)

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

Параметры

DateTimeInterface|DateInterval|целое число

$delay

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

DateTimeInterface|целое число

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

getMultiple($keys, $default = null)

{@inheritdoc}

Параметры

	$keys
	$default

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

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

{@inheritdoc}

Параметры

	$key
	$value
	$ttl

bool putMany(array $values, int $seconds)

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

Параметры

array	$values
int	$seconds

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

bool

protected bool putManyForever(array $values)

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

Параметры

array

$values

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

bool

setMultiple($values, $ttl = null)

{@inheritdoc}

Параметры

	$values
	$ttl

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

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

delete($key)

{@inheritdoc}

Параметры

$key

deleteMultiple($keys)

{@inheritdoc}

Параметры

$keys

clear()

{@inheritdoc}

TaggedCache tags(array|mixed $names)

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

Параметры

array|mixed

$names

Значение результата

TaggedCache

Исключения

BadMethodCallException

protected string itemKey(string $key)

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

Параметры

string

$key

Значение результата

string

int|null getDefaultCacheTime()

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

Значение результата

int|null

$this setDefaultCacheTime(int|null $seconds)

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

Параметры

int|null

$seconds

Значение результата

$this

Store getStore()

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

Значение результата

Store

protected void event(string $event)

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

Параметры

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

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

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

Параметры

DateTimeInterface|DateInterval|int

$ttl

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

int

void __clone()

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

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

void

bool flush()

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

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

bool

string taggedItemKey(string $key)

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

Параметры

string

$key

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

string

TagSet getTags()

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

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

TagSet

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