Spec-Zone.ru › Laravel 5.8

TaggedCache

class TaggedCache extends Repository (View source)

Особенности

RetrievesMultipleKeys
InteractsWithTime
Macroable

Свойства

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 Экземпляр набора тегов.

Методы

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)

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

из Репозитория
delete($key)

{@inheritdoc}

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

{@inheritdoc}

из Репозитория
clear()

{@inheritdoc}

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

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

из Репозитория
string itemKey(string $key)

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

int getDefaultCacheTime()

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

string taggedItemKey(string $key)

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

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

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

Подробности

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

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

Параметры

object $mixin
bool $replace

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

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

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

bool forever(string $key, mixed $value)

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

Параметры

string $key
mixed $value

Значение результата

bool

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

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

Параметры

string $key
DateTimeInterface|DateInterval|int|null $ttl
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

int getDefaultCacheTime()

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

Значение результата

int

$this setDefaultCacheTime(int|null $seconds)

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

Параметры

int|null $seconds

Значение результата

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

Spec-Zone.ru

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