Spec-Zone.ru › CakePHP 2.7

Класс CacheEngine

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

Непосредственные известные подклассы

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

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

clearsource абстрактный public

clear( boolean $check )

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

Параметры

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

Возвращает

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

clearGroupsource public

clearGroup( string $group )

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

Параметры

string $group
название группы, которая должна быть очищена

Возвращает

boolean
bool

decrementsource абстрактный public

decrement( string $key , integer $offset 1 )

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

Параметры

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

Возвращает

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

deletesource абстрактный public

delete( string $key )

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

Параметры

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

Возвращает

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

gcsource public

gc( integer $expires null )

Сбор мусора

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

Параметры

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

groupssource public

groups( )

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

Возвращает

array
массив

incrementsource абстрактный public

increment( string $key , integer $offset 1 )

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

Параметры

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

Возвращает

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

initsource public

init( array $settings array() )

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

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

Параметры

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

Возвращает

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

keysource public

key( string $key )

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

Параметры

string $key
переданный ключ

Возвращает

mixed
строка $key или false

readsource абстрактный public

read( string $key )

Читает ключ из кэша

Параметры

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

Возвращает

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

settingssource public

settings( )

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

Возвращает

array
настройки

writesource абстрактный public

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

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

Параметры

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

Возвращает

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

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

$_groupPrefixsource

protected строка

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

null

$settingssource

public массив

Настройки текущего экземпляра движка

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

Spec-Zone.ru

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