Storage

Описание

Класс Storage - предназначен для кэширования блоков данных (объектов, массивов, строк), используемых для генерации страницы. Позволяет работать с сервером memcache.

Методы со знаком * содержат хуки

Методы класса

obj	getInstance()	Возвращает единственный экземпляр данного класса. `$obj = Storage::getInstance();`
string	checkValue() *	Хук для изменения сохраняемых в кэш значений
bool	save()	Сохраняет данные в формате ключ-значение. `$array = array('сложный', 'массив', 'для', 'записи', 'в', 'кэш'); $res = Storage::save('cacheName', $array); var_dump($res);`
mixed	get()	Возвращает сохраненный ранее объект из кэша. `$res = Storage::get('cacheName'); viewData($res);`
bool	clear()	Очищает кэш для всех или определенного объекта. `// чистит от указанный кэш $res = Storage::clear('cacheName'); var_dump($res); // чистит весь кэш $res = Storage::clear(); var_dump($res);`
int	getSessionLifeTime()	Возвращает продолжительность сессии. `echo Storage::getSessionLifeTime();`
bool	saveSystem()	Сохраняет данные в формате ключ-значение в системной директории. `$array = array('сложный', 'массив', 'для', 'записи', 'в', 'кэш'); $res = Storage::saveSystem('cacheName', $array); var_dump($res);`
mixed	getSystem()	Возвращает сохраненный ранее объект из системного кэша. `$res = Storage::getSystem('cacheName'); viewData($res);`
bool	clearSystem()	Очищает системный кэш для всех или определенного объекта. `// чистит от указанный кэш $res = Storage::clearSystem('cacheName'); var_dump($res); // чистит весь кэш $res = Storage::clearSystem(); var_dump($res);`

Описание методов и примеры их использования

Метод


obj getInstance ($settings)

Описание

Возвращает единственный экземпляр данного класса.


$obj = Storage::getInstance();

Метод


string checkValue (string $name, string $value)

Параметры

$name: ключ
$value: значение

Результат работы метода можно изменить хуком: Storage_checkValue

Описание

Хук для изменения сохраняемых в кэш значений

Метод


bool save (string $name, array|string $value, $lifetime)

Параметры

$name: ключ
$value: значение

Описание

Сохраняет данные в формате ключ-значение.


$array = array('сложный', 'массив', 'для', 'записи', 'в', 'кэш');
$res = Storage::save('cacheName', $array);
var_dump($res);

Метод


mixed get (string $name)

Параметры

$name: ключ.

Описание

Возвращает сохраненный ранее объект из кэша.


$res = Storage::get('cacheName');
viewData($res);

Метод


bool clear (string $object)

Параметры

$object: ключ объекта

Описание

Очищает кэш для всех или определенного объекта.


// чистит от указанный кэш
$res = Storage::clear('cacheName');
var_dump($res);
// чистит весь кэш
$res = Storage::clear();
var_dump($res);

Метод


int getSessionLifeTime ()

Описание

Возвращает продолжительность сессии.


echo Storage::getSessionLifeTime();

Метод


bool saveSystem (string $name, array|string $value, $lifetime)

Параметры

$name: ключ
$value: значение

Описание

Сохраняет данные в формате ключ-значение в системной директории.


$array = array('сложный', 'массив', 'для', 'записи', 'в', 'кэш');
$res = Storage::saveSystem('cacheName', $array);
var_dump($res);

Метод


mixed getSystem (string $name)

Параметры

$name: ключ.

Описание

Возвращает сохраненный ранее объект из системного кэша.


$res = Storage::getSystem('cacheName');
viewData($res);

Метод


bool clearSystem (string $object)

Параметры

$object: ключ объекта

Описание

Очищает системный кэш для всех или определенного объекта.


// чистит от указанный кэш
$res = Storage::clearSystem('cacheName');
var_dump($res);
// чистит весь кэш
$res = Storage::clearSystem();
var_dump($res);