Spec-Zone.ru › Laravel 8

FileStore

class FileStore implements Store, LockProvider (View source)

Свойства

protected Filesystem $files

Экземпляр Illuminate Filesystem.

protected string $directory

Директория кэша файлов.

protected int|null $filePermission

Восьмеричное представление разрешений файла кэша.

Трейты

InteractsWithTime
HasCacheLock
RetrievesMultipleKeys

Методы

int secondsUntil(DateTimeInterface|DateInterval|int $delay)

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

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

Получить отметку времени Unix "доступно в" (available at).

из InteractsWithTime
DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)

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

из InteractsWithTime
int currentTime()

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

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

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

из HasCacheLock
Lock restoreLock(string $name, string $owner)

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

из HasCacheLock
array many(array $keys)

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

из RetrievesMultipleKeys
bool putMany(array $values, int $seconds)

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

из RetrievesMultipleKeys
void __construct(Filesystem $files, string $directory, int|null $filePermission = null)

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

mixed get(string|array $key)

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

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

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

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

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

void ensureCacheDirectoryExists(string $path)

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

void ensurePermissionsAreCorrect(string $path)

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

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

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

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

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

bool forever(string $key, mixed $value)

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

bool forget(string $key)

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

bool flush()

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

array getPayload(string $key)

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

array emptyPayload()

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

string path(string $key)

Получить полный путь для данного ключа кэша.

int expiration(int $seconds)

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

Filesystem getFilesystem()

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

string getDirectory()

Получить рабочую директорию кэша.

string getPrefix()

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

Подробности

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

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

Параметры

DateTimeInterface|DateInterval|int $delay

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

int

protected int availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Получить отметку времени Unix "доступно в" (available at).

Параметры

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

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

array many(array $keys)

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

Элементы, не найденные в кэше, будут иметь значение null.

Параметры

array $keys

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

array

bool putMany(array $values, int $seconds)

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

Параметры

array $values
int $seconds

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

bool

void __construct(Filesystem $files, string $directory, int|null $filePermission = null)

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

Параметры

Filesystem $files
string $directory
int|null $filePermission

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

void

mixed get(string|array $key)

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

Параметры

string|array $key

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

mixed

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

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

Параметры

string $key
mixed $value
int $seconds

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

bool

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

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

Параметры

string $key
mixed $value
int $seconds

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

bool

protected void ensureCacheDirectoryExists(string $path)

Создать директорию кэша файлов, если она не существует.

Параметры

string $path

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

void

protected void ensurePermissionsAreCorrect(string $path)

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

Параметры

string $path

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

void

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

bool forget(string $key)

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

Параметры

string $key

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

bool

bool flush()

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

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

bool

protected array getPayload(string $key)

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

Параметры

string $key

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

array

protected array emptyPayload()

Получить стандартный пустой набор данных для кэша.

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

array

protected string path(string $key)

Получить полный путь для данного ключа кэша.

Параметры

string $key

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

string

protected int expiration(int $seconds)

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

Параметры

int $seconds

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

int

Filesystem getFilesystem()

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

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

Filesystem

string getDirectory()

Получить рабочую директорию кеша.

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

string

string getPrefix()

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

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

string

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

Spec-Zone.ru

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