TaggedCache

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

Черты

Свойства

static protected array	$macros	Зарегистрированные строковые макросы.	из Macroable
protected Store	$store	Реализация хранилища кэша.	из Repository
protected Dispatcher	$events	Реализация диспетчера событий.	из Repository
protected float\|int	$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) Смешать другой объект в класс.	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) Создать новый экземпляр помеченного кэша.
bool	has(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
void	put(string $key, mixed $value, DateTimeInterface\|DateInterval\|float\|int $minutes = null) Сохранить элемент в кэше.	from Repository
set($key, $value, $ttl = null) {@inheritdoc}	from Repository
void	putMany(array $values, float\|int $minutes) Сохранить несколько элементов в кэше на заданное количество минут.	from RetrievesMultipleKeys
setMultiple($values, $ttl = null) {@inheritdoc}	from Repository
bool	add(string $key, mixed $value, DateTimeInterface\|DateInterval\|float\|int $minutes) Сохранить элемент в кэше, если ключ не существует.	from Repository
int\|bool	increment(string $key, mixed $value = 1) Увеличить значение элемента в кэше.
int\|bool	decrement(string $key, mixed $value = 1) Уменьшить значение элемента в кэше.
void	forever(string $key, mixed $value) Сохранить элемент в кэше бессрочно.	from Repository
mixed	remember(string $key, DateTimeInterface\|DateInterval\|float\|int $minutes, Closure $callback) Получить элемент из кэша или сохранить значение по умолчанию.	from Repository
mixed	sear(string $key, Closure $callback) Получить элемент из кэша или сохранить значение по умолчанию навсегда.	from Repository
mixed	rememberForever(string $key, Closure $callback) Получить элемент из кэша или сохранить значение по умолчанию навсегда.	from Repository
bool	forget(string $key) Удалить элемент из кэша.	from Repository
delete($key) {@inheritdoc}	from Repository
deleteMultiple($keys) {@inheritdoc}	from Repository
clear() {@inheritdoc}	from Repository

TaggedCache	tags(array\|mixed $names) Начать выполнение новой операции с тегами, если хранилище её поддерживает.	из Repository
string	itemKey(string $key) Форматировать ключ для элемента кэша.
float\|int	getDefaultCacheTime() Получить время кэширования по умолчанию.	из Repository
$this	setDefaultCacheTime(float\|int $minutes) Установить время кэширования по умолчанию в минутах.	из Repository
Store	getStore() Получить реализацию хранилища кэша.	из Repository
void	event(string $event) Сгенерировать событие для этого экземпляра кэша.
void	setEventDispatcher(Dispatcher $events) Установить экземпляр диспетчера событий.	из Repository
bool	offsetExists(string $key) Определить, существует ли кэшированное значение.	из Repository
mixed	offsetGet(string $key) Извлечь элемент из кэша по ключу.	из Repository
void	offsetSet(string $key, mixed $value) Сохранить элемент в кэше на время по умолчанию.	из Repository
void	offsetUnset(string $key) Удалить элемент из кэша.	из Repository
float\|int\|null	getMinutes(DateTimeInterface\|DateInterval\|float\|int $duration) Вычислить количество минут с заданной длительностью.	из Repository
void	__clone() Клонировать экземпляр репозитория кэша.	из Repository
bool	flush() Удалить все элементы из кэша.
string	taggedItemKey(string $key) Получить полностью квалифицированный ключ для помеченного элемента.

Подробности

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.

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

int

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

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

Параметры

string	$name
object\|callable	$macro

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

void

static void mixin(object $mixin)

Смешать другой объект в класс.

Параметры

object

$mixin

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

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

END_OF_DOCUMENT_MARKER

void __construct(Store $store, TagSet $tags)

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

Parameters

Store	$store
TagSet	$tags

Return Value

void

bool has(string $key)

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

Parameters

string

$key

Return Value

bool

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

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

Parameters

string	$key
mixed	$default

Return Value

mixed

array many(array $keys)

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

Элементы, не найденные в кэше, будут иметь значение null.

Parameters

array

$keys

Return Value

array

getMultiple($keys, $default = null)

{@inheritdoc}

Parameters

	$keys
	$default

protected mixed handleManyResult(array $keys, string $key, mixed $value)

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

Parameters

array	$keys
string	$key
mixed	$value

Return Value

mixed

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

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

Parameters

string	$key
mixed	$default

Return Value

mixed

void put(string $key, mixed $value, DateTimeInterface|DateInterval|float|int $minutes = null)

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

Parameters

string	$key
mixed	$value
DateTimeInterface\|DateInterval\|float\|int	$minutes

Return Value

void

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

{@inheritdoc}

Parameters

	$key
	$value
	$ttl

void putMany(array $values, float|int $minutes)

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

Parameters

array	$values
float\|int	$minutes

Return Value

void

setMultiple($values, $ttl = null)

{@inheritdoc}

Parameters

	$values
	$ttl

bool add(string $key, mixed $value, DateTimeInterface|DateInterval|float|int $minutes)

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

Parameters

string	$key
mixed	$value
DateTimeInterface\|DateInterval\|float\|int	$minutes

Return Value

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

void forever(string $key, mixed $value)

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

Parameters

string	$key
mixed	$value

Return Value

void

mixed remember(string $key, DateTimeInterface|DateInterval|float|int $minutes, Closure $callback)

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

Parameters

string	$key
DateTimeInterface\|DateInterval\|float\|int	$minutes
Closure	$callback

Return Value

mixed

mixed sear(string $key, Closure $callback)

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

Parameters

string	$key
Closure	$callback

Return Value

mixed

mixed rememberForever(string $key, Closure $callback)

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

Parameters

string	$key
Closure	$callback

Return Value

mixed

bool forget(string $key)

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

Parameters

string

$key

Return Value

bool

delete($key)

{@inheritdoc}

Parameters

$key

deleteMultiple($keys)

{@inheritdoc}

Parameters

$keys

clear()

{@inheritdoc}

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

float|int getDefaultCacheTime()

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

Return Value

float|int

$this setDefaultCacheTime(float|int $minutes)

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

Parameters

float|int

$minutes

Return Value

$this

Store getStore()

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

Return Value

Store

protected void event(string $event)

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

Parameters

string

$event

Return Value

void

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

protected float|int|null getMinutes(DateTimeInterface|DateInterval|float|int $duration)

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

Parameters

DateTimeInterface|DateInterval|float|int

$duration

Return Value

float|int|null

void __clone()

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

Return Value

void

bool flush()

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

Return Value

bool

string taggedItemKey(string $key)

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

Parameters

string

$key

Return Value

string

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