Bitrix API

Cache

Table of Contents

Methods

__construct()  : mixed
abortDataCache()  : mixed
addCleanPath()  : void
clean()  : mixed
cleanDir()  : mixed
clearCache()  : void
createCacheEngine()  : mixed
createInstance()  : static
delayedDelete()  : void
endDataCache()  : mixed
forceRewriting()  : mixed
Sets the forced mode to ignore TTL and rewrite the cache.
getCacheEngineType()  : mixed
getConfig()  : array<string|int, mixed>
getPath()  : mixed
getSalt()  : mixed
getShowCacheStat()  : mixed
getVars()  : mixed
initCache()  : mixed
isCacheExpired()  : mixed
isStarted()  : mixed
noOutput()  : mixed
output()  : mixed
setClearCache()  : mixed
A privileged user wants to skip cache on this hit.
setClearCacheSession()  : mixed
A privileged user wants to skip cache on this session.
setShowCacheStat()  : mixed
shouldClearCache()  : bool
Returns true if a privileged user wants to skip reading from cache (on this hit or session).
startDataCache()  : mixed

Methods

__construct()

public __construct(mixed $cacheEngine) : mixed
Parameters
$cacheEngine : mixed

abortDataCache()

public abortDataCache() : mixed

addCleanPath()

public static addCleanPath() : void

clean()

public clean(mixed $uniqueString[, mixed $initDir = false ][, mixed $baseDir = 'cache' ]) : mixed
Parameters
$uniqueString : mixed
$initDir : mixed = false
$baseDir : mixed = 'cache'

cleanDir()

public cleanDir([mixed $initDir = false ][, mixed $baseDir = 'cache' ]) : mixed
Parameters
$initDir : mixed = false
$baseDir : mixed = 'cache'

clearCache()

public static clearCache([mixed $full = false ][, mixed $initDir = '' ]) : void

Use \Bitrix\Main\Data\Cache::cleanDir().

Parameters
$full : mixed = false
$initDir : mixed = ''

createCacheEngine()

public static createCacheEngine([mixed $params = [] ]) : mixed
Parameters
$params : mixed = []

createInstance()

public static createInstance([array<string|int, mixed> $params = [] ]) : static
Parameters
$params : array<string|int, mixed> = []
Return values
static —

Cache

delayedDelete()

public static delayedDelete() : void

endDataCache()

public endDataCache([mixed $vars = false ]) : mixed
Parameters
$vars : mixed = false

forceRewriting()

Sets the forced mode to ignore TTL and rewrite the cache.

public forceRewriting(bool $mode) : mixed
Parameters
$mode : bool

getCacheEngineType()

public static getCacheEngineType() : mixed

getConfig()

public getConfig() : array<string|int, mixed>
Return values
array<string|int, mixed>

getPath()

public static getPath(mixed $uniqueString) : mixed
Parameters
$uniqueString : mixed

getSalt()

public static getSalt() : mixed

getShowCacheStat()

public static getShowCacheStat() : mixed

getVars()

public getVars() : mixed

initCache()

public initCache(mixed $ttl, mixed $uniqueString[, mixed $initDir = false ][, mixed $baseDir = 'cache' ]) : mixed
Parameters
$ttl : mixed
$uniqueString : mixed
$initDir : mixed = false
$baseDir : mixed = 'cache'

isCacheExpired()

public isCacheExpired(mixed $path) : mixed
Parameters
$path : mixed

isStarted()

public isStarted() : mixed

noOutput()

public noOutput() : mixed

output()

public output() : mixed

setClearCache()

A privileged user wants to skip cache on this hit.

public static setClearCache(bool $clearCache) : mixed
Parameters
$clearCache : bool

setClearCacheSession()

A privileged user wants to skip cache on this session.

public static setClearCacheSession(bool $clearCacheSession) : mixed
Parameters
$clearCacheSession : bool

setShowCacheStat()

public static setShowCacheStat(mixed $showCacheStat) : mixed
Parameters
$showCacheStat : mixed

shouldClearCache()

Returns true if a privileged user wants to skip reading from cache (on this hit or session).

public static shouldClearCache() : bool
Return values
bool

startDataCache()

public startDataCache([mixed $TTL = false ][, mixed $uniqueString = false ][, mixed $initDir = false ][, mixed $vars = array() ][, mixed $baseDir = 'cache' ]) : mixed
Parameters
$TTL : mixed = false
$uniqueString : mixed = false
$initDir : mixed = false
$vars : mixed = array()
$baseDir : mixed = 'cache' 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results