Абстрактный класс yii\caching\Dependency
| Наследование | yii\caching\Dependency » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable |
| Подклассы | yii\caching\ChainedDependency, yii\caching\DbDependency, yii\caching\DbQueryDependency, yii\caching\ExpressionDependency, yii\caching\FileDependency, yii\caching\TagDependency |
| Доступна с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2/blob/master/framework/caching/Dependency.php |
Dependency — базовый класс для классов зависимостей кеша.
Подклассы должны переопределять generateDependencyData() для генерации фактических данных зависимости.
Дополнительную информацию и сведения об использовании кеша см. в статье руководства по кешированию.
Общедоступные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $data | mixed | Данные зависимости, которые сохраняются в кеше и впоследствии сравниваются с последними данными зависимости. | yii\caching\Dependency |
| $reusable | boolean | Указывает, является ли эта зависимость повторно используемой. | yii\caching\Dependency |
Общедоступные методы
| Метод | Описание | Определено в |
|---|---|---|
| __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\Dependency |
| generateReusableHash() | Генерирует уникальный хеш, который может быть использован для извлечения данных зависимостей, используемых повторно. | yii\caching\Dependency |
Подробное описание свойств
$data публичное свойство
Данные зависимости, которые сохраняются в кэше, а затем сравниваются с последними данными зависимости.
public mixed $data = null
$reusable публичное свойство
Является ли эта зависимость повторно используемой. Значение true означает, что данные зависимости для этого кэша будут генерироваться только один раз за запрос. Это позволяет использовать одну и ту же зависимость кэша для нескольких отдельных вызовов кэша во время генерации одной и той же страницы без накладных расходов на повторное вычисление данных зависимости каждый раз. По умолчанию false.
public boolean $reusable = false
Подробное описание методов
evaluateDependency() public method
Оценивает зависимость, генерируя и сохраняя данные, связанные с ней.
Этот метод вызывается кэшем перед записью данных в него.
| public void evaluateDependency ( $cache ) | ||
|---|---|---|
| $cache | yii\caching\CacheInterface |
Компонент кэша, который в данный момент оценивает эту зависимость |
generateDependencyData() protected abstract method
Генерирует данные, необходимые для определения изменения зависимости.
Производные классы должны переопределить этот метод, чтобы сгенерировать фактические данные зависимости.
| protected abstract mixed generateDependencyData ( $cache ) | ||
|---|---|---|
| $cache | yii\caching\CacheInterface |
Компонент кэша, который в данный момент оценивает эту зависимость |
| return | mixed |
Данные, необходимые для определения изменения зависимости. |
generateReusableHash() protected method
Генерирует уникальный хэш, который может использоваться для извлечения данных зависимости, используемых повторно.
См. также $reusable.
| protected string generateReusableHash ( ) | ||
|---|---|---|
| return | string |
Уникальное значение хэша для этой зависимости кэша. |
getHasChanged() public method
Устарело начиная с версии 2.0.11. Будет удалено в версии 2.1. Используйте isChanged() вместо этого.Возвращает значение, указывающее, изменилась ли зависимость.
| public void getHasChanged ( $cache ) | ||
|---|---|---|
| $cache | ||
isChanged() public method (доступно с версии 2.0.11)
Проверяет, изменилась ли зависимость
| public boolean isChanged ( $cache ) | ||
|---|---|---|
| $cache | yii\caching\CacheInterface |
Компонент кэша, который в данный момент оценивает эту зависимость |
| return | boolean |
Изменилась ли зависимость. |
resetReusableData() public static method
Сбрасывает все кэшированные данные для зависимостей, используемых повторно.
| public static void resetReusableData ( ) |
|---|
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-caching-dependency.html
