CombinedStore

class CombinedStore implements StoreInterface, LoggerAwareInterface

CombinedStore is a StoreInterface implementation able to manage and synchronize several StoreInterfaces.

Traits

LoggerAwareTrait

Methods

__construct(array $stores, StrategyInterface $strategy)
save(Key $key)

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

waitAndSave(Key $key)

Waits a key becomes free, then stores the resource.

putOffExpiration(Key $key, float $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

__construct(array $stores, StrategyInterface $strategy)

Parameters

array $stores The list of synchronized stores
StrategyInterface $strategy

Exceptions

InvalidArgumentException

save(Key $key)

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

Parameters

Key $key key to lock

Exceptions

LockConflictedException

waitAndSave(Key $key)

Waits a key becomes free, then stores the resource.

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

Parameters

Key $key key to lock

Exceptions

LockConflictedException
NotSupportedException

putOffExpiration(Key $key, float $ttl)

Extends the ttl of a resource.

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

Parameters

Key $key key to lock
float $ttl amount of second to keep the lock in the store

Exceptions

LockConflictedException
NotSupportedException

delete(Key $key)

Removes a resource from the storage.

Parameters

Key $key key to remove

bool exists(Key $key)

Returns whether or not the resource exists in the storage.

Parameters

Key $key key to remove

Return Value

bool

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/4.0/Symfony/Component/Lock/Store/CombinedStore.html