Spec-Zone.ru › CakePHP 2.9

Класс ApcEngine

Двигатель кэша APC для хранения

CacheEngine
Extended by ApcEngine
Пакет: Cake\Cache\Engine
Авторские права: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
Лицензия: MIT License
Расположение: Cake/Cache/Engine/ApcEngine.php

Краткое описание свойств

  • $_apcExtension protected
    string
    Расширение APC или APCu
  • $_compiledGroupNames protected
    array

    Содержит скомпилированные имена групп (с префиксом глобального префикса конфигурации)

Унаследованные свойства

  • _groupPrefix, settings

Краткое описание методов

  • 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
Время кэширования данных в секундах.

Возвращает

логическое
True, если данные были успешно кэшированы, false в случае ошибки.

Ссылка

http://php.net/manual/en/function.apc-add.php

Переопределяет

CacheEngine::add()

clear()source public

clear( boolean $check )

Удаляет все ключи из кэша. Это очистит каждую конфигурацию кэша, использующую APC.

Параметры

логическое $check

Если true, ничего не будет очищено, так как записи удаляются из APC по истечении срока действия. Этот флаг используется только FileEngine.

Возвращает

логическое
Возвращает true.

clearGroup()source public

clearGroup( string $group )

Увеличивает значение группы, чтобы имитировать удаление всех ключей в группе. Старые значения останутся в хранилище до тех пор, пока не истечет срок их действия.

Параметры

строка $group
Группа для очистки.

Возвращает

логическое
Успех

Переопределяет

CacheEngine::clearGroup()

decrement()source public

decrement( string $key , integer $offset 1 )

Уменьшает значение целочисленного кэшированного ключа

Параметры

строка $key
Идентификатор данных
целое число $offset optional 1
Сколько вычесть

Возвращает

Новое
значение после уменьшения, иначе false

delete()source public

delete( string $key )

Удаляет ключ из кэша

Параметры

строка $key
Идентификатор данных

Возвращает

логическое
True, если значение было успешно удалено, false, если его не существовало или не удалось удалить

groups()source public

groups( )

Возвращает group value для каждой из настроенных групп. Если начальное значение группы не найдено, то группа инициализируется соответствующим образом.

Возвращает

массив

Переопределяет

CacheEngine::groups()

increment()source public

increment( string $key , integer $offset 1 )

Увеличивает значение целочисленного кэшированного ключа

Параметры

строка $key
Идентификатор данных
целое число $offset optional 1
На сколько увеличить

Возвращает

Новое
значение после увеличения, иначе false

init()source public

init( array $settings array() )

Инициализирует двигатель кэша

Вызывается автоматически интерфейсом кэша. Для повторной инициализации параметров вызовите Cache::engine('EngineName', [опциональные] параметры = массив());

Параметры

массив $settings optional array()
Массив настроек для двигателя

Возвращает

логическое
True, если двигатель был успешно инициализирован, иначе 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
Время кэширования данных в секундах

Возвращает

логическое
True, если данные были успешно кэшированы, иначе false

Наследованные методы из CacheEngine

gc()source public

gc( integer $expires null )

Сбор мусора

Постоянно удаляет все устаревшие и удаленные данные

Параметры

целое число $expires optional null
[опционально] отметка времени истечения срока действия, делающая все данные, предшествующие ей, недействительными.

key()source public

key( string $key )

Генерирует безопасный ключ для использования с кэширующими движками хранения.

Параметры

строка $key
переданный ключ

Возвращает

смешанный
строка $key или false

settings()source public

settings( )

Настройки двигателя кэша

Возвращает

массив
настройки

Подробное описание свойств

$_apcExtensionsource

protected string

Расширение APC или APCu

'apc'

$_compiledGroupNamessource

protected array

Содержит скомпилированные имена групп (с префиксом из глобальной конфигурации)

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.
https://api.cakephp.org/2.9/class-ApcEngine.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API