laravel / 10 / api / 10.x / illuminate / console / cachecommandmutex.html

CacheCommandMutex

class CacheCommandMutex implements CommandMutex (View source)

Properties

Factory $cache

The cache factory implementation.

string|null $store

The cache store that should be used.

Methods

__construct(Factory $cache)

Create a new command mutex.

bool create(Command $command)

Attempt to obtain a command mutex for the given command.

bool exists(Command $command)

Determine if a command mutex exists for the given command.

bool forget(Command $command)

Release the mutex for the given command.

string commandMutexName(Command $command)

No description

$this useStore(string|null $store)

Specify the cache store that should be used.

Details

__construct(Factory $cache)

Create a new command mutex.

Parameters

Factory $cache

bool create(Command $command)

Attempt to obtain a command mutex for the given command.

Parameters

Command $command

Return Value

bool

bool exists(Command $command)

Determine if a command mutex exists for the given command.

Parameters

Command $command

Return Value

bool

bool forget(Command $command)

Release the mutex for the given command.

Parameters

Command $command

Return Value

bool

protected string commandMutexName(Command $command)

No description

Parameters

Command $command

Return Value

string

$this useStore(string|null $store)

Specify the cache store that should be used.

Parameters

string|null $store

Return Value

$this

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