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

ArrayStore

class ArrayStore extends TaggableStore implements LockProvider (View source)

Traits

InteractsWithTime
RetrievesMultipleKeys

Properties

protected array $storage

The array of stored values.
array $locks

The array of locks.
protected bool $serializesValues

Indicates if values are serialized within the store.

Methods

TaggedCache
tags(array|mixed $names)

Begin executing a new tags operation.

from  TaggableStore
int
secondsUntil(DateTimeInterface|DateInterval|int $delay)

Get the number of seconds until the given DateTime.

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

Get the "available at" UNIX timestamp.

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

If the given value is an interval, convert it to a DateTime instance.

from  InteractsWithTime
int
currentTime()

Get the current system time as a UNIX timestamp.

from  InteractsWithTime
string
runTimeForHumans(float $startTime, float $endTime = null)

Given a start time, format the total run time for human readability.

from  InteractsWithTime
array
many(array $keys)

Retrieve multiple items from the cache by key.

from  RetrievesMultipleKeys
bool
putMany(array $values, int $seconds)

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

from  RetrievesMultipleKeys
__construct(bool $serializesValues = false)

Create a new Array store.

mixed
get(string $key)

Retrieve an item from the cache by key.

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

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

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.

bool
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.

string
getPrefix()

Get the cache key prefix.

float
calculateExpiration(int $seconds)

Get the expiration time of the key.

float
toTimestamp(int $seconds)

Get the UNIX timestamp, with milliseconds, for the given number of seconds in the future.

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

Get a lock instance.

Lock
restoreLock(string $name, string $owner)

Restore a lock instance using the owner identifier.

Details

in TaggableStore at line 15
TaggedCache tags(array|mixed $names)

Begin executing a new tags operation.

Parameters

array|mixed $names

Return Value

TaggedCache

in InteractsWithTime at line 17
protected int secondsUntil(DateTimeInterface|DateInterval|int $delay)

Get the number of seconds until the given DateTime.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

int

in InteractsWithTime at line 32
protected int availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Get the "available at" UNIX timestamp.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

int

in InteractsWithTime at line 47
protected DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)

If the given value is an interval, convert it to a DateTime instance.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

DateTimeInterface|int

in InteractsWithTime at line 61
protected int currentTime()

Get the current system time as a UNIX timestamp.

Return Value

int

in InteractsWithTime at line 73
protected string runTimeForHumans(float $startTime, float $endTime = null)

Given a start time, format the total run time for human readability.

Parameters

float $startTime
float $endTime

Return Value

string

in RetrievesMultipleKeys at line 17
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 40
bool putMany(array $values, int $seconds)

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

Parameters

array $values
int $seconds

Return Value

bool

at line 39
__construct(bool $serializesValues = false)

Create a new Array store.

Parameters

bool $serializesValues

at line 50
mixed get(string $key)

Retrieve an item from the cache by key.

Parameters

string $key

Return Value

mixed

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

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

Parameters

string $key
mixed $value
int $seconds

Return Value

bool

at line 94
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 116
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 128
bool forever(string $key, mixed $value)

Store an item in the cache indefinitely.

Parameters

string $key
mixed $value

Return Value

bool

at line 139
bool forget(string $key)

Remove an item from the cache.

Parameters

string $key

Return Value

bool

at line 155
bool flush()

Remove all items from the cache.

Return Value

bool

at line 167
string getPrefix()

Get the cache key prefix.

Return Value

string

at line 178
protected float calculateExpiration(int $seconds)

Get the expiration time of the key.

Parameters

int $seconds

Return Value

float

at line 189
protected float toTimestamp(int $seconds)

Get the UNIX timestamp, with milliseconds, for the given number of seconds in the future.

Parameters

int $seconds

Return Value

float

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

Get a lock instance.

Parameters

string $name
int $seconds
string|null $owner

Return Value

Lock

at line 214
Lock restoreLock(string $name, string $owner)

Restore a lock instance using the owner identifier.

Parameters

string $name
string $owner

Return Value

Lock