TaggedCache

класс TaggedCache расширяет Repository (View source)

Черты

Свойства

static protected array	$macros	Зарегистрированные строковые макросы.	из Macroable
protected Store	$store	Реализация хранилища кэша.	из Repository
protected Dispatcher	$events	Реализация диспетчера событий.	из Repository
protected int\|null	$default	Умолчательное количество секунд для хранения элементов.	из Repository
protected TagSet	$tags	Экземпляр набора тегов.

Методы

int	secondsUntil(DateTimeInterface\|DateInterval\|int $delay) Получить количество секунд до заданной даты и времени.	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) Создать новый экземпляр помеченного кеша.
bool	has(array\|string $key) Определить, существует ли элемент в кеше.	from Repository
bool	missing(string $key) Определить, не существует ли элемент в кеше.	from Repository
mixed	get($key, $default = null) No description	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) No description	from Repository
bool	put(string $key, mixed $value, DateTimeInterface\|DateInterval\|int\|null $ttl = null) Сохранить элемент в кеше.	from Repository
bool	set($key, $value, $ttl = null) {@inheritdoc}	from Repository
bool	putMany(array $values, DateTimeInterface\|DateInterval\|int\|null $ttl = null) Сохранить несколько элементов в кеше на заданное количество секунд.
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) Сохранить элемент в кеше бессрочно.	from Repository
remember($key, $ttl, Closure $callback) No description	from Repository
sear($key, Closure $callback) No description	from Repository
rememberForever($key, Closure $callback) No description	from Repository
bool	forget(string $key) Удалить элемент из кеша.	from Repository

bool	delete($key) {@inheritdoc}	from Repository
bool	deleteMultiple($keys) {@inheritdoc}	from Repository
bool	clear() {@inheritdoc}	from Repository
TaggedCache	tags(array\|mixed $names) Начать выполнение новой операции с тегами, если хранилище это поддерживает.	from Repository
string	itemKey(string $key) Форматирует ключ для элемента кэша.
int	getSeconds(DateTimeInterface\|DateInterval\|int $ttl) Вычисляет количество секунд для заданного TTL.	from Repository
bool	supportsTags() Определяет, поддерживает ли текущее хранилище теги.	from Repository
int\|null	getDefaultCacheTime() Получить время кэширования по умолчанию.	from Repository
$this	setDefaultCacheTime(int\|null $seconds) Установить время кэширования по умолчанию в секундах.	from Repository
Store	getStore() Получить реализацию хранилища кэша.	from Repository
void	event(object\|string $event) Вызвать событие для этого экземпляра кэша.
Dispatcher	getEventDispatcher() Получить экземпляр диспетчера событий.	from Repository
void	setEventDispatcher(Dispatcher $events) Установить экземпляр диспетчера событий.	from Repository
bool	offsetExists(string $key) Определить, существует ли кэшированное значение.	from Repository
mixed	offsetGet(string $key) Извлечь элемент из кэша по ключу.	from Repository
void	offsetSet(string $key, mixed $value) Сохранить элемент в кэше на время по умолчанию.	from Repository
void	offsetUnset(string $key) Удалить элемент из кэша.	from Repository
void	__clone() Клонировать экземпляр репозитория кэша.	from Repository
bool	flush() Удалить все элементы из кэша.
string	taggedItemKey(string $key) Получить полностью квалифицированный ключ для помеченного элемента.
TagSet	getTags() Получить экземпляр набора тегов.

Подробности

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

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

Параметры

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.

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

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

END_OF_DOCUMENT_MARKER

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)

No description

Параметры

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

No description

Параметры

	$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, DateTimeInterface|DateInterval|int|null $ttl = null)

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

Параметры

array	$values
DateTimeInterface\|DateInterval\|int\|null	$ttl

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

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)

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

Parameters

string	$key
mixed	$value

Return Value

int|bool

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

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

Parameters

string	$key
mixed	$value

Return Value

int|bool

bool forever(string $key, mixed $value)

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

Parameters

string	$key
mixed	$value

Return Value

bool

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

No description

Parameters

	$key
	$ttl
Closure	$callback

sear($key, Closure $callback)

No description

Parameters

	$key
Closure	$callback

rememberForever($key, Closure $callback)

No description

Parameters

	$key
Closure	$callback

bool forget(string $key)

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

Parameters

string

$key

Return Value

bool

bool delete($key)

{@inheritdoc}

Parameters

$key

Return Value

bool

bool deleteMultiple($keys)

{@inheritdoc}

Parameters

$keys

Return Value

bool

bool clear()

{@inheritdoc}

Return Value

bool

TaggedCache tags(array|mixed $names)

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

Parameters

array|mixed

$names

Return Value

TaggedCache

Exceptions

BadMethodCallException

protected string itemKey(string $key)

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

Parameters

string

$key

Return Value

string

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

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

Parameters

DateTimeInterface|DateInterval|int

$ttl

Return Value

int

bool supportsTags()

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

Return Value

bool

int|null getDefaultCacheTime()

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

Return Value

int|null

$this setDefaultCacheTime(int|null $seconds)

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

Parameters

int|null

$seconds

Return Value

$this

Store getStore()

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

Return Value

Store

protected void event(object|string $event)

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

Parameters

object|string

$event

Return Value

void

Dispatcher getEventDispatcher()

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

Return Value

Dispatcher

void setEventDispatcher(Dispatcher $events)

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

Parameters

Dispatcher

$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

TagSet getTags()

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

Return Value

TagSet

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