Spec-Zone.ru › Laravel 8

DynamoDbStore

класс DynamoDbStore реализует LockProvider, Store (View source)

Черты

InteractsWithTime

Свойства

protected DynamoDbClient $dynamo

Экземпляр клиента DynamoDB.

protected string $table

Название таблицы.

protected string $keyAttribute

Название атрибута, который должен хранить ключ.

protected string $valueAttribute

Название атрибута, который должен хранить значение.

protected string $expirationAttribute

Название атрибута, который должен хранить метку времени истечения срока действия.

protected string $prefix

Строка, которая должна быть добавлена в начало ключей.

Методы

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
void __construct(DynamoDbClient $dynamo, string $table, string $keyAttribute = 'key', string $valueAttribute = 'value', string $expirationAttribute = 'expires_at', string $prefix = '')

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

mixed get(string|array $key)

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

array many(array $keys)

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

bool isExpired(array $item, DateTimeInterface|null $expiration = null)

Определить, истёк ли срок действия заданного элемента.

bool put(string $key, mixed $value, int $seconds)

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

bool putMany(array $values, int $seconds)

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

bool add(string $key, mixed $value, int $seconds)

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

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

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

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

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

bool forever(string $key, mixed $value)

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

Lock lock(string $name, int $seconds = 0, string|null $owner = null)

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

Lock restoreLock(string $name, string $owner)

Восстановить экземпляр блокировки с использованием идентификатора владельца.

bool forget(string $key)

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

bool flush()

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

int toTimestamp(int $seconds)

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

mixed serialize(mixed $value)

Сериализовать значение.

mixed unserialize(mixed $value)

Десериализовать значение.

string type(mixed $value)

Получить тип DynamoDB для заданного значения.

string getPrefix()

Получить префикс ключа кэша.

void setPrefix(string $prefix)

Установить префикс ключа кэша.

DynamoDbClient getClient()

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

Подробности

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
END_OF_DOCUMENT_MARKER

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

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

Параметры

DateTimeInterface|DateInterval|int $delay

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

DateTimeInterface|int

protected int currentTime()

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

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

int

void __construct(DynamoDbClient $dynamo, string $table, string $keyAttribute = 'key', string $valueAttribute = 'value', string $expirationAttribute = 'expires_at', string $prefix = '')

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

Параметры

DynamoDbClient $dynamo
string $table
string $keyAttribute
string $valueAttribute
string $expirationAttribute
string $prefix

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

void

mixed get(string|array $key)

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

Параметры

string|array $key

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

mixed

array many(array $keys)

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

Для элементов, не найденных в кэше, значение будет null.

Параметры

array $keys

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

array

protected bool isExpired(array $item, DateTimeInterface|null $expiration = null)

Определить, истек ли срок действия заданного элемента.

Параметры

array $item
DateTimeInterface|null $expiration

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

bool

bool put(string $key, mixed $value, int $seconds)

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

Параметры

string $key
mixed $value
int $seconds

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

bool

bool putMany(array $values, int $seconds)

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

Параметры

array $values
int $seconds

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

bool

bool add(string $key, mixed $value, int $seconds)

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

Параметры

string $key
mixed $value
int $seconds

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

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

Lock lock(string $name, int $seconds = 0, string|null $owner = null)

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

Параметры

string $name
int $seconds
string|null $owner

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

Lock

Lock restoreLock(string $name, string $owner)

Восстановить экземпляр блокировки с использованием идентификатора владельца.

Параметры

string $name
string $owner

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

Lock

bool forget(string $key)

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

Параметры

string $key

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

bool

bool flush()

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

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

bool

Исключения

RuntimeException

protected int toTimestamp(int $seconds)

Получить метку времени Unix для заданного количества секунд.

Параметры

int $seconds

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

int

protected mixed serialize(mixed $value)

Сериализовать значение.

Параметры

mixed $value

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

mixed

protected mixed unserialize(mixed $value)

Десериализовать значение.

Параметры

mixed $value

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

mixed

protected string type(mixed $value)

Получить тип DynamoDB для данного значения.

Параметры

mixed $value

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

string

string getPrefix()

Получить префикс ключа кэша.

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

string

void setPrefix(string $prefix)

Установить префикс ключа кэша.

Параметры

string $prefix

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

void

DynamoDbClient getClient()

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

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

DynamoDbClient

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

Spec-Zone.ru

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