Класс ApcEngine
Двигатель кэша APC для хранения кэшированных данных
- CacheEngine
-
ApcEngine
Авторские права: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
Лицензия: MIT License
Расположение: Cake/Cache/Engine/ApcEngine.php
Краткое описание свойств
-
$_apcExtensionprotectedРасширение APC или APCustring -
$_compiledGroupNamesprotectedarrayСодержит скомпилированные имена групп (с префиксом из глобальной конфигурации)
Унаследованные свойства
Краткое описание методов
- add() public
Записывает данные для ключа в кэш, если он ещё не существует. Если ключ уже существует, возвращает false.
- clear() publicУдаляет все ключи из кэша. Это очистит все конфигурации кэша, использующие APC.
- clearGroup() public
Увеличивает значение группы, чтобы симулировать удаление всех ключей в группе. Старые значения останутся в хранилище до истечения срока действия.
- decrement() publicУменьшает значение целого числового кэшированного ключа
- delete() publicУдаляет ключ из кэша
- groups() public
Возвращает
group valueдля каждой из настроенных групп. Если начальное значение группы не найдено, оно инициализируется соответствующим образом. - increment() publicУвеличивает значение целого числового кэшированного ключа
- init() publicИнициализация двигателя кэша
- read() publicЧтение ключа из кэша
- write() publicЗапись данных для ключа в кэш
Подробное описание методов
add()source public
add( string $key , mixed $value , integer $duration )
Записывает данные для ключа в кэш, если он ещё не существует. Если ключ уже существует, возвращает false.
Параметры
- строка
$key - Идентификатор данных.
- смешанное
$value - Данные, которые нужно кэшировать.
- целое число
$duration - Время хранения данных в секундах.
Возвращаемое значение
booleanTrue, если данные были успешно кэшированы, false в случае ошибки.
Ссылка
http://php.net/manual/en/function.apc-add.phpПереопределение
CacheEngine::add() clear()source public
clear( boolean $check )
Удаляет все ключи из кэша. Это очистит все конфигурации кэша, использующие APC.
Параметры
- boolean
$check Если true, ничего не будет удалено, так как записи удаляются из APC при истечении срока действия. Этот флаг используется только классом FileEngine.
Возвращаемое значение
booleanTrue.
clearGroup()source public
clearGroup( string $group )
Увеличивает значение группы, чтобы симулировать удаление всех ключей в группе. Старые значения останутся в хранилище до истечения срока действия.
Параметры
- строка
$group - Группа для очистки.
Возвращаемое значение
booleanуспех
Переопределение
CacheEngine::clearGroup() decrement()source public
decrement( string $key , integer $offset 1 )
Уменьшает значение целого числового кэшированного ключа
Параметры
- строка
$key - Идентификатор данных
- целое число
$offsetнеобязательный 1 - На сколько уменьшить
Возвращаемое значение
Новоеуменьшенное значение, false в противном случае
delete()source public
delete( string $key )
Удаляет ключ из кэша
Параметры
- строка
$key - Идентификатор данных
Возвращаемое значение
booleanTrue, если значение было удалено успешно, false, если значения не существовало или не удалось его удалить
groups()source public
groups( )
Возвращает group value для каждой из настроенных групп. Если начальное значение группы не найдено, оно инициализируется соответствующим образом.
Возвращаемое значение
массивПереопределение
CacheEngine::groups() increment()source public
increment( string $key , integer $offset 1 )
Увеличивает значение целого числового кэшированного ключа
Параметры
- строка
$key - Идентификатор данных
- целое число
$offsetнеобязательный 1 - На сколько увеличить
Возвращаемое значение
Новоеувеличенное значение, false в противном случае
init()source public
init( array $settings array() )
Инициализировать двигатель кэша
Вызывается автоматически фронтэндом кэша. Для повторной инициализации параметров вызовите Cache::engine('EngineName', [необязательный] settings = array());
Параметры
- массив
$settingsнеобязательный array() - массив параметров для двигателя
Возвращаемое значение
booleanTrue, если двигатель был успешно инициализирован, false в противном случае
См. также
CacheEngine::__defaultsПереопределение
CacheEngine::init() read()source public
read( string $key )
Чтение ключа из кэша
Параметры
- строка
$key - Идентификатор данных
Возвращаемое значение
смешанноеДанные из кэша или false, если данных нет, срок действия истек или произошла ошибка при получении данных
write()source public
write( string $key , mixed $value , integer $duration )
Запись данных для ключа в кэш
Параметры
- строка
$key - Идентификатор данных
- смешанное
$value - Данные, которые нужно кэшировать
- целое число
$duration - Время хранения данных в секундах
Возвращаемое значение
booleanTrue, если данные были успешно кэшированы, false в случае ошибки
Методы, унаследованные от CacheEngine
gc()source public
gc( integer $expires null )
Сбор мусора
Постоянно удаляет все устаревшие и удаленные данные
Параметры
- целое число
$expiresнеобязательный null - [необязательный] Маркер времени истечения срока действия, делая все данные, предшествующие ему, недействительными.
key()source public
key( string $key )
Генерирует безопасный ключ для использования с кэширующими движками хранилищ.
Параметры
- строка
$key - переданный ключ
Возвращаемое значение
смешанноестрока $key или false
Подробное описание свойств
$_compiledGroupNamessource
protected массив
Содержит скомпилированные имена групп (с префиксом глобальной конфигурации)
array()
© 2005–2016 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
http://api.cakephp.org/2.8/class-ApcEngine.html