Интерфейс CacheEngineInterface

Граф наследования:CacheEngineInterface:

Открытые члены
	isAvailable ()
	clean ($baseDir, $initDir=false, $filename=false)
	read (&$vars, $baseDir, $initDir, $filename, $ttl)
	write ($vars, $baseDir, $initDir, $filename, $ttl)
	isCacheExpired ($path)

Подробное описание

См. определение в файле cacheengineinterface.php строка 5

Методы

clean()

clean	(		$baseDir,
			$initDir = false,
			$filename = false )

Cleans (removes) the value from the cache by the key (directory or file).

Аргументы

string	$baseDir	Base cache directory (usually /bitrix/cache).
string	$initDir	Directory within base.
string	$filename	File name.

Возвращает

void

Замещается в MemcachedClusterCache, KeyValueEngine, CacheEngineFiles, CacheEngineNone, CacheEngineRedisLight, CPHPCacheMemcacheCluster и CPHPCacheRedisCluster.

isAvailable()

isAvailable

(

)

Returns true if cache can be read or written.

Возвращает

bool

Замещается в KeyValueEngine, CacheEngineFiles и CacheEngineNone.

isCacheExpired()

isCacheExpired

(

$path

)

Returns true if the cache file has expired.

Аргументы

string

$path

Absolute physical path.

Возвращает

boolean

Замещается в KeyValueEngine, CacheEngineFiles и CacheEngineNone.

read()

read	(	&	$vars,
			$baseDir,
			$initDir,
			$filename,
			$ttl )

Reads the value from the cache. Returns true if the value exists, not expired, and successfully read.

Аргументы

mixed	&$vars	Cached result.
string	$baseDir	Base cache directory (usually /bitrix/cache).
string	$initDir	Directory within base.
string	$filename	File name.
integer	$ttl	Expiration period in seconds.

Возвращает

boolean

Замещается в KeyValueEngine, CacheEngineFiles, CacheEngineNone и CacheEngineRedisLight.

write()

write	(		$vars,
			$baseDir,
			$initDir,
			$filename,
			$ttl )

Writes the value into the cache by the key.

Аргументы

mixed	$vars	Cached result.
string	$baseDir	Base cache directory (usually /bitrix/cache).
string	$initDir	Directory within base.
string	$filename	File name.
integer	$ttl	Expiration period in seconds.

Возвращает

void

Замещается в KeyValueEngine, CacheEngineFiles, CacheEngineNone и CacheEngineRedisLight.

---

Объявления и описания членов интерфейса находятся в файле:

• C:/bitrix/modules/main/lib/data/cacheengineinterface.php