Spec-Zone.ru › Laravel 5.6

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 float|int $default Значение по умолчанию для количества минут хранения элементов. from Repository
protected TagSet $tags Экземпляр набора тегов. from TaggedCache

Методы

int secondsUntil(DateTimeInterface|DateInterval|int $delay)

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

from InteractsWithTime
int availableAt(DateTimeInterface|DateInterval|int $delay)

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

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)

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

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

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

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)

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

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)

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

from Repository
string itemKey(string $key)

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

из TaggedCache
float|int getDefaultCacheTime()

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

из Repository
$this setDefaultCacheTime(float|int $minutes)

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

из Repository
Store getStore()

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

из Repository
void event(string $event)

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

из TaggedCache
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
void flush()

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

string taggedItemKey(string $key)

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

из 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)

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

Подробности

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

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

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

int

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

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

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

string $name
object|callable $macro

Return Value

void

static void mixin(object $mixin)

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

Parameters

object $mixin

Return Value

void

Exceptions

ReflectionException

static bool hasMacro(string $name)

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

Parameters

string $name

Return Value

bool
END_OF_DOCUMENT_MARKER

статический смешанный __callStatic(string $method, array $parameters)

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

Параметры

string $method
array $parameters

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

смешанный

Исключения

BadMethodCallException

смешанный __call(string $method, array $parameters)

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

Параметры

string $method
array $parameters

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

смешанный

Исключения

BadMethodCallException

void __construct(Store $store, TagSet $tags)

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

Параметры

Store $store
TagSet $tags

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

void

bool has(string $key)

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

Параметры

string $key

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

bool

смешанный get(string $key, mixed $default = null)

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

Параметры

string $key
смешанный $default

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

смешанный

массив many(array $keys)

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

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

Параметры

массив $keys

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

массив

getMultiple($keys, $default = null)

{@inheritdoc}

Параметры

$keys
$default

защищенный смешанный handleManyResult(array $keys, string $key, mixed $value)

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

Параметры

массив $keys
string $key
смешанный $value

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

смешанный

смешанный pull(string $key, mixed $default = null)

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

Параметры

string $key
смешанный $default

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

смешанный

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

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

Параметры

string $key
смешанный $value
DateTimeInterface|DateInterval|float|int $minutes

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

void

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

{@inheritdoc}

Параметры

$key
$value
$ttl

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

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

Параметры

массив $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
смешанный $value
DateTimeInterface|DateInterval|float|int $minutes

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

bool

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

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

Параметры

string $key
смешанный $value

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

int|bool

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

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

Параметры

string $key
смешанный $value

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

int|bool

void forever(string $key, mixed $value)

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

Параметры

string $key
смешанный $value

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

void

смешанный remember(string $key, DateTimeInterface|DateInterval|float|int $minutes, Closure $callback)

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

Параметры

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

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

смешанный
END_OF_DOCUMENT_MARKER

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

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

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

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

Хранилище

protected void event(string $event)

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

Параметры

string $event

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

void

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

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

Параметры

Диспечер $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

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API