Spec-Zone.ru › Laravel 8

TaggedCache

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

Черты

RetrievesMultipleKeys
InteractsWithTime
Macroable

Свойства

static protected array $macros

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

из Macroable
protected Store $store

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

из Repository
protected Dispatcher $events

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

из Repository
protected int|null $default

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

из Repository
protected TagSet $tags

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

Методы

int secondsUntil(DateTimeInterface|DateInterval|int $delay)

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

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

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

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

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

from InteractsWithTime
int currentTime()

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

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

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

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

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

from Macroable
static bool hasMacro(string $name)

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

from Macroable
static void flushMacros()

Очистить существующие макросы.

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)

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

bool has(string $key)

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

from Repository
bool missing(string $key)

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

from Repository
mixed get(string $key, mixed $default = null)

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

from Repository
array many(array $keys)

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

from RetrievesMultipleKeys
iterable 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
bool put(string $key, mixed $value, DateTimeInterface|DateInterval|int|null $ttl = null)

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

from Repository
bool set($key, $value, $ttl = null)

{@inheritdoc}

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

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

bool putManyForever(array $values)

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

from Repository
bool setMultiple($values, $ttl = null)

{@inheritdoc}

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

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

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

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

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

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

bool forever(string $key, mixed $value)

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

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

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

from Repository
mixed sear(string $key, Closure $callback)

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

from Repository
mixed rememberForever(string $key, Closure $callback)

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

из Repository
bool forget(string $key)

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

из Repository
bool delete($key)

{@inheritdoc}

из Repository
bool deleteMultiple($keys)

{@inheritdoc}

из Repository
bool clear()

{@inheritdoc}

из Repository
TaggedCache tags(array|mixed $names)

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

из Repository
string itemKey(string $key)

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

int getSeconds(DateTimeInterface|DateInterval|int $ttl)

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

из Repository
bool supportsTags()

Определить, поддерживает ли текущее хранилище теги.

из Repository
int|null getDefaultCacheTime()

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

из Repository
$this setDefaultCacheTime(int|null $seconds)

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

из Repository
Store getStore()

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

из Repository
void event(object|string $event)

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

Dispatcher getEventDispatcher()

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

из Repository
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
void __clone()

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

из Repository
bool flush()

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

string taggedItemKey(string $key)

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

TagSet getTags()

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

Details

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

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

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
END_OF_DOCUMENT_MARKER

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 void flushMacros()

Очистить существующие макросы.

Return Value

void

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

iterable getMultiple($keys, $default = null)

{@inheritdoc}

Parameters

$keys
$default

Return Value

iterable

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

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

{@inheritdoc}

Parameters

$key
$value
$ttl

Return Value

bool

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

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

Parameters

array $values
DateTimeInterface|DateInterval|int|null $ttl

Return Value

bool

protected bool putManyForever(array $values)

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

Parameters

array $values

Return Value

bool

bool setMultiple($values, $ttl = null)

{@inheritdoc}

Parameters

$values
$ttl

Return Value

bool

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

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

bool delete($key)

{@inheritdoc}

Parameters

$key

Return Value

bool

bool deleteMultiple($keys)

{@inheritdoc}

Parameters

$keys

Return Value

bool

bool clear()

{@inheritdoc}

Return Value

bool

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

protected int getSeconds(DateTimeInterface|DateInterval|int $ttl)

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

Parameters

DateTimeInterface|DateInterval|int $ttl

Return Value

int

bool supportsTags()

Определить, поддерживает ли текущее хранилище теги.

Return Value

bool

int|null getDefaultCacheTime()

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

Return Value

int|null

$this setDefaultCacheTime(int|null $seconds)

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

Parameters

int|null $seconds

Return Value

$this

Store getStore()

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

Return Value

Store

protected void event(object|string $event)

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

Parameters

object|string $event

Return Value

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

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/8.x/Illuminate/Cache/TaggedCache.html

Spec-Zone.ru

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