Spec-Zone.ru › CakePHP 2.9

Класс CacheEngine

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

Прямые подклассы

  • ApcEngine
  • FileEngine
  • MemcachedEngine
  • MemcacheEngine
  • RedisEngine
  • WincacheEngine
  • XcacheEngine
Абстрактный
Пакет: Cake\Cache
Авторские права: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
Лицензия: MIT License
Расположение: Cake/Cache/CacheEngine.php

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

  • $_groupPrefix protected
    string

    Содержит скомпилированную строку со всеми префиксами групп, которые должны добавляться к каждому ключу в этом кэше

  • $settings public
    array
    Настройки текущего экземпляра двигателя

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

  • add() public
    Записывает значение для ключа в кэш, если он еще не существует
  • clear() abstract public
    Удаляет все ключи из кэша
  • clearGroup() public

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

  • decrement() abstract public
    Уменьшает число по ключу и возвращает уменьшенное значение
  • delete() abstract public
    Удаляет ключ из кэша
  • gc() public
    Сбор мусора
  • groups() public

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

  • increment() abstract public
    Увеличивает число по ключу и возвращает увеличенное значение
  • init() public
    Инициализирует кэш-движок
  • key() public
    Генерирует безопасный ключ для использования с хранилищами кэш-движков.
  • read() abstract public
    Считывает ключ из кэша
  • settings() public
    Настройки кэш-движка
  • write() abstract public
    Записывает значение для ключа в кэш

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

add()source public

add( string $key , mixed $value , integer $duration )

Записывает значение для ключа в кэш, если он еще не существует

Параметры

строка $key
Идентификатор данных
смешанный $value
Данные для кэширования
целое число $duration
Срок кэширования.

Возвращает

boolean
Истина, если данные были успешно кэшированы, ложь в случае ошибки

clear()source abstract public

clear( boolean $check )

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

Параметры

boolean $check
Если true, будет проверяться срок действия, в противном случае удаляются все

Возвращает

boolean
Истина, если кэш был успешно очищен, ложь в противном случае

clearGroup()source public

clearGroup( string $group )

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

Параметры

строка $group
Имя группы, подлежащей очистке

Возвращает

boolean

decrement()source abstract public

decrement( string $key , integer $offset 1 )

Уменьшает число по ключу и возвращает уменьшенное значение

Параметры

строка $key
Идентификатор данных
целое число $offset необязательно 1
На сколько уменьшить

Возвращает

Новое
уменьшенное значение, ложь в противном случае

delete()source abstract public

delete( string $key )

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

Параметры

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

Возвращает

boolean
Истина, если значение было успешно удалено, ложь, если его не существовало или не удалось удалить

gc()source public

gc( integer $expires null )

Сбор мусора

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

Параметры

целое число $expires необязательно null
[необязательно] Отметка времени истечения срока действия, аннулируя все данные до нее.

groups()source public

groups( )

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

Возвращает

array

increment()source abstract public

increment( string $key , integer $offset 1 )

Увеличивает число по ключу и возвращает увеличенное значение

Параметры

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

Возвращает

Новое
увеличенное значение, ложь в противном случае

init()source public

init( array $settings array() )

Инициализирует кэш-движок

Вызывается автоматически фронтендом кэша

Параметры

массив $settings необязательно array()
Ассоциативный массив параметров для двигателя

Возвращает

boolean
Истина, если движок был успешно инициализирован, ложь в противном случае

key()source public

key( string $key )

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

Параметры

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

Возвращает

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

read()source abstract public

read( string $key )

Считывает ключ из кэша

Параметры

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

Возвращает

смешанный
Кэшированные данные или ложь, если данных нет, истек срок действия или произошла ошибка при их извлечении

settings()source public

settings( )

Настройки кэш-движка

Возвращает

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

write()source abstract public

write( string $key , mixed $value , integer $duration )

Записать значение для ключа в кэш

Параметры

string $key
Идентификатор данных
mixed $value
Данные, которые необходимо кешировать
integer $duration
Срок хранения.

Возвращает

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

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

$_groupPrefixsource

protected string

Содержит скомпилированную строку со всеми префиксами групп, которые необходимо добавить к каждому ключу в этом движке кэша

null

$settingssource

public 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-CacheEngine.html

Spec-Zone.ru

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