ICache

Пакет	system.caching
Наследование	интерфейс ICache
Подклассы	CApcCache, CCache, CDbCache, CDummyCache, CEAcceleratorCache, CFileCache, CMemCache, CRedisCache, CWinCache, CXCache, CZendDataCache
С тех пор	1.0
Исходный код	framework/base/interfaces.php

ICache — это интерфейс, который должны реализовывать компоненты кэширования.

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

Открытые методы

Метод	Описание	Определён в
add()	Сохраняет значение, идентифицируемое ключом, в кэше, если кэш не содержит этот ключ.	ICache
delete()	Удаляет значение с указанным ключом из кэша	ICache
flush()	Удаляет все значения из кэша.	ICache
get()	Извлекает значение из кэша по указанному ключу.	ICache
mget()	Извлекает несколько значений из кэша по указанным ключам.	ICache
set()	Сохраняет значение, идентифицируемое ключом, в кэше.	ICache

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

add() метод

abstract public boolean add(string $id, mixed $value, integer $expire=0, ICacheDependency $dependency=NULL)
$id	строка	ключ, идентифицирующий значение, которое необходимо поместить в кэш
$value	смешанный тип	значение, которое необходимо поместить в кэш
$expire	целое число	количество секунд, в течение которых кэшированное значение будет действовать. 0 означает, что срок действия не ограничен.
$dependency	ICacheDependency	зависимость кэшированного элемента. Если зависимость изменяется, элемент помечается как недействительный.
{return}	логическое значение	true, если значение успешно сохранено в кэше, иначе false

Исходный код: framework/base/interfaces.php#83 (показать)

public function add($id,$value,$expire=0,$dependency=null);

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

delete() метод

abstract public boolean delete(string $id)
$id	строка	ключ значения, которое нужно удалить
{return}	логическое значение	была ли удаление успешной

Исходный код: framework/base/interfaces.php#89 (показать)

public function delete($id);

Удаляет значение с указанным ключом из кэша

flush() метод

abstract public boolean flush()
{return}	логическое значение	была ли операция очистки успешной.

Исходный код: framework/base/interfaces.php#95 (показать)

public function flush();

Удаляет все значения из кэша. Будьте осторожны при выполнении этой операции, если кэш используется несколькими приложениями.

get() метод

abstract public mixed get(string $id)
$id	строка	ключ, идентифицирующий кэшированное значение
{return}	смешанный тип	значение, хранящееся в кэше, false, если значение отсутствует в кэше или истек срок его действия.

Исходный код: framework/base/interfaces.php#50 (показать)

public function get($id);

Извлекает значение из кэша по указанному ключу.

mget() метод

abstract public array mget(array $ids)
$ids	массив	список ключей, идентифицирующих кэшированные значения
{return}	массив	список кэшированных значений, соответствующих указанным ключам. Массив возвращается в виде пар (ключ, значение). Если значение не кэшировано или срок его действия истек, соответствующее значение массива будет false.

Исходный код: framework/base/interfaces.php#61 (показать)

public function mget($ids);

Извлекает несколько значений из кэша по указанным ключам. Некоторые кэши (например, memcache, apc) позволяют извлекать несколько кэшированных значений за один раз, что может повысить производительность, поскольку это снижает затраты на коммуникацию. В случае если кэш не поддерживает эту функцию напрямую, она будет моделироваться этим методом.

set() метод

abstract public boolean set(string $id, mixed $value, integer $expire=0, ICacheDependency $dependency=NULL)
$id	строка	ключ, идентифицирующий значение, которое необходимо поместить в кэш
$value	смешанный тип	значение, которое необходимо поместить в кэш
$expire	целое число	количество секунд, в течение которых кэшированное значение будет действовать. 0 означает, что срок действия не ограничен.
$dependency	ICacheDependency	зависимость кэшированного элемента. Если зависимость изменяется, элемент помечается как недействительный.
{return}	логическое значение	true, если значение успешно сохранено в кэше, иначе false

Исходный код: framework/base/interfaces.php#73 (показать)

public function set($id,$value,$expire=0,$dependency=null);

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

© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc/api/1.1/ICache