1. class
  2. Illuminate
  3. \
  4. Cache
  5. \
  6. FileStore

FileStore

class FileStore implements Store

Traits

RetrievesMultipleKeys

Properties

protected Filesystem $files

The Illuminate Filesystem instance.
protected string $directory

The file cache directory.

Methods

array
many(array $keys)

Retrieve multiple items from the cache by key.

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

Store multiple items in the cache for a given number of minutes.

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

Create a new file cache store instance.

mixed
get(string|array $key)

Retrieve an item from the cache by key.

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

Store an item in the cache for a given number of minutes.

void
ensureCacheDirectoryExists(string $path)

Create the file cache directory if necessary.

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

Increment the value of an item in the cache.

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

Decrement the value of an item in the cache.

void
forever(string $key, mixed $value)

Store an item in the cache indefinitely.

bool
forget(string $key)

Remove an item from the cache.

bool
flush()

Remove all items from the cache.

array
getPayload(string $key)

Retrieve an item and expiry time from the cache by key.

array
emptyPayload()

Get a default empty payload for the cache.

string
path(string $key)

Get the full path for the given cache key.

int
expiration(float|int $minutes)

Get the expiration time based on the given minutes.

Filesystem
getFilesystem()

Get the Filesystem instance.

string
getDirectory()

Get the working directory of the cache.

string
getPrefix()

Get the cache key prefix.

Details

in RetrievesMultipleKeys at line 15
array many(array $keys)

Retrieve multiple items from the cache by key.

Items not found in the cache will have a null value.

Parameters

array $keys

Return Value

array

in RetrievesMultipleKeys at line 33
void putMany(array $values, float|int $minutes)

Store multiple items in the cache for a given number of minutes.

Parameters

array $values
float|int $minutes

Return Value

void

at line 36
void __construct(Filesystem $files, string $directory)

Create a new file cache store instance.

Parameters

Filesystem $files
string $directory

Return Value

void

at line 48
mixed get(string|array $key)

Retrieve an item from the cache by key.

Parameters

string|array $key

Return Value

mixed

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

Store an item in the cache for a given number of minutes.

Parameters

string $key
mixed $value
float|int $minutes

Return Value

void

at line 76
protected void ensureCacheDirectoryExists(string $path)

Create the file cache directory if necessary.

Parameters

string $path

Return Value

void

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

Increment the value of an item in the cache.

Parameters

string $key
mixed $value

Return Value

int|bool

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

Decrement the value of an item in the cache.

Parameters

string $key
mixed $value

Return Value

int|bool

at line 118
void forever(string $key, mixed $value)

Store an item in the cache indefinitely.

Parameters

string $key
mixed $value

Return Value

void

at line 129
bool forget(string $key)

Remove an item from the cache.

Parameters

string $key

Return Value

bool

at line 143
bool flush()

Remove all items from the cache.

Return Value

bool

at line 164
protected array getPayload(string $key)

Retrieve an item and expiry time from the cache by key.

Parameters

string $key

Return Value

array

at line 203
protected array emptyPayload()

Get a default empty payload for the cache.

Return Value

array

at line 214
protected string path(string $key)

Get the full path for the given cache key.

Parameters

string $key

Return Value

string

at line 227
protected int expiration(float|int $minutes)

Get the expiration time based on the given minutes.

Parameters

float|int $minutes

Return Value

int

at line 239
Filesystem getFilesystem()

Get the Filesystem instance.

Return Value

Filesystem

at line 249
string getDirectory()

Get the working directory of the cache.

Return Value

string

at line 259
string getPrefix()

Get the cache key prefix.

Return Value

string