1. class
  2. Illuminate
  3. \
  4. Console
  5. \
  6. CacheCommandMutex

CacheCommandMutex

class CacheCommandMutex implements CommandMutex (View source)

Traits

InteractsWithTime

Properties

Factory $cache

The cache factory implementation.
string|null $store

The cache store that should be used.

Methods

int
secondsUntil(DateTimeInterface|DateInterval|int $delay)

Get the number of seconds until the given DateTime.

from  InteractsWithTime
int
availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Get the "available at" UNIX timestamp.

from  InteractsWithTime
DateTimeInterface|int
parseDateInterval(DateTimeInterface|DateInterval|int $delay)

If the given value is an interval, convert it to a DateTime instance.

from  InteractsWithTime
int
currentTime()

Get the current system time as a UNIX timestamp.

from  InteractsWithTime
string
runTimeForHumans(float $startTime, float $endTime = null)

Given a start time, format the total run time for human readability.

from  InteractsWithTime
__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)

Get the isolatable command mutex name.

$this
useStore(string|null $store)

Specify the cache store that should be used.

bool
shouldUseLocks(Store $store)

Determine if the given store should use locks for command mutexes.

Details

in InteractsWithTime at line 17
protected int secondsUntil(DateTimeInterface|DateInterval|int $delay)

Get the number of seconds until the given DateTime.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

int

in InteractsWithTime at line 32
protected int availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Get the "available at" UNIX timestamp.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

int

in InteractsWithTime at line 47
protected DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)

If the given value is an interval, convert it to a DateTime instance.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

DateTimeInterface|int

in InteractsWithTime at line 61
protected int currentTime()

Get the current system time as a UNIX timestamp.

Return Value

int

in InteractsWithTime at line 73
protected string runTimeForHumans(float $startTime, float $endTime = null)

Given a start time, format the total run time for human readability.

Parameters

float $startTime
float $endTime

Return Value

string

at line 34
__construct(Factory $cache)

Create a new command mutex.

Parameters

Factory $cache

at line 45
bool create(Command $command)

Attempt to obtain a command mutex for the given command.

Parameters

Command $command

Return Value

bool

at line 69
bool exists(Command $command)

Determine if a command mutex exists for the given command.

Parameters

Command $command

Return Value

bool

at line 92
bool forget(Command $command)

Release the mutex for the given command.

Parameters

Command $command

Return Value

bool

at line 109
protected string commandMutexName(Command $command)

Get the isolatable command mutex name.

Parameters

Command $command

Return Value

string

at line 124
$this useStore(string|null $store)

Specify the cache store that should be used.

Parameters

string|null $store

Return Value

$this

at line 137
protected bool shouldUseLocks(Store $store)

Determine if the given store should use locks for command mutexes.

Parameters

Store $store

Return Value

bool