class FlockStore implements StoreInterface

FlockStore is a StoreInterface implementation using the FileSystem flock.

Original implementation in \Symfony\Component\Filesystem\LockHandler.

Methods

__construct(string $lockPath = null)

No description

save(Key $key)

Stores the resource if it's not locked by someone else.

waitAndSave(Key $key)

Waits until a key becomes free, then stores the resource.

putOffExpiration(Key $key, $ttl)

Extends the ttl of a resource.

delete(Key $key)

Removes a resource from the storage.

bool
exists(Key $key)

Returns whether or not the resource exists in the storage.

Details

at line 39
__construct(string $lockPath = null)

Parameters

string $lockPath the directory to store the lock, defaults to the system's temporary directory

Exceptions

LockStorageException If the lock directory doesn’t exist or is not writable

at line 54
save(Key $key)

Stores the resource if it's not locked by someone else.

Parameters

Key $key

Exceptions

LockConflictedException

at line 62
waitAndSave(Key $key)

Waits until a key becomes free, then stores the resource.

If the store does not support this feature it should throw a NotSupportedException.

at line 109
putOffExpiration(Key $key, $ttl)

Extends the ttl of a resource.

If the store does not support this feature it should throw a NotSupportedException.

Parameters

Key $key
$ttl

Exceptions

LockConflictedException
NotSupportedException

at line 117
delete(Key $key)

Removes a resource from the storage.

Parameters

Key $key

at line 135
bool exists(Key $key)

Returns whether or not the resource exists in the storage.

Parameters

Key $key

Return Value

bool