W3cubDocs

/Laravel 11

CacheEventMutex

class CacheEventMutex implements EventMutex, CacheAware (View source)

Properties

Factory $cache

The cache repository implementation.
string|null $store

The cache store that should be used.

Methods

void __construct(Factory $cache)

Create a new overlapping strategy.
bool create(Event $event)

Attempt to obtain an event mutex for the given event.
bool exists(Event $event)

Determine if an event mutex exists for the given event.
void forget(Event $event)

Clear the event mutex for the given event.
bool shouldUseLocks(Store $store)

Determine if the given store should use locks for cache event mutexes.
$this useStore(string $store)

Specify the cache store that should be used.

Details

void __construct(Factory $cache)

Create a new overlapping strategy.

Parameters

Factory $cache

Return Value

void

bool create(Event $event)

Attempt to obtain an event mutex for the given event.

Parameters

Event $event

Return Value

bool

bool exists(Event $event)

Determine if an event mutex exists for the given event.

Parameters

Event $event

Return Value

bool

void forget(Event $event)

Clear the event mutex for the given event.

Parameters

Event $event

Return Value

void

protected bool shouldUseLocks(Store $store)

Determine if the given store should use locks for cache event mutexes.

Parameters

Store $store

Return Value

bool

$this useStore(string $store)

Specify the cache store that should be used.

Parameters

string $store

Return Value

$this

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/11.x/Illuminate/Console/Scheduling/CacheEventMutex.html