Spec-Zone.ru › CakePHP 2.7

Класс XcacheEngine

Движок кэширования Xcache для кэша

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

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

_authисходный код protected

_auth( boolean $reverse false )

Заполняет и инвертирует значения аутентификации $_SERVER. Вносит необходимые изменения (и отменяет их) в $_SERVER.

Это необходимо, так как xcache_clear_cache() должен передавать Basic Http Auth (см. настройки конфигурации xcache.admin).

Параметры

boolean $reverse необязательно false
Вернуть изменения

clearисходный код public

clear( boolean $check )

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

Параметры

boolean $check
Если true, удаления не будут выполняться, а CakePHP будет полагаться на значения TTL ключей.

Возвращает

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

clearGroupисходный код public

clearGroup( string $group )

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

Параметры

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

Возвращает

boolean
Успех

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

CacheEngine::clearGroup()

decrementисходный код public

decrement( string $key , integer $offset 1 )

Уменьшает значение целочисленного кэшированного ключа. Если ключ кэша не является целым числом, он будет обработан как 0.

Параметры

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

Возвращает

New
Уменьшенное значение, иначе false

deleteисходный код public

delete( string $key )

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

Параметры

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

Возвращает

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

groupsисходный код public

groups( )

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

Возвращает

array
массив

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

CacheEngine::groups()

incrementисходный код public

increment( string $key , integer $offset 1 )

Увеличивает значение целочисленного кэшированного ключа. Если ключ кэша не является целым числом, он будет обработан как 0.

Параметры

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

Возвращает

New
Увеличенное значение, иначе false

initисходный код public

init( array $settings array() )

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

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

Параметры

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

Возвращает

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

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

CacheEngine::init()

readисходный код public

read( string $key )

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

Параметры

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

Возвращает

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

writeисходный код public

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

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

Параметры

string $key
Идентификатор данных
mixed $value
Данные для кэширования
integer $duration
Время кэширования данных, в секундах

Возвращает

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

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

gcисходный код public

gc( integer $expires null )

Сбор мусора

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

Параметры

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

keyисходный код public

key( string $key )

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

Параметры

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

Возвращает

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

settingsисходный код public

settings( )

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

Возвращает

array
настройки

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

$settingsисходный код

public массив

Настройки

  • PHP_AUTH_USER = xcache.admin.user, по умолчанию cake - PHP_AUTH_PW = xcache.admin.password, по умолчанию cake
array()

Наследованные свойства от CacheEngine

$_groupPrefixисходный код

protected строка

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

null

© 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-XcacheEngine.html

Spec-Zone.ru

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