Класс CacheEngine

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

Открытые члены
	getConnectionName ()
	set ($key, $ttl, $value)
	get ($key)
	del ($key)
	setNotExists ($key, $ttl, $value)
	addToSet ($key, $value)
	getSet ($key)
	delFromSet ($key, $member)
	deleteBySet ($key, $prefix='')
	__construct (array $options=[])
	close ()
	isAvailable ()
	isCacheExpired ($path)
	read (&$vars, $baseDir, $initDir, $filename, $ttl)
	write ($vars, $baseDir, $initDir, $filename, $ttl)
	clean ($baseDir, $initDir=false, $filename=false)

Открытые статические члены
static	getConnectionClass ()

Открытые атрибуты
const	BX_BASE_LIST = '|bx_base_list|'
const	BX_DIR_LIST = '|bx_dir_list|'

Защищенные члены
	configure ($options=[])
	lock (string $key='', int $ttl=0)
	unlock (string $key='', int $ttl=0)
	getPartition ($key)
	getInitDirKey ($baseDir, $initDir=false)
	getInitDirVersion ($baseDir, $initDir=false, $generateNew=true)
	getBaseDirVersion ($baseDir)

Защищенные данные
string	$sid = 'BX'
bool	$useLock = false
int	$ttlMultiplier = 1
int	$ttlOld = 2
bool	$old = false
bool	$fullClean = false

Статические защищенные данные
static	$engine = null
static array	$locks = []
static bool	$isConnected = false
static array	$baseDirVersion = []
static array	$initDirVersion = []
static array	$listKeys = []

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

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

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

__construct()

__construct

(

array

$options = []

)

CacheEngine constructor.

Аргументы

array

$options

Cache options.

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

Методы

addToSet()

addToSet ( $key, $value )

abstract

Переопределяется в CacheEngineApc, CacheEngineMemcache и CacheEngineRedis.

clean()

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

Cleans (removes) cache directory or file.

Аргументы

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

Возвращает

void

Замещает CacheEngineInterface.

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

close()

close

(

)

Closes opened connection.

Возвращает

void

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

configure()

configure ( $options = [] )

protected

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

del()

del ( $key )

abstract

Переопределяется в CacheEngineApc, CacheEngineMemcache, CacheEngineMemcached и CacheEngineRedis.

deleteBySet()

deleteBySet ( $key, $prefix = '' )

abstract

Переопределяется в CacheEngineApc, CacheEngineMemcache и CacheEngineRedis.

delFromSet()

delFromSet ( $key, $member )

abstract

Переопределяется в CacheEngineApc, CacheEngineMemcache и CacheEngineRedis.

get()

get ( $key )

abstract

Переопределяется в CacheEngineApc, CacheEngineMemcache и CacheEngineRedis.

getBaseDirVersion()

getBaseDirVersion ( $baseDir )

protected

Return BaseDirVersion

Аргументы

bool | string

$baseDir

Base cache directory (usually /bitrix/cache).

Возвращает

string

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

getConnectionClass()

static getConnectionClass ( )

staticabstract

Переопределяется в CacheEngineApc, CacheEngineMemcache, CacheEngineMemcached и CacheEngineRedis.

getConnectionName()

getConnectionName ( )

abstract

Переопределяется в CacheEngineApc, CacheEngineMemcache, CacheEngineMemcached и CacheEngineRedis.

getInitDirKey()

getInitDirKey ( $baseDir, $initDir = false )

protected

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

getInitDirVersion()

getInitDirVersion ( $baseDir, $initDir = false, $generateNew = true )

protected

Return InitDirVersion

Аргументы

bool | string	$baseDir	Base cache directory (usually /bitrix/cache).
bool | string	$initDir	Directory within base.
bool	$generateNew	Create new value if cache empty.

Возвращает

string

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

getPartition()

getPartition ( $key )

protected

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

getSet()

getSet ( $key )

abstract

Переопределяется в CacheEngineApc, CacheEngineMemcache и CacheEngineRedis.

isAvailable()

isAvailable

(

)

Returns true if cache can be read or written.

Возвращает

bool

Замещает CacheEngineInterface.

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

isCacheExpired()

isCacheExpired

(

$path

)

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

Аргументы

string

$path

Absolute physical path.

Возвращает

boolean

Замещает CacheEngineInterface.

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

lock()

lock ( string $key = '', int $ttl = 0 )

protected

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

Аргументы

string	$key	Calculated cache key.
integer	$ttl	Expiration period in seconds.

Возвращает

boolean

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

read()

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

Reads cache from the memcache. Returns true if key 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

Замещает CacheEngineInterface.

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

set()

set ( $key, $ttl, $value )

abstract

Переопределяется в CacheEngineApc, CacheEngineMemcache, CacheEngineMemcached и CacheEngineRedis.

setNotExists()

setNotExists ( $key, $ttl, $value )

abstract

Переопределяется в CacheEngineApc, CacheEngineMemcache и CacheEngineRedis.

unlock()

unlock ( string $key = '', int $ttl = 0 )

protected

Releases the lock obtained by lock method.

Аргументы

string	$key	Calculated cache key.
integer	$ttl	Expiration period in seconds.

Возвращает

void

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

write()

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

Puts cache into the memcache.

Аргументы

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

Замещает CacheEngineInterface.

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

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

$baseDirVersion

array $baseDirVersion = []

staticprotected

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

$engine

$engine = null

staticprotected

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

$fullClean

bool $fullClean = false

protected

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

$initDirVersion

array $initDirVersion = []

staticprotected

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

$isConnected

bool $isConnected = false

staticprotected

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

$listKeys

array $listKeys = []

staticprotected

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

$locks

array $locks = []

staticprotected

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

$old

bool $old = false

protected

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

$sid

string $sid = 'BX'

protected

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

$ttlMultiplier

int $ttlMultiplier = 1

protected

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

$ttlOld

int $ttlOld = 2

protected

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

$useLock

bool $useLock = false

protected

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

BX_BASE_LIST

const BX_BASE_LIST = '|bx_base_list|'

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

BX_DIR_LIST

const BX_DIR_LIST = '|bx_dir_list|'

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