Spec-Zone.ru › Laravel 5.5

FileStore

class FileStore implements Store (View source)

Свойства

InteractsWithTime
RetrievesMultipleKeys

Свойства

protected Filesystem $files Экземпляр класса Illuminate Filesystem.
protected string $directory Директория кеша файлов.

Методы

int secondsUntil(DateTimeInterface|DateInterval|int $delay)

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

from InteractsWithTime
int availableAt(DateTimeInterface|DateInterval|int $delay)

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

from InteractsWithTime
DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)

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

from InteractsWithTime
int currentTime()

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

from InteractsWithTime
array many(array $keys)

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

from RetrievesMultipleKeys
void putMany(array $values, float|int $minutes)

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

from RetrievesMultipleKeys
void __construct(Filesystem $files, string $directory)

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

mixed get(string|array $key)

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

void put(string $key, mixed $value, float|int $minutes)

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

void ensureCacheDirectoryExists(string $path)

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

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

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

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

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

void forever(string $key, mixed $value)

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

bool forget(string $key)

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

bool flush()

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

array getPayload(string $key)

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

array emptyPayload()

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

string path(string $key)

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

int expiration(float|int $minutes)

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

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)

Получить отметку времени 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

array many(array $keys)

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

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

Параметры

array $keys

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

array

void putMany(array $values, float|int $minutes)

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

Параметры

array $values
float|int $minutes

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

void

void __construct(Filesystem $files, string $directory)

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

Параметры

Filesystem $files
string $directory

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

void

mixed get(string|array $key)

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

Parameters

string|array $key

Return Value

mixed

void put(string $key, mixed $value, float|int $minutes)

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

Parameters

string $key
mixed $value
float|int $minutes

Return Value

void

protected void ensureCacheDirectoryExists(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

void forever(string $key, mixed $value)

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

Parameters

string $key
mixed $value

Return Value

void

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(float|int $minutes)

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

Параметры

float|int $minutes

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

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

Spec-Zone.ru

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