Spec-Zone.ru › Laravel 5.8

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)

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

из InteractsWithTime
int availableAt(DateTimeInterface|DateInterval|int $delay = 0)

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

из 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, bool $replace = true)

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

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

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

из TaggedCache
bool has(string $key)

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

из Repository
bool missing(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
bool put(string $key, mixed $value, DateTimeInterface|DateInterval|int|null $ttl = null)

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

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

{@inheritdoc}

из Repository
bool putMany(array $values, int $seconds)

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

из RetrievesMultipleKeys
bool putManyForever(array $values)

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

из Repository
setMultiple($values, $ttl = null)

{@inheritdoc}

из Repository
bool add(string $key, mixed $value, DateTimeInterface|DateInterval|int|null $ttl = null)

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

из 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 и сохранить результат.

из Repository
mixed sear(string $key, Closure $callback)

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

из Repository
mixed rememberForever(string $key, Closure $callback)

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

из Repository
bool forget(string $key)

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

из Repository
delete($key)

{@inheritdoc}

from Репозиторий
deleteMultiple($keys)

{@inheritdoc}

from Репозиторий
clear()

{@inheritdoc}

from Репозиторий
TaggedCache tags(array|mixed $names)

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

from Репозиторий
строка itemKey(string $key)

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

from TaggedCache
целое число getDefaultCacheTime()

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

from Репозиторий
$this setDefaultCacheTime(int|null $seconds)

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

from Репозиторий
Хранилище getStore()

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

from Репозиторий
void event(string $event)

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

from TaggedCache
void setEventDispatcher(Dispatcher $events)

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

from Репозиторий
bool offsetExists(string $key)

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

from Репозиторий
mixed 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
TagSet 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)

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

Параметры

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 целое число currentTime()

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

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

целое число

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

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

Parameters

string $name
object|callable $macro

Return Value

void

static void mixin(object $mixin, bool $replace = true)

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

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

static bool hasMacro(string $name)

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

Parameters

string $name

Return Value

bool

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

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

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

mixed __call(string $method, array $parameters)

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

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

void __construct(Store $store, TagSet $tags)

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

Parameters

Store $store
TagSet $tags

Return Value

void

bool has(string $key)

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

Parameters

string $key

Return Value

bool

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

bool put(string $key, mixed $value, DateTimeInterface|DateInterval|int|null $ttl = null)

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

Parameters

string $key
mixed $value
DateTimeInterface|DateInterval|int|null $ttl

Return Value

bool

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

{@inheritdoc}

Parameters

$key
$value
$ttl

bool putMany(array $values, int $seconds)

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

Parameters

array $values
int $seconds

Return Value

bool

protected bool putManyForever(array $values)

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

Parameters

array $values

Return Value

bool

setMultiple($values, $ttl = null)

{@inheritdoc}

Parameters

$values
$ttl

bool add(string $key, mixed $value, DateTimeInterface|DateInterval|int|null $ttl = null)

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

Parameters

string $key
mixed $value
DateTimeInterface|DateInterval|int|null $ttl

Return Value

bool
END_OF_DOCUMENT_MARKER

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

mixed remember(string $key, DateTimeInterface|DateInterval|int|null $ttl, Closure $callback)

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

Parameters

string $key
DateTimeInterface|DateInterval|int|null $ttl
Closure $callback

Return Value

mixed

mixed sear(string $key, Closure $callback)

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

Parameters

string $key
Closure $callback

Return Value

mixed

mixed rememberForever(string $key, Closure $callback)

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

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

int getDefaultCacheTime()

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

Return Value

int

$this setDefaultCacheTime(int|null $seconds)

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

Parameters

int|null $seconds

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

Spec-Zone.ru

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