Абстрактный класс yii\mutex\DbMutex
| Наследование | yii\mutex\DbMutex » yii\mutex\Mutex » yii\base\Component » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable |
| Подклассы | yii\mutex\MysqlMutex, yii\mutex\OracleMutex, yii\mutex\PgsqlMutex |
| Доступно с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2/blob/master/framework/mutex/DbMutex.php |
DbMutex — базовый класс для классов, которые используют базу данных для реализации механизма блокировки «mutex».
См. также yii\mutex\Mutex.
Публичные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $autoRelease | boolean | Указывает, должны ли все блокировки, полученные в этом процессе (т. е. локальные блокировки), автоматически освобождаться перед завершением выполнения сценария. | yii\mutex\Mutex |
| $behaviors | yii\base\Behavior[] | Список поведений, прикрепленных к этому компоненту | yii\base\Component |
| $db | yii\db\Connection|array|string | Объект подключения к БД или идентификатор приложения компонента подключения к БД. | yii\mutex\DbMutex |
Публичные методы
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает метод с заданным именем, который не является методом класса. | yii\base\Object |
| __clone() | Этот метод вызывается после создания объекта путем клонирования существующего. | yii\base\Component |
| __construct() | Конструктор. | yii\base\Object |
| __get() | Возвращает значение свойства объекта. | yii\base\Object |
| __isset() | Проверяет, установлено ли свойство, т. е. определено и не равно null. | yii\base\Object |
| __set() | Устанавливает значение свойства объекта. | yii\base\Object |
| __unset() | Устанавливает свойство объекта в null. | yii\base\Object |
| acquire() | Получает блокировку по имени. | yii\mutex\Mutex |
| attachBehavior() | Присоединяет поведение к этому компоненту. | yii\base\Component |
| attachBehaviors() | Присоединяет список поведений к компоненту. | yii\base\Component |
| behaviors() | Возвращает список поведений, которые должен использовать этот компонент. | yii\base\Component |
| canGetProperty() | Возвращает значение, указывающее, можно ли прочитать свойство. | yii\base\Object |
| canSetProperty() | Возвращает значение, указывающее, можно ли установить свойство. | yii\base\Object |
| className() | Возвращает полное квалифицированное имя этого класса. | yii\base\Object |
| detachBehavior() | Отсоединяет поведение от компонента. | yii\base\Component |
| detachBehaviors() | Отсоединяет все поведения от компонента. | yii\base\Component |
| ensureBehaviors() | Убеждается, что поведения, объявленные в behaviors(), прикреплены к этому компоненту. | yii\base\Component |
| getBehavior() | Возвращает объект поведения с заданным именем. | yii\base\Component |
| getBehaviors() | Возвращает все прикрепленные к этому компоненту поведения. | yii\base\Component |
| hasEventHandlers() | Возвращает значение, указывающее, есть ли обработчик, прикрепленный к указанному событию. | yii\base\Component |
| hasMethod() | Возвращает значение, указывающее, определен ли метод. | yii\base\Object |
| hasProperty() | Возвращает значение, указывающее, определено ли свойство. | yii\base\Object |
| init() | Инициализирует реализацию механизма блокировки mutex на основе таблицы базы данных. | yii\mutex\DbMutex |
| off() | Отсоединяет существующий обработчик событий от этого компонента. | yii\base\Component |
| on() | Присоединяет обработчик событий к событию. | yii\base\Component |
| release() | Освобождает полученную блокировку. Этот метод вернет false в случае, если блокировка не найдена. | yii\mutex\Mutex |
| trigger() | Срабатывает событие. | yii\base\Component |
Защищенные методы
| Метод | Описание | Определено в |
|---|---|---|
| acquireLock() | Этот метод должен быть расширен реализациями конкретного Mutex. Получает блокировку по имени. | yii\mutex\Mutex |
| releaseLock() | Этот метод должен быть расширен реализациями конкретного Mutex. Освобождает блокировку по заданному имени. | yii\mutex\Mutex |
Подробное описание свойств
$db публичное свойство
Объект подключения к БД или идентификатор приложения компонента подключения к БД. После создания объекта Mutex, если вы хотите изменить это свойство, вы должны назначить его только объектом подключения к БД. Начиная с версии 2.0.2, это также может быть массив конфигурации для создания объекта.
public yii\db\Connection|array|string $db = 'db'
Подробное описание методов
init() публичный метод
Инициализирует реализацию механизма блокировки mutex на основе таблицы базы данных.
| public void init ( ) | ||
|---|---|---|
| throws | yii\base\InvalidConfigException |
если $db некорректен. |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-mutex-dbmutex.html
