PrefixedMutexTrait

Type
Trait
Namespace
craft\mutex
Since
3.6.0
Deprecated in
in 3.7.15. [[MutexTrait]] should be used instead.

View source (opens new window)

# Public Properties

Property Description
namePrefix string (opens new window) – A string prefixed to every lock name.

# namePrefix

Type
string (opens new window)
Default value
''

A string prefixed to every lock name. This can be used to avoid lock conflicts if multiple applications are sharing the same database connection.

View source (opens new window)

# Public Methods

Method Description
acquire()
isAcquired()
release()

# acquire()

View source (opens new window)

Arguments

Returns

boolean (opens new window)

# isAcquired()

View source (opens new window)

Arguments

Returns

boolean (opens new window)

# release()

View source (opens new window)

Arguments

Returns

boolean (opens new window)