Spec-Zone.ru › Laravel 7

Репозиторий

класс Репозиторий реализует ArrayAccess, Репозиторий mixin Хранилище (Просмотреть исходный код)

Трейты

Взаимодействие со временем
Макросовместимый

Свойства

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

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

из Макросовместимого
защищенный Хранилище $store

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

защищенный Диспетчер событий $events

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

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

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

Методы

int secondsUntil(DateTimeInterface|DateInterval|int $delay)

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

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

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

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

Обработать динамические вызовы в макро или передать отсутствующие методы в хранилище.

void __construct(Store $store)

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

bool has(string $key)

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

bool missing(string $key)

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

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

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

array many(array $keys)

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

getMultiple($keys, $default = null)

{@inheritdoc}

mixed handleManyResult(array $keys, string $key, mixed $value)

Обработать результат метода "many".

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

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

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

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

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

{@inheritdoc}

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

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

bool putManyForever(array $values)

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

setMultiple($values, $ttl = null)

{@inheritdoc}

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

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

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

mixed sear(string $key, Closure $callback)

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

mixed rememberForever(string $key, Closure $callback)

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

bool forget(string $key)

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

delete($key)

{@inheritdoc}

deleteMultiple($keys)

{@inheritdoc}

clear()

{@inheritdoc}

TaggedCache tags(array|mixed $names)

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

string itemKey(string $key)

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

int|null getDefaultCacheTime()

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

$this setDefaultCacheTime(int|null $seconds)

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

Store getStore()

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

void event(string $event)

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

Dispatcher getEventDispatcher()

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

void setEventDispatcher(Dispatcher $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()

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

Подробности

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

void __construct(Store $store)

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

Параметры

Store $store

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

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

Параметры

массив $keys
строка $key
смешанный тип $value

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

смешанный тип

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

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

Параметры

строка $key
смешанный тип $default

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

смешанный тип

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

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

Параметры

строка $key
смешанный тип $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)

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

Параметры

массив $values
DateTimeInterface|DateInterval|int|null $ttl

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

bool

protected bool putManyForever(array $values)

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

Параметры

массив $values

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

bool

setMultiple($values, $ttl = null)

{@inheritdoc}

Параметры

$values
$ttl

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

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

Параметры

строка $key
смешанный тип $value
DateTimeInterface|DateInterval|int|null $ttl

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

bool

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

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

Параметры

строка $key
смешанный тип $value

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

int|bool

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

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

Параметры

строка $key
смешанный тип $value

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

int|bool

bool forever(string $key, mixed $value)

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

Параметры

строка $key
смешанный тип $value

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

bool

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

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

Параметры

строка $key
DateTimeInterface|DateInterval|int|null $ttl
Closure $callback

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

смешанный тип

mixed sear(string $key, Closure $callback)

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

Параметры

строка $key
Closure $callback

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

смешанный тип

mixed rememberForever(string $key, Closure $callback)

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

Параметры

строка $key
Closure $callback

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

смешанный тип

bool forget(string $key)

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

Параметры

строка $key

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

bool

delete($key)

{@inheritdoc}

Параметры

$key

deleteMultiple($keys)

{@inheritdoc}

Параметры

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

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

Parameters

string $event

Return Value

void

Dispatcher getEventDispatcher()

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

Return Value

Dispatcher

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.

Parameters

DateTimeInterface|DateInterval|int $ttl

Return Value

int

void __clone()

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

Return Value

void

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

Spec-Zone.ru

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