Класс yii\caching\ZendDataCache
| Наследование | yii\caching\ZendDataCache » yii\caching\Cache » yii\base\Component » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable, yii\caching\CacheInterface |
| Доступна с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2/blob/master/framework/caching/ZendDataCache.php |
ZendDataCache предоставляет кэширование данных Zend в виде компонента приложения.
Для использования этого компонента приложения необходимо загрузить расширение Zend Data Cache PHP.
См. yii\caching\Cache для общих операций кэширования, которые поддерживает ZendDataCache.
Для получения более подробной информации и инструкций по использованию Cache, см. статью руководства по кэшированию.
Публичные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $behaviors | yii\base\Behavior[] | Список прикрепленных к этому компоненту поведений | yii\base\Component |
| $defaultDuration | integer | Значение по умолчанию для времени жизни записи кэша в секундах. | yii\caching\Cache |
| $keyPrefix | string | Строка-префикс для каждого ключа кэша, делающая его уникальным во всем хранилище кэша. | yii\caching\Cache |
| $serializer | null|array|false | Функции, используемые для сериализации и десериализации данных кэша. | yii\caching\Cache |
Публичные методы
| Метод | Описание | Определено в |
|---|---|---|
| __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 |
| add() | Сохраняет значение, идентифицируемое ключом, в кэше, если в кэше этот ключ отсутствует. | yii\caching\Cache |
| attachBehavior() | Присоединяет поведение к данному компоненту. | yii\base\Component |
| attachBehaviors() | Присоединяет список поведений к компоненту. | yii\base\Component |
| behaviors() | Возвращает список поведений, по которым данный компонент должен вести себя. | yii\base\Component |
| buildKey() | Создаёт нормализованный ключ кэша из данного ключа. | yii\caching\Cache |
| canGetProperty() | Возвращает значение, указывающее, может ли свойство быть прочитано. | yii\base\Object |
| canSetProperty() | Возвращает значение, указывающее, может ли свойство быть установлено. | yii\base\Object |
| className() | Возвращает полное квалифицированное имя данного класса. | yii\base\Object |
| delete() | Удаляет значение с указанным ключом из кэша. | yii\caching\Cache |
| detachBehavior() | Отсоединяет поведение от компонента. | yii\base\Component |
| detachBehaviors() | Отсоединяет все поведения от компонента. | yii\base\Component |
| ensureBehaviors() | Убеждается, что поведения, объявленные в behaviors(), присоединены к этому компоненту. | yii\base\Component |
| exists() | Проверяет, существует ли в кэше указанный ключ. | yii\caching\Cache |
| flush() | Удаляет все значения из кэша. | yii\caching\Cache |
| get() | Извлекает значение из кэша по указанному ключу. | yii\caching\Cache |
| getBehavior() | Возвращает объект именованного поведения. | yii\base\Component |
| getBehaviors() | Возвращает все присоединённые к этому компоненту поведения. | yii\base\Component |
| getOrSet() | Метод объединяет методы set() и get() для извлечения значения, идентифицируемого ключом $key, или для сохранения результата выполнения $callable, если для $key нет кэшированного значения. | yii\caching\Cache |
| hasEventHandlers() | Возвращает значение, указывающее, есть ли какой-либо обработчик, присоединённый к указанному событию. | yii\base\Component |
| hasMethod() | Возвращает значение, указывающее, определён ли метод. | yii\base\Object |
| hasProperty() | Возвращает значение, указывающее, определено ли свойство. | yii\base\Object |
| init() | Инициализирует объект. | yii\base\Object |
| madd() | Сохраняет несколько элементов в кэше. Каждый элемент содержит значение, идентифицируемое ключом. | yii\caching\Cache |
| mget() | Извлекает несколько значений из кэша по указанным ключам. | yii\caching\Cache |
| mset() | Сохраняет несколько элементов в кэше. Каждый элемент содержит значение, идентифицируемое ключом. | yii\caching\Cache |
| multiAdd() | Сохраняет несколько элементов в кэше. Каждый элемент содержит значение, идентифицируемое ключом. | yii\caching\Cache |
| multiGet() | Извлекает несколько значений из кэша по указанным ключам. | yii\caching\Cache |
| multiSet() | Сохраняет несколько элементов в кэше. Каждый элемент содержит значение, идентифицируемое ключом. | yii\caching\Cache |
| off() | Отсоединяет существующий обработчик событий от данного компонента. | yii\base\Component |
| offsetExists() | Возвращает, есть ли запись в кэше с указанным ключом. | yii\caching\Cache |
| offsetGet() | Извлекает значение из кэша по указанному ключу. | yii\caching\Cache |
| offsetSet() | Сохраняет значение, идентифицируемое ключом, в кэше. | yii\caching\Cache |
| offsetUnset() | Удаляет значение с указанным ключом из кэша. Этот метод требуется интерфейсом ArrayAccess. | yii\caching\Cache |
| on() | Присоединяет обработчик событий к событию. | yii\base\Component |
| set() | Сохраняет значение, идентифицируемое ключом, в кэше. | yii\caching\Cache |
| trigger() | Вызывает событие. | yii\base\Component |
Защищённые методы
| Метод | Описание | Определено в |
|---|---|---|
| addValue() | Сохраняет значение, идентифицируемое ключом, в кэше, если этот ключ в кэше отсутствует. | yii\caching\ZendDataCache |
| addValues() | Добавляет несколько пар ключ-значение в кэш. | yii\caching\Cache |
| deleteValue() | Удаляет значение с указанным ключом из кэша. Реализация метода, объявленного в родительском классе. | yii\caching\ZendDataCache |
| flushValues() | Удаляет все значения из кэша. | yii\caching\ZendDataCache |
| getValue() | Извлекает значение из кэша по указанному ключу. | yii\caching\ZendDataCache |
| getValues() | Извлекает несколько значений из кэша по указанным ключам. | yii\caching\Cache |
| setValue() | Сохраняет значение, идентифицируемое ключом, в кэше. | yii\caching\ZendDataCache |
| setValues() | Сохраняет несколько пар ключ-значение в кэше. | yii\caching\Cache |
Подробное описание методов
addValue() защищённый метод
Сохраняет значение, идентифицируемое ключом, в кэше, если этот ключ в кэше отсутствует.
Реализация метода, объявленного в родительском классе.
| защищённый boolean addValue ( $key, $value, $duration ) | ||
|---|---|---|
| $key | string |
Ключ, идентифицирующий сохраняемое значение. |
| $value | mixed |
Сохраняемое значение. Чаще всего это строка. Если отключен $serializer, это может быть что-то другое. |
| $duration | integer |
Количество секунд, в течение которых кэшированное значение будет действовать. 0 означает, что значение никогда не истекает. |
| return | boolean |
True, если значение успешно сохранено в кэше, false в противном случае. |
deleteValue() защищённый метод
Удаляет значение с указанным ключом из кэша. Реализация метода, объявленного в родительском классе.
| защищённый boolean deleteValue ( $key ) | ||
|---|---|---|
| $key | string |
Ключ удаляемого значения. |
| return | boolean |
true, если удаление прошло успешно, false в противном случае |
flushValues() защищённый метод
Удаляет все значения из кэша.
Реализация метода, объявленного в родительском классе.
| защищённый boolean flushValues ( ) | ||
|---|---|---|
| return | boolean |
Результат выполнения операции очистки. |
getValue() защищённый метод
Извлекает значение из кэша по указанному ключу.
Реализация метода, объявленного в родительском классе.
| защищённый mixed|false getValue ( $key ) | ||
|---|---|---|
| $key | string |
Уникальный ключ кэшированного значения. |
| return | mixed|false |
Значение, сохранённое в кэше, false, если значение отсутствует в кэше или истекло. |
setValue() защищённый метод
Сохраняет значение, идентифицируемое ключом, в кэше.
Реализация метода, объявленного в родительском классе.
| защищённый boolean setValue ( $key, $value, $duration ) | ||
|---|---|---|
| $key | string |
Ключ, идентифицирующий сохраняемое значение. |
| $value | mixed |
Сохраняемое значение. Чаще всего это строка. Если отключен $serializer, это может быть что-то другое. |
| $duration | integer |
Количество секунд, в течение которых кэшированное значение будет действовать. 0 означает, что значение никогда не истекает. |
| return | boolean |
True, если значение успешно сохранено в кэше, false в противном случае. |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-caching-zenddatacache.html
