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
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
void __construct(bool $serializesValues = false)

Create a new Array store.
mixed get(string|array $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.
int calculateExpiration(int $seconds)

Get the expiration time of the key.
int toTimestamp(int $seconds)

Get the UNIX timestamp for the given number of seconds.
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

TaggedCache tags(array|mixed $names)

Begin executing a new tags operation.

Parameters

array|mixed $names

Return Value

TaggedCache

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

Get the number of seconds until the given DateTime.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

int

protected int availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Get the "available at" UNIX timestamp.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

int

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

protected int currentTime()

Get the current system time as a UNIX timestamp.

Return Value

int

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

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

void __construct(bool $serializesValues = false)

Create a new Array store.

Parameters

bool $serializesValues

Return Value

void

mixed get(string|array $key)

Retrieve an item from the cache by key.

Parameters

string|array $key

Return Value

mixed

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

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

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

bool forever(string $key, mixed $value)

Store an item in the cache indefinitely.

Parameters

string $key
mixed $value

Return Value

bool

bool forget(string $key)

Remove an item from the cache.

Parameters

string $key

Return Value

bool

bool flush()

Remove all items from the cache.

Return Value

bool

string getPrefix()

Get the cache key prefix.

Return Value

string

protected int calculateExpiration(int $seconds)

Get the expiration time of the key.

Parameters

int $seconds

Return Value

int

protected int toTimestamp(int $seconds)

Get the UNIX timestamp for the given number of seconds.

Parameters

int $seconds

Return Value

int

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

Lock restoreLock(string $name, string $owner)

Restore a lock instance using the owner identifier.

Parameters

string $name
string $owner

Return Value

Lock

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/7.x/Illuminate/Cache/ArrayStore.html