Spec-Zone.ru › Laravel 5.3

TaggedCache

class TaggedCache extends Repository (View source)

Свойства

RetrievesMultipleKeys
Macroable

Свойства

static protected array $macros Зарегистрированные строковые макросы. from Macroable
protected Store $store Реализация хранилища кэша. from Repository
protected Dispatcher $events Реализация диспетчера событий. from Repository
protected int $default Число минут по умолчанию для хранения элементов. from Repository
protected TagSet $tags Экземпляр набора тегов.

Методы

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

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

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)

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

void setEventDispatcher(Dispatcher $events)

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

from Repository
void fireCacheEvent(string $event, array $payload)

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

bool has(string $key)

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

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

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

from Repository
array many(array $keys)

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

from RetrievesMultipleKeys
mixed pull(string $key, mixed $default = null)

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

from Repository
void put(string $key, mixed $value, DateTime|int $minutes = null)

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

from Repository
void putMany(array $values, int $minutes)

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

from RetrievesMultipleKeys
bool add(string $key, mixed $value, DateTime|int $minutes)

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

from Repository
void forever(string $key, mixed $value)

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

from Repository
mixed remember(string $key, DateTime|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
TaggedCache tags(array|mixed $names)

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

from Repository
string itemKey(string $key)

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

int getDefaultCacheTime()

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

from Repository
void setDefaultCacheTime(int $minutes)

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

from Repository
Store getStore()

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

from Repository
bool offsetExists(string $key)

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

from Repository
mixed offsetGet(string $key)

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

from Repository
void offsetSet(string $key, mixed $value)

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

from Repository
void offsetUnset(string $key)

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

from Repository
int|null getMinutes(DateTime|int $duration)

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

from Repository
void __clone()

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

from Repository
void increment(string $key, mixed $value = 1)

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

void decrement(string $key, mixed $value = 1)

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

void flush()

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

string taggedItemKey(string $key)

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

Details

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

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

Параметры

string $name
callable $macro

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

void

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

void setEventDispatcher(Dispatcher $events)

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

Параметры

Dispatcher $events

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

void

protected void fireCacheEvent(string $event, array $payload)

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

Параметры

string $event
array $payload

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

void

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

mixed pull(string $key, mixed $default = null)

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

Параметры

string $key
mixed $default

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

mixed

void put(string $key, mixed $value, DateTime|int $minutes = null)

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

Параметры

string $key
mixed $value
DateTime|int $minutes

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

void

void putMany(array $values, int $minutes)

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

Параметры

array $values
int $minutes

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

void

bool add(string $key, mixed $value, DateTime|int $minutes)

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

Параметры

string $key
mixed $value
DateTime|int $minutes

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

bool

void forever(string $key, mixed $value)

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

Параметры

string $key
mixed $value

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

void

mixed remember(string $key, DateTime|int $minutes, Closure $callback)

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

Параметры

string $key
DateTime|int $minutes
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

TaggedCache tags(array|mixed $names)

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

Параметры

array|mixed $names

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

TaggedCache

Исключения

BadMethodCallException

protected string itemKey(string $key)

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

Параметры

string $key

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

string

int getDefaultCacheTime()

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

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

int

void setDefaultCacheTime(int $minutes)

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

Параметры

int $minutes

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

void

Store getStore()

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

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

Store

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|null getMinutes(DateTime|int $duration)

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

Параметры

DateTime|int $duration

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

int|null

void __clone()

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

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

void

void increment(string $key, mixed $value = 1)

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

Параметры

string $key
mixed $value

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

void

void decrement(string $key, mixed $value = 1)

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

Параметры

string $key
mixed $value

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

void

void flush()

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

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

void

string taggedItemKey(string $key)

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

Параметры

string $key

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

string

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

Spec-Zone.ru

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