Класс yii\caching\XCache
| Наследование | yii\caching\XCache » 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/XCache.php |
XCache предоставляет кэширование XCache в виде компонента приложения.
Для использования этого компонента приложения необходимо загрузить расширение PHP XCache. Также обратите внимание, что функция flush() будет работать корректно только в том случае, если в php.ini параметр "xcache.admin.enable_auth" установлен в "Off".
См. yii\caching\Cache для общих операций кэширования, поддерживаемых XCache.
Для получения более подробной информации и использования 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\XCache |
| 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\XCache |
| addValues() | Добавляет несколько пар ключ-значение в кэш. | yii\caching\Cache |
| deleteValue() | Удаляет значение с указанным ключом из кэша. Реализация метода, объявленного в родительском классе. | yii\caching\XCache |
| flushValues() | Удаляет все значения из кэша. | yii\caching\XCache |
| getValue() | Извлекает значение из кэша по указанному ключу. | yii\caching\XCache |
| getValues() | Извлекает несколько значений из кэша по указанным ключам. | yii\caching\Cache |
| setValue() | Сохраняет значение, идентифицируемое ключом, в кэше. | yii\caching\XCache |
| 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, если удаление прошло успешно |
exists() публичный метод
Проверяет, существует ли указанный ключ в кэше.
Это может быть быстрее, чем получение значения из кэша, если данные большие. Обратите внимание, что этот метод не проверяет, изменились ли зависимые данные, связанные с кэшируемыми данными. Таким образом, вызов get() может вернуть false, в то время как exists вернёт true.
| публичный boolean exists ( $key ) | ||
|---|---|---|
| $key | mixed |
Ключ, идентифицирующий кэшируемое значение. Может быть простой строкой или сложной структурой данных, состоящей из компонентов ключа. |
| 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-xcache.html
