1. class
  2. Civi
  3. \
  4. Core
  5. \
  6. Lock
  7. \
  8. NullLock

NullLock

class NullLock implements LockInterface

Methods

static NullLock
create(string $name)

Create lock.

bool
acquire(int|null $timeout = NULL)

Acquire lock.

bool|null|string
release()

Release lock.

bool|null|string
isFree() deprecated

No description

bool
isAcquired()

No description

Details

at line 45
static NullLock create(string $name)

Create lock.

Parameters

string $name

Return Value

NullLock

at line 58
bool acquire(int|null $timeout = NULL)

Acquire lock.

Parameters

int|null $timeout The number of seconds to wait to get the lock. For a default value, use NULL.

Return Value

bool

at line 69
bool|null|string release()

Release lock.

Return Value

bool|null|string Trueish/falsish.

at line 81
bool|null|string isFree() deprecated

deprecated Not supported by some locking strategies. If you need to poll, better to use acquire(0).

Return Value

bool|null|string Trueish/falsish.

at line 88
bool isAcquired()

Return Value

bool