Класс yii\caching\WinCache
| Наследование | yii\caching\WinCache » 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/WinCache.php |
WinCache предоставляет кеширование Windows Cache в виде компонента приложения.
Для использования этого компонента приложения необходимо загрузить расширение WinCache PHP. Также обратите внимание, что в файле php.ini значение "wincache.ucenabled" должно быть установлено в "On".
См. руководство по yii\caching\Cache для общих операций кеширования, поддерживаемых WinCache.
Для более подробной информации и использования 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\WinCache |
| 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\WinCache |
| addValues() | Добавляет несколько пар ключ-значение в кэш. | yii\caching\WinCache |
| deleteValue() | Удаляет значение с указанным ключом из кэша. Это реализация метода, объявленного в родительском классе. | yii\caching\WinCache |
| flushValues() | Удаляет все значения из кэша. | yii\caching\WinCache |
| getValue() | Извлекает значение из кэша по указанному ключу. | yii\caching\WinCache |
| getValues() | Извлекает несколько значений из кэша по указанным ключам. | yii\caching\WinCache |
| setValue() | Сохраняет значение, идентифицируемое ключом, в кэш. | yii\caching\WinCache |
| setValues() | Сохраняет несколько пар ключ-значение в кэш. | yii\caching\WinCache |
Подробное описание методов
addValue() защищенный метод
Сохраняет значение, идентифицируемое ключом, в кэш, если этот ключ в кэше отсутствует.
Это реализация метода, объявленного в родительском классе.
| защищенный boolean addValue ( $key, $value, $duration ) | ||
|---|---|---|
| $key | string |
Ключ, идентифицирующий кешируемое значение |
| $value | mixed |
Кешируемое значение. Чаще всего это строка. Если $serializer отключен, это может быть что-то другое. |
| $duration | integer |
Количество секунд, в течение которых кешируемое значение будет действовать. 0 означает, что срок действия не ограничен. |
| return | boolean |
True, если значение успешно сохранено в кэш, иначе false |
addValues() защищенный метод
Добавляет несколько пар ключ-значение в кэш.
По умолчанию этот метод вызывает addValue() несколько раз, добавляя значения по одному. Если хранилище кэша поддерживает многократную добавку, этот метод следует переопределить, чтобы использовать эту возможность.
| защищенный array addValues ( $data, $duration ) | ||
|---|---|---|
| $data | array |
Массив, где ключ соответствует ключу кэша, а значение — хранимому значению |
| $duration | integer |
Количество секунд, в течение которых кешируемые значения будут действовать. 0 означает, что срок действия не ограничен. |
| return | array |
Массив неудачно добавленных ключей |
deleteValue() защищенный метод
Удаляет значение с указанным ключом из кэша. Это реализация метода, объявленного в родительском классе.
| защищенный boolean deleteValue ( $key ) | ||
|---|---|---|
| $key | string |
Ключ удаляемого значения |
| return | boolean |
Если удаление произошло без ошибок |
exists() публичный метод
Проверяет, существует ли указанный ключ в кэше.
Это может быть быстрее, чем получение значения из кэша, если данные большие. Обратите внимание, что этот метод не проверяет, изменилась ли зависимость, связанная с кешируемыми данными (если она есть). Таким образом, вызов get() может вернуть false, в то время как exists вернёт true.
| публичный boolean exists ( $key ) | ||
|---|---|---|
| $key | mixed |
Ключ, идентифицирующий кешируемое значение. Может быть простой строкой или сложной структурой данных, состоящей из факторов, определяющих ключ. |
| return | boolean |
True, если значение существует в кэше, иначе false, если значение отсутствует в кэше или устарело. |
flushValues() защищенный метод
Удаляет все значения из кэша.
Это реализация метода, объявленного в родительском классе.
| защищенный boolean flushValues ( ) | ||
|---|---|---|
| return | boolean |
Успешность операции сброса. |
getValue() защищенный метод
Извлекает значение из кэша по указанному ключу.
Это реализация метода, объявленного в родительском классе.
| защищенный string|boolean getValue ( $key ) | ||
|---|---|---|
| $key | string |
Уникальный ключ, идентифицирующий кешируемое значение |
| return | string|boolean |
Значение, хранящееся в кэше, либо false, если значение отсутствует в кэше или устарело. |
getValues() защищенный метод
Извлекает несколько значений из кэша по указанным ключам.
| защищенный array getValues ( $keys ) | ||
|---|---|---|
| $keys | array |
Список ключей, идентифицирующих кешируемые значения |
| return | array |
Список кешированных значений, индексированных по ключам |
setValue() защищенный метод
Сохраняет значение, идентифицируемое ключом, в кэш.
Это реализация метода, объявленного в родительском классе.
| защищенный boolean setValue ( $key, $value, $duration ) | ||
|---|---|---|
| $key | string |
Ключ, идентифицирующий кешируемое значение |
| $value | mixed |
Кешируемое значение. Чаще всего это строка. Если $serializer отключен, это может быть что-то другое. |
| $duration | integer |
Количество секунд, в течение которых кешируемое значение будет действовать. 0 означает, что срок действия не ограничен. |
| return | boolean |
True, если значение успешно сохранено в кэш, иначе false |
setValues() защищенный метод
Сохраняет несколько пар ключ-значение в кэш.
| защищенный array setValues ( $data, $duration ) | ||
|---|---|---|
| $data | array |
Массив, где ключ соответствует ключу кэша, а значение — хранимому значению |
| $duration | integer |
Количество секунд, в течение которых кешируемые значения будут действовать. 0 означает, что срок действия не ограничен. |
| return | array |
Массив неудачно добавленных ключей |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-caching-wincache.html
