Abstract Class yii\mutex\DbMutex

Inheritanceyii\mutex\DbMutex » yii\mutex\Mutex » yii\base\Component » yii\base\Object
Implementsyii\base\Configurable
Subclassesyii\mutex\MysqlMutex, yii\mutex\OracleMutex, yii\mutex\PgsqlMutex
Available since version2.0
Source Code https://github.com/yiisoft/yii2/blob/master/framework/mutex/DbMutex.php

DbMutex is the base class for classes, which relies on database while implementing mutex "lock" mechanism.

See also yii\mutex\Mutex.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$autoRelease boolean Whether all locks acquired in this process (i.e. local locks) must be released automatically before finishing script execution. yii\mutex\Mutex
$behaviors yii\base\Behavior[] List of behaviors attached to this component yii\base\Component
$db yii\db\Connection|array|string The DB connection object or the application component ID of the DB connection. yii\mutex\DbMutex

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__call() Calls the named method which is not a class method. yii\base\Object
__clone() This method is called after the object is created by cloning an existing one. yii\base\Component
__construct() Constructor. yii\base\Object
__get() Returns the value of an object property. yii\base\Object
__isset() Checks if a property is set, i.e. defined and not null. yii\base\Object
__set() Sets value of an object property. yii\base\Object
__unset() Sets an object property to null. yii\base\Object
acquire() Acquires a lock by name. yii\mutex\Mutex
attachBehavior() Attaches a behavior to this component. yii\base\Component
attachBehaviors() Attaches a list of behaviors to the component. yii\base\Component
behaviors() Returns a list of behaviors that this component should behave as. yii\base\Component
canGetProperty() Returns a value indicating whether a property can be read. yii\base\Object
canSetProperty() Returns a value indicating whether a property can be set. yii\base\Object
className() Returns the fully qualified name of this class. yii\base\Object
detachBehavior() Detaches a behavior from the component. yii\base\Component
detachBehaviors() Detaches all behaviors from the component. yii\base\Component
ensureBehaviors() Makes sure that the behaviors declared in behaviors() are attached to this component. yii\base\Component
getBehavior() Returns the named behavior object. yii\base\Component
getBehaviors() Returns all behaviors attached to this component. yii\base\Component
hasEventHandlers() Returns a value indicating whether there is any handler attached to the named event. yii\base\Component
hasMethod() Returns a value indicating whether a method is defined. yii\base\Object
hasProperty() Returns a value indicating whether a property is defined. yii\base\Object
init() Initializes generic database table based mutex implementation. yii\mutex\DbMutex
off() Detaches an existing event handler from this component. yii\base\Component
on() Attaches an event handler to an event. yii\base\Component
release() Releases acquired lock. This method will return false in case the lock was not found. yii\mutex\Mutex
trigger() Triggers an event. yii\base\Component

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
acquireLock() This method should be extended by a concrete Mutex implementations. Acquires lock by name. yii\mutex\Mutex
releaseLock() This method should be extended by a concrete Mutex implementations. Releases lock by given name. yii\mutex\Mutex

Property Details

$db public property

The DB connection object or the application component ID of the DB connection. After the Mutex object is created, if you want to change this property, you should only assign it with a DB connection object. Starting from version 2.0.2, this can also be a configuration array for creating the object.

Method Details

init() public method

Initializes generic database table based mutex implementation.

public void init ( )
throws yii\base\InvalidConfigException

if $db is invalid.