Класс CacheEngineFiles

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

Открытые члены
	__construct ($options=[])
	getReadBytes ()
	getWrittenBytes ()
	getCachePath ()
	isAvailable ()
	clean ($baseDir, $initDir='', $filename='')
	read (&$vars, $baseDir, $initDir, $filename, $ttl)
	write ($vars, $baseDir, $initDir, $filename, $ttl)
	isCacheExpired ($path)

Открытые статические члены
static	delayedDelete ($count=1)

Защищенные члены
	lock ($fileName)
	unlock ($fileName)

Защищенные статические члены
static	deleteOneDir ($etime=0, $ar=false)

Защищенные данные
	$useLock = false

Статические защищенные данные
static	$lockHandles = array()

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

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

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

__construct()

__construct

(

$options = []

)

Engine constructor.

Аргументы

array

$options

Cache options.

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

Методы

clean()

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

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.

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

delayedDelete()

static delayedDelete ( $count = 1 )

static

Agent function which deletes marked cache directories.

Аргументы

integer

$count

Desired delete count.

Возвращает

string

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

deleteOneDir()

static deleteOneDir ( $etime = 0, $ar = false )

staticprotected

Deletes one cache directory. Works no longer than etime.

Аргументы

integer	$etime	Timestamp when to stop working.
boolean	$ar	Record from b_cache_tag.

Возвращает

void

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

getCachePath()

getCachePath

(

)

Returns physical file path after read or write operation.

Возвращает

string

Замещает CacheEngineStatInterface.

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

getReadBytes()

getReadBytes

(

)

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

Возвращает

integer|false

Замещает CacheEngineStatInterface.

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

getWrittenBytes()

getWrittenBytes

(

)

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

Возвращает

integer|false

Замещает CacheEngineStatInterface.

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

isAvailable()

isAvailable

(

)

Returns true if cache can be read or written.

Возвращает

bool

Замещает CacheEngineInterface.

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

isCacheExpired()

isCacheExpired

(

$path

)

Returns true if cache file has expired.

Аргументы

string

$path

Absolute physical path.

Возвращает

boolean

Замещает CacheEngineInterface.

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

lock()

lock ( $fileName )

protected

Tries to put non-blocking exclusive lock on the file. Returns true if file not exists, or lock was successfully got.

Аргументы

string

$fileName

Absolute cache file path.

Возвращает

boolean

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

read()

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

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

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

unlock()

unlock ( $fileName )

protected

Releases the lock obtained by lock method.

Аргументы

string

$fileName

Absolute cache file path.

Возвращает

void

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

write()

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

Writes cache into the file.

Аргументы

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.

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

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

$lockHandles

$lockHandles = array()

staticprotected

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

$useLock

$useLock = false

protected

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