Spec-Zone.ru › Laravel 5.8

DynamoDbStore

class DynamoDbStore implements Store, LockProvider (View source)

Свойства

protected DynamoDbClient $dynamo Экземпляр клиента DynamoDB.
protected string $table Имя таблицы.
protected string $keyAttribute Имя атрибута, содержащего ключ.
protected string $valueAttribute Имя атрибута, содержащего значение.
protected string $expirationAttribute Имя атрибута, содержащего отметку времени истечения срока действия.
protected string $prefix Строка, которая должна быть добавлена в префикс к ключам.

Трейты

InteractsWithTime

Методы

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)

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

Подробности

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

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(string $name, int $seconds = 0, string|null $owner = null)

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

Параметры

string $name
int $seconds
string|null $owner

Значение возврата

Блокировка

Блокировка restoreLock(string $name, string $owner)

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

Параметры

string $name
string $owner

Значение возврата

Блокировка

bool forget(string $key)

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

Параметры

string $key

Значение возврата

bool

bool flush()

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

Значение возврата

bool

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

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

Spec-Zone.ru

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