Bitrix-D7 23.9
 
Загрузка...
Поиск...
Не найдено
Класс CacheEngineXCache
+ Граф наследования:CacheEngineXCache:

Открытые члены

 __construct ($options=[])
 
 getReadBytes ()
 
 getWrittenBytes ()
 
 getCachePath ()
 
 isAvailable ()
 
 clean ($baseDir, $initDir=false, $filename=false)
 
 read (&$allVars, $baseDir, $initDir, $filename, $TTL)
 
 write ($allVars, $baseDir, $initDir, $filename, $TTL)
 
 isCacheExpired ($path)
 

Защищенные члены

 lock ($baseDir, $initDir, $key, $TTL)
 
 unlock ($baseDir, $initDir=false, $key=false, $TTL=0)
 

Защищенные данные

 $useLock = false
 
 $ttlMultiplier = 2
 

Статические защищенные данные

static $locks = array()
 

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

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

Конструктор(ы)

◆ __construct()

__construct ( $options = [])

Engine constructor.

Аргументы
array$optionsCache options.

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

Методы

◆ clean()

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

Cleans (removes) cache directory or file.

Аргументы
string$baseDirBase cache directory (usually /bitrix/cache).
string$initDirDirectory within base.
string$filenameFile name.
Возвращает
void

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

◆ getCachePath()

getCachePath ( )

Returns physical file path after read or write operation. Stub function always returns '' (empty string).

Возвращает
string

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

◆ getReadBytes()

getReadBytes ( )

Returns number of bytes read from xcache or false if there was no read operation.

Возвращает
integer|false

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

◆ getWrittenBytes()

getWrittenBytes ( )

Returns number of bytes written to xcache or false if there was no write operation.

Возвращает
integer|false

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

◆ isAvailable()

isAvailable ( )

Returns true if cache can be read or written.

Возвращает
bool

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

◆ isCacheExpired()

isCacheExpired ( $path)

Returns true if cache has been expired. Stub function always returns true.

Аргументы
string$pathAbsolute physical path.
Возвращает
boolean

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

◆ lock()

lock ( $baseDir,
$initDir,
$key,
$TTL )
protected

Tries to put non blocking exclusive lock on the cache entry. Returns true on success.

Аргументы
string$baseDirBase cache directory (usually /bitrix/cache).
string$initDirDirectory within base.
string$keyCalculated cache key.
integer$TTLExpiration period in seconds.
Возвращает
boolean

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

◆ read()

read ( & $allVars,
$baseDir,
$initDir,
$filename,
$TTL )

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

Аргументы
mixed&$allVarsCached result.
string$baseDirBase cache directory (usually /bitrix/cache).
string$initDirDirectory within base.
string$filenameFile name.
integer$TTLExpiration period in seconds.
Возвращает
boolean

Замещает CacheEngineInterface.

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

◆ unlock()

unlock ( $baseDir,
$initDir = false,
$key = false,
$TTL = 0 )
protected

Releases the lock obtained by lock method.

Аргументы
string$baseDirBase cache directory (usually /bitrix/cache).
string$initDirDirectory within base.
string$keyCalculated cache key.
integer$TTLExpiration period in seconds.
Возвращает
void

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

◆ write()

write ( $allVars,
$baseDir,
$initDir,
$filename,
$TTL )

Puts cache into the xcache.

Аргументы
mixed$allVarsCached result.
string$baseDirBase cache directory (usually /bitrix/cache).
string$initDirDirectory within base.
string$filenameFile name.
integer$TTLExpiration period in seconds.
Возвращает
void

Замещает CacheEngineInterface.

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

Данные класса

◆ $locks

$locks = array()
staticprotected

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

◆ $ttlMultiplier

$ttlMultiplier = 2
protected

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

◆ $useLock

$useLock = false
protected

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