Spec-Zone.ru › CakePHP 2.10

Класс CacheEngine

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

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

  • ApcEngine
  • FileEngine
  • MemcachedEngine
  • MemcacheEngine
  • RedisEngine
  • WincacheEngine
  • XcacheEngine
Абстрактный
Пакет: Cake\Cache
Авторские права: Copyright (c) Cake Software Foundation, Inc. (https://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
True, если данные успешно кэшированы, false в случае ошибки

clear()source abstract public

clear( boolean $check )

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

Параметры

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

Возвращает

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

clearGroup()source public

clearGroup( string $group )

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

Параметры

строка $group
название группы, подлежащей очистке

Возвращает

boolean

decrement()source abstract public

decrement( string $key , integer $offset 1 )

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

Параметры

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

Возвращает

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

delete()source abstract public

delete( string $key )

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

Параметры

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

Возвращает

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

gc()source public

gc( integer $expires null )

Сбор мусора

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

Параметры

целое число $expires optional null
[необязательно] Маркер времени истечения срока действия, делающий недействительными все данные до этого момента.

groups()source public

groups( )

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

Возвращает

массив

increment()source abstract public

increment( string $key , integer $offset 1 )

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

Параметры

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

Возвращает

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

init()source public

init( array $settings array() )

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

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

Параметры

массив $settings optional array()
Ассоциативный массив параметров для движка

Возвращает

boolean
True, если движок успешно инициализирован, false в противном случае

key()source public

key( string $key )

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

Параметры

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

Возвращает

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

read()source abstract public

read( string $key )

Прочитать ключ из кэша

Параметры

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

Возвращает

смешанное
Кэшированные данные или false, если данные не существуют, истекли или произошла ошибка при их извлечении

settings()source public

settings( )

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

Возвращает

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

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–2017 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.10/class-CacheEngine.html

Spec-Zone.ru

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