ArrayStore
class ArrayStore extends TaggableStore implements CanFlushLocks, LockProvider (View source)
Traits
Properties
| protected | $storage | The array of stored values. |
|
| $locks | The array of locks. |
||
| protected bool | $serializesValues | Indicates if values are serialized within the store. |
|
| protected array|bool|null | $serializableClasses | The classes that should be allowed during unserialization. |
Methods
Get the number of seconds until the given DateTime.
If the given value is an interval, convert it to a DateTime instance.
Given a start time, format the total run time for human readability.
Store multiple items in the cache for a given number of seconds.
Create a new Array store.
Get all of the cached values and their expiration times.
Retrieve an item from the cache by key.
Store an item in the cache for a given number of seconds.
Increment the value of an item in the cache.
Decrement the value of an item in the cache.
Store an item in the cache indefinitely.
Adjust the expiration time of a cached item.
Remove an item from the cache.
Remove all items from the cache.
Remove all locks from the store.
Get the cache key prefix.
Get the expiration time of the key.
Get the UNIX timestamp, with milliseconds, for the given number of seconds in the future.
Restore a lock instance using the owner identifier.
Determine if the lock store is separate from the cache store.
Unserialize the given value.
Details
TaggedCache
tags(mixed $names)
Begin executing a new tags operation.
protected int
secondsUntil(DateTimeInterface|DateInterval|int $delay)
Get the number of seconds until the given DateTime.
protected int
availableAt(DateTimeInterface|DateInterval|int $delay = 0)
Get the "available at" UNIX timestamp.
protected DateTimeInterface|int
parseDateInterval(DateTimeInterface|DateInterval|int $delay)
If the given value is an interval, convert it to a DateTime instance.
protected int
currentTime()
Get the current system time as a UNIX timestamp.
protected string
runTimeForHumans(float $startTime, float|null $endTime = null)
Given a start time, format the total run time for human readability.
array
many(array $keys)
Retrieve multiple items from the cache by key.
Items not found in the cache will have a null value.
bool
putMany(array $values, int $seconds)
Store multiple items in the cache for a given number of seconds.
__construct(bool $serializesValues = false, array|bool|null $serializableClasses = null)
Create a new Array store.
all(bool $unserialize = true)
Get all of the cached values and their expiration times.
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
touch(string $key, int $seconds)
Adjust the expiration time of a cached item.
bool
forget(string $key)
Remove an item from the cache.
bool
flush()
Remove all items from the cache.
bool
flushLocks()
Remove all locks from the store.
string
getPrefix()
Get the cache key prefix.
protected float
calculateExpiration(int $seconds)
Get the expiration time of the key.
protected 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.
bool
hasSeparateLockStore()
Determine if the lock store is separate from the cache store.
protected mixed
unserialize(string $value)
Unserialize the given value.