Spec-Zone.ru › Laravel 6

TaggedCache

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

Трейты

RetrievesMultipleKeys
InteractsWithTime
Macroable

Свойства

статический защищённый массив $macros

Зарегистрированные строковые макросы.

из Macroable
защищённый Store $store

Реализация хранилища кэша.

из Repository
защищённый Dispatcher $events

Реализация диспетчера событий.

из Repository
защищённый int|null $default

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

из Repository
защищённый TagSet $tags

Экземпляр набора тегов.

Методы

int secondsUntil(DateTimeInterface|DateInterval|int $delay)

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

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

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

из InteractsWithTime
DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)

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

из InteractsWithTime
int currentTime()

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

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

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

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)

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

из Repository
set($key, $value, $ttl = null)

{@inheritdoc}

из Repository
bool putMany(array $values, DateTimeInterface|DateInterval|int|null $ttl = null)

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

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)

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

из Repository
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 Репозиторий
string itemKey(string $key)

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

int|null getDefaultCacheTime()

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

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

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

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

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

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

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

Диспетчер событий getEventDispatcher()

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

from Репозиторий
void setEventDispatcher(Диспетчер событий $events)

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

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

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

from Репозиторий
mixed offsetGet(string $key)

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

from Репозиторий
void offsetSet(string $key, mixed $value)

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

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

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

from Репозиторий
int getSeconds(DateTimeInterface|DateInterval|int $ttl)

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

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

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

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

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

string taggedItemKey(string $key)

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

Набор тегов getTags()

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

Подробности

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

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

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

int

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

Получить отметку времени 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, 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)

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

Параметры

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(string $key)

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

Параметры

string $key

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

bool

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

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

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

Параметры

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

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

bool

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

{@inheritdoc}

Параметры

$key
$value
$ttl

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

setMultiple($values, $ttl = null)

{@inheritdoc}

Параметры

$values
$ttl

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)

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

Параметры

string $key
mixed $value

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

int|bool

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

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

Параметры

string $key
mixed $value

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

int|bool
END_OF_DOCUMENT_MARKER

bool forever(string $key, mixed $value)

Хранить элемент в кэше неопределенно.

Параметры

string $key
mixed $value

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

bool

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

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

Параметры

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

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

mixed

mixed sear(string $key, Closure $callback)

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

Параметры

string $key
Closure $callback

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

mixed

mixed rememberForever(string $key, Closure $callback)

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

Параметры

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

int|null getDefaultCacheTime()

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

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

int|null

$this setDefaultCacheTime(int|null $seconds)

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

Параметры

int|null $seconds

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

$this

Store getStore()

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

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

Store

protected void event(string $event)

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

Параметры

string $event

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

void

Dispatcher getEventDispatcher()

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

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

Dispatcher

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

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

Spec-Zone.ru

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