Класс yii\caching\DbDependency
| Наследование | yii\caching\DbDependency » yii\caching\Dependency » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable |
| Доступна с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2/blob/master/framework/caching/DbDependency.php |
DbDependency представляет зависимость, основанную на результатах запроса SQL-запроса.
Если результат запроса изменяется, зависимость считается изменённой. Запрос задаётся свойством $sql.
Дополнительную информацию и инструкции по использованию кеша можно найти в статье руководства по кешированию.
Публичные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $data | смешанный | Данные зависимости, сохраняемые в кеше и сравниваемые с последними данными зависимости. | yii\caching\Dependency |
| $db | строка | Идентификатор компонента приложения для подключения к БД. | yii\caching\DbDependency |
| $params | массив | Параметры (имя => значение), которые привязываются к SQL-запросу, указанному в $sql. | yii\caching\DbDependency |
| $reusable | логическое | Является ли эта зависимость повторно используемой. | yii\caching\Dependency |
| $sql | строка | SQL-запрос, результат которого используется для определения изменения зависимости. | yii\caching\DbDependency |
Публичные методы
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает именованный метод, который не является методом класса. | yii\base\Object |
| __construct() | Конструктор. | yii\base\Object |
| __get() | Возвращает значение свойства объекта. | yii\base\Object |
| __isset() | Проверяет, установлено ли свойство, т.е. определено и не равно null. | yii\base\Object |
| __set() | Устанавливает значение свойства объекта. | yii\base\Object |
| __unset() | Устанавливает свойство объекта в null. | yii\base\Object |
| canGetProperty() | Возвращает значение, указывающее, можно ли считать свойство. | yii\base\Object |
| canSetProperty() | Возвращает значение, указывающее, можно ли установить свойство. | yii\base\Object |
| className() | Возвращает полное квалифицированное имя этого класса. | yii\base\Object |
| evaluateDependency() | Оценивает зависимость, генерируя и сохраняя данные, связанные с зависимостью. | yii\caching\Dependency |
| getHasChanged() | Возвращает значение, указывающее, изменилась ли зависимость. | yii\caching\Dependency |
| hasMethod() | Возвращает значение, указывающее, определен ли метод. | yii\base\Object |
| hasProperty() | Возвращает значение, указывающее, определено ли свойство. | yii\base\Object |
| init() | Инициализирует объект. | yii\base\Object |
| isChanged() | Проверяет, изменилась ли зависимость | yii\caching\Dependency |
| resetReusableData() | Сбрасывает все кэшированные данные для повторно используемых зависимостей. | yii\caching\Dependency |
Защищённые методы
| Метод | Описание | Определено в |
|---|---|---|
| generateDependencyData() | Генерирует данные, необходимые для определения, изменилась ли зависимость. | yii\caching\DbDependency |
| generateReusableHash() | Генерирует уникальный хеш, который можно использовать для получения данных повторно используемой зависимости. | yii\caching\Dependency |
Подробное описание свойств
$db public свойство
Идентификатор компонента приложения для подключения к базе данных.
public string $db = 'db'
$params public свойство
Параметры (имя => значение), которые должны быть привязаны к SQL-запросу, указанному в $sql.
public array $params = []
$sql public свойство
SQL-запрос, результат которого используется для определения, изменилась ли зависимость. Будет использована только первая строка результата запроса.
public string $sql = null
Подробное описание методов
generateDependencyData() защищённый метод
Генерирует данные, необходимые для определения, была ли зависимость изменена.
Этот метод возвращает значение глобального состояния.
| защищённый смешанный generateDependencyData ( $cache ) | ||
|---|---|---|
| $cache | yii\caching\CacheInterface |
Компонент кэша, который в настоящее время оценивает эту зависимость |
| return | смешанный |
Данные, необходимые для определения, была ли зависимость изменена. |
| 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-caching-dbdependency.html
