Spec-Zone.ru › Laravel 5.6

FileStore

class FileStore implements Store (View source)

Свойства

InteractsWithTime
RetrievesMultipleKeys

Свойства

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

Методы

int secondsUntil(DateTimeInterface|DateInterval|int $delay)

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

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

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

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

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

из InteractsWithTime
int currentTime()

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

из InteractsWithTime
array many(array $keys)

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

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

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

из 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()

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

string path(string $key)

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

int expiration(float|int $minutes)

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

Filesystem getFilesystem()

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

string getDirectory()

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

string getPrefix()

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

Подробное описание методов

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

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

Параметры

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
END_OF_DOCUMENT_MARKER

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)

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

Параметры

string|array $key

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

mixed

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

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

Параметры

string $key
mixed $value
float|int $minutes

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

void

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

void forever(string $key, mixed $value)

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

Параметры

string $key
mixed $value

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

void

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

Spec-Zone.ru

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