TaggedCache

class TaggedCache extends Repository (View source)

Свойства

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

Методы

int	secondsUntil(DateTimeInterface\|DateInterval\|int $delay) Получить количество секунд до указанной даты DateTime.	из InteractsWithTime
int	availableAt(DateTimeInterface\|DateInterval\|int $delay) Получить отметку времени в формате UNIX timestamp для "доступно в".	из InteractsWithTime
DateTimeInterface\|int	parseDateInterval(DateTimeInterface\|DateInterval\|int $delay) Если заданное значение является интервалом, преобразовать его в экземпляр DateTime.	из InteractsWithTime
int	currentTime() Получить текущее системное время в формате UNIX timestamp.	из InteractsWithTime
static void	macro(string $name, object\|callable $macro) Регистрация пользовательского макроса.	из Macroable
static void	mixin(object $mixin) Добавление другого объекта в класс.	из Macroable
static bool	hasMacro(string $name) Проверка регистрации макроса.	из Macroable
static mixed	__callStatic(string $method, array $parameters) Динамическая обработка вызовов класса.	из Macroable
mixed	__call(string $method, array $parameters) Динамическая обработка вызовов класса.	из Macroable
void	__construct(Store $store, TagSet $tags) Создание нового кешированного экземпляра с тегами.
bool	has(string $key) Определение наличия элемента в кеше по ключу.	из Repository
mixed	get(string $key, mixed $default = null) Получение элемента из кеша по ключу.	из Repository
array	many(array $keys) Получение нескольких элементов из кеша по ключам.	из RetrievesMultipleKeys
getMultiple($keys, $default = null) {@inheritdoc}	из Repository
mixed	handleManyResult(array $keys, string $key, mixed $value) Обработка результата метода "many".	из Repository
mixed	pull(string $key, mixed $default = null) Получение элемента из кеша и его удаление.	из Repository
void	put(string $key, mixed $value, DateTimeInterface\|DateInterval\|float\|int $minutes = null) Сохранение элемента в кеше.	из Repository
set($key, $value, $ttl = null) {@inheritdoc}	из Repository
void	putMany(array $values, float\|int $minutes) Сохранение нескольких элементов в кеше на заданное количество минут.	из RetrievesMultipleKeys
setMultiple($values, $ttl = null) {@inheritdoc}	из Repository
bool	add(string $key, mixed $value, DateTimeInterface\|DateInterval\|float\|int $minutes) Сохранение элемента в кеше, если ключ не существует.	из Repository
int\|bool	increment(string $key, mixed $value = 1) Увеличение значения элемента в кеше.
int\|bool	decrement(string $key, mixed $value = 1) Уменьшение значения элемента в кеше.
void	forever(string $key, mixed $value) Сохранение элемента в кеше на неопределённый срок.	из Repository
mixed	remember(string $key, DateTimeInterface\|DateInterval\|float\|int $minutes, Closure $callback) Получение элемента из кеша или сохранение значения по умолчанию.	из Repository
mixed	sear(string $key, Closure $callback) Получение элемента из кеша или сохранение значения по умолчанию навсегда.	из Repository
mixed	rememberForever(string $key, Closure $callback) Получение элемента из кеша или сохранение значения по умолчанию навсегда.	из Repository
bool	forget(string $key) Удаление элемента из кеша.	из Repository
delete($key) {@inheritdoc}	из Repository
deleteMultiple($keys) {@inheritdoc}	из Repository
clear() {@inheritdoc}	из Repository

TaggedCache	tags(array\|mixed $names) Начать выполнение новой операции тегов, если хранилище её поддерживает.	from Repository
строка	itemKey(string $key) Форматировать ключ для элемента кэша.
float\|int	getDefaultCacheTime() Получить значение по умолчанию для времени кэширования.	from Repository
$this	setDefaultCacheTime(float\|int $minutes) Установить значение по умолчанию для времени кэширования в минутах.	from Repository
Store	getStore() Получить реализацию хранилища кэша.	from Repository
void	event(string $event) Сгенерировать событие для этого экземпляра кэша.
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
float\|int\|null	getMinutes(DateTimeInterface\|DateInterval\|float\|int $duration) Вычислить количество минут с заданной продолжительностью.	from Repository
void	__clone() Клонировать экземпляр репозитория кэша.	from Repository
void	flush() Удалить все элементы из кэша.
строка	taggedItemKey(string $key) Получить полностью квалифицированный ключ для помеченного элемента.

Подробности

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

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

Parameters

DateTimeInterface|DateInterval|int

$delay

Return Value

int

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

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

Parameters

DateTimeInterface|DateInterval|int

$delay

Return Value

int

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

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

Parameters

DateTimeInterface|DateInterval|int

$delay

Return Value

DateTimeInterface|int

protected int currentTime()

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

Return Value

int

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

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

Parameters

строка	$name
object\|callable	$macro

Return Value

void

static void mixin(object $mixin)

Добавить другой объект в класс.

Parameters

объект

$mixin

Return Value

void

Exceptions

ReflectionException

static bool hasMacro(string $name)

Проверить, зарегистрирован ли макрос.

Parameters

строка

$name

Return Value

bool

static mixed __callStatic(string $method, array $parameters)

Динамически обработать вызовы класса.

Parameters

строка	$method
массив	$parameters

Return Value

mixed

Exceptions

BadMethodCallException

mixed __call(string $method, array $parameters)

Динамически обработать вызовы класса.

Parameters

строка	$method
массив	$parameters

Return Value

mixed

Exceptions

BadMethodCallException

END_OF_DOCUMENT_MARKER

void __construct(Store $store, TagSet $tags)

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

Параметры

Store	$store
TagSet	$tags

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

void

bool has(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

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

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

Параметры

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

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

void

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

{@inheritdoc}

Параметры

	$key
	$value
	$ttl

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

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

Параметры

array	$values
float\|int	$minutes

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

void

setMultiple($values, $ttl = null)

{@inheritdoc}

Параметры

	$values
	$ttl

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

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

Параметры

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

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

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

void forever(string $key, mixed $value)

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

Параметры

string	$key
mixed	$value

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

void

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

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

Параметры

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

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

mixed

mixed sear(string $key, Closure $callback)

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

Параметры

string	$key
Closure	$callback

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

mixed

mixed rememberForever(string $key, Closure $callback)

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

Параметры

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

float|int getDefaultCacheTime()

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

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

float|int

$this setDefaultCacheTime(float|int $minutes)

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

Параметры

float|int

$minutes

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

$this

Store getStore()

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

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

Store

protected void event(string $event)

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

Параметры

string

$event

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

void

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 float|int|null getMinutes(DateTimeInterface|DateInterval|float|int $duration)

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

Параметры

DateTimeInterface|DateInterval|float|int

$duration

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

float|int|null

void __clone()

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

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

void

void flush()

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

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

void

string taggedItemKey(string $key)

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

Параметры

string

$key

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

string

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