Класс yii\caching\ApcCache
| Наследование | yii\caching\ApcCache » 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/ApcCache.php |
ApcCache предоставляет кэширование APC в виде компонента приложения.
Для использования этого компонента приложения необходимо загрузить расширение APC PHP. В качестве альтернативы можно использовать расширение APCu PHP, установив useApcu в true. Чтобы включить APC или APCu для командной строки, добавьте «apc.enable_cli = 1» в ваш файл php.ini.
Общие операции кэширования, которые поддерживает ApcCache, см. в yii\caching\Cache.
Дополнительную информацию и сведения об использовании 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 |
| $useApcu | boolean | Использовать apcu или apc в качестве основного расширения кэширования. | yii\caching\ApcCache |
Общедоступные методы
| Метод | Описание | Определено в |
|---|---|---|
| __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\ApcCache |
| 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\caching\ApcCache |
| 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\ApcCache |
| addValues() | Добавляет несколько пар ключ-значение в кэш. | yii\caching\ApcCache |
| deleteValue() | Удаляет значение с указанным ключом из кэша. Это реализация метода, объявленного в родительском классе. | yii\caching\ApcCache |
| flushValues() | Удаляет все значения из кэша. | yii\caching\ApcCache |
| getValue() | Извлекает значение из кэша по заданному ключу. | yii\caching\ApcCache |
| getValues() | Извлекает несколько значений из кэша по заданным ключам. | yii\caching\ApcCache |
| setValue() | Хранит значение, идентифицируемое ключом, в кэше. | yii\caching\ApcCache |
| setValues() | Хранит несколько пар ключ-значение в кэше. | yii\caching\ApcCache |
Подробное описание свойств
$useApcu общедоступное свойство (доступно начиная с версии 2.0.7)
Определяет, использовать ли apcu или apc в качестве базового расширения кэширования. Если значение true, будет использоваться apcu. Если false, будет использоваться apc. По умолчанию значение false.
public boolean $useApcu = false
Подробное описание методов
addValue() защищённый метод
Сохраняет значение, идентифицируемое ключом, в кэше, если в кэше этот ключ отсутствует.
Это реализация метода, объявленного в родительском классе.
| защищённый boolean addValue ( $key, $value, $duration ) | ||
|---|---|---|
| $key | string |
Ключ, идентифицирующий значение для кэширования |
| $value | mixed |
Значение для кэширования. Чаще всего это строка. Если вы отключили $serializer, это может быть что-то другое. |
| $duration | integer |
Количество секунд, в течение которого кэшированное значение будет действовать. 0 означает, что срок действия не ограничен. |
| return | boolean |
True, если значение успешно сохранено в кэше, иначе false |
addValues() защищённый метод
Добавляет несколько пар ключ-значение в кэш.
| защищённый array addValues ( $data, $duration ) | ||
|---|---|---|
| $data | array |
Массив, где ключ соответствует ключу кэша, а значение — хранимому значению |
| $duration | integer |
Количество секунд, в течение которого кэшированные значения будут действовать. 0 означает, что срок действия не ограничен. |
| return | array |
Массив неудачных ключей |
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, если значение отсутствует в кэше или истекло. |
getValues() защищённый метод
Извлекает несколько значений из кэша по указанным ключам.
| защищённый array getValues ( $keys ) | ||
|---|---|---|
| $keys | array |
Список ключей, идентифицирующих кэшированные значения |
| return | array |
Список кэшированных значений, индексированных по ключам |
init() публичный метод
Инициализирует компонент приложения.
Проверяет, загружен ли необходимый расширение.
| публичный void init ( ) |
|---|
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-apccache.html
