FileStore

класс FileStore реализует Store, LockProvider (Просмотреть исходный код)

Трейты

Свойства

protected Filesystem	$files	Экземпляр Illuminate Filesystem.
protected string	$directory	Директория кеша файлов.
protected int\|null	$filePermission	Восьмеричное представление разрешений файла кеша.

Методы

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

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)

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

Lock

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

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

Lock

restoreLock(string $name, string $owner)

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

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 "доступно в".

Параметры

DateTimeInterface|DateInterval|int

$delay

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

int

END_OF_DOCUMENT_MARKER

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

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

Parameters

DateTimeInterface|DateInterval|int

$delay

Return Value

DateTimeInterface|int

protected int currentTime()

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

Return Value

int

array many(array $keys)

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

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

Parameters

array

$keys

Return Value

array

bool putMany(array $values, int $seconds)

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

Parameters

array	$values
int	$seconds

Return Value

bool

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

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

Parameters

Filesystem	$files
string	$directory
int\|null	$filePermission

Return Value

void

mixed get(string|array $key)

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

Parameters

string|array

$key

Return Value

mixed

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

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

Parameters

string	$key
mixed	$value
int	$seconds

Return Value

bool

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

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

Parameters

string	$key
mixed	$value
int	$seconds

Return Value

bool

protected void ensureCacheDirectoryExists(string $path)

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

Parameters

string

$path

Return Value

void

protected void ensurePermissionsAreCorrect(string $path)

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

Parameters

string

$path

Return Value

void

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

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

Parameters

string	$key
mixed	$value

Return Value

int|bool

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

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

Parameters

string	$key
mixed	$value

Return Value

int|bool

bool forever(string $key, mixed $value)

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

Parameters

string	$key
mixed	$value

Return Value

bool

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

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

Parameters

string	$name
int	$seconds
string\|null	$owner

Return Value

Lock

Lock restoreLock(string $name, string $owner)

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

Parameters

string	$name
string	$owner

Return Value

Lock

bool forget(string $key)

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

Parameters

string

$key

Return Value

bool

bool flush()

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

Return Value

bool

protected array getPayload(string $key)

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

Parameters

string

$key

Return Value

array

protected array emptyPayload()

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

Return Value

array

protected string path(string $key)

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

Parameters

string

$key

Return Value

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/9.x/Illuminate/Cache/FileStore.html