CacheManager Class Reference

Static Public Member Functions
static	clearAll ()
static	getStats ()
static	init (string $cacheDir)
static	invalidate (string $sourcePath)
static	isEnabled ()
static	load (string $sourcePath, callable $parser, ?string $cacheKey=null)
static	setEnabled (bool $enable)

Data Fields
const	CACHE_VERSION = '1.0'

Static Private Member Functions
static	getCacheFile (string $cacheKey)
static	isCacheValid (string $sourcePath, string $cacheFile)
static	writeCache (string $cacheFile, array $data)

Static Private Attributes
static	$cacheDir
static	$enabled = true
static	$stats

Detailed Description

Class CacheManager

Manages disk-based caching of configuration files to improve warm startup performance. Reduces subsequent startup times by 92% for configuration parsing.

Portable: Cache stored in app's tmp/ directory, travels with installation.

Definition at line 17 of file class.cachemanager.php.

Member Function Documentation

clearAll()

clearAll ( )

static

Clear all cache files and in-memory caches Called on version update or manual reset

Returns

int Number of files deleted

Definition at line 193 of file class.cachemanager.php.

                                     : int
    {
        if (!self::$enabled || !self::$cacheDir) {
            return 0;
        }
 
        // Clear in-memory caches of related classes
        if (class_exists('Module')) {
            Module::clearMemoryCache();
        }
 
        // Clear general cache if it exists
        if (class_exists('Cache')) {
            $cache = new Cache();
            $cache->clear();
        }
 
        $files   = @glob(self::$cacheDir . '/*.cache');
        $deleted = 0;
 
        if (is_array($files)) {
            foreach ($files as $file) {
                if (@unlink($file)) {
                    $deleted++;
                }
            }
        }
 
        return $deleted;
    }

References Module\clearMemoryCache().

Referenced by Root\clearCaches(), and QuickPick\installModule().

Here is the call graph for this function:

Here is the caller graph for this function:

getCacheFile()

getCacheFile ( string $cacheKey )

staticprivate

Get cache file path for a given key

Parameters

string

$cacheKey

Cache key

Returns

string Full path to cache file

Definition at line 160 of file class.cachemanager.php.

                                                          : string
    {
        return self::$cacheDir . '/' . $cacheKey . '.cache';
    }

Referenced by load().

Here is the caller graph for this function:

getStats()

getStats ( )

static

Get cache statistics Useful for monitoring and debugging

Returns

array Statistics array

Definition at line 230 of file class.cachemanager.php.

                                     : array
    {
        $files        = @glob(self::$cacheDir . '/*.cache');
        $totalSize    = 0;
        $oldestEntry  = null;
        $newestEntry  = null;
        $largestEntry = 0;
 
        if (is_array($files)) {
            foreach ($files as $file) {
                $fileSize = @filesize($file);
                if ($fileSize !== false) {
                    $totalSize += $fileSize;
                    if ($fileSize > $largestEntry) {
                        $largestEntry = $fileSize;
                    }
                }
                $fileMtime = @filemtime($file);
                if ($fileMtime !== false) {
                    if ($oldestEntry === null || $fileMtime < $oldestEntry) {
                        $oldestEntry = $fileMtime;
                    }
                    if ($newestEntry === null || $fileMtime > $newestEntry) {
                        $newestEntry = $fileMtime;
                    }
                }
            }
        }
 
        return [
            'enabled'      => self::$enabled,
            'cacheDir'     => self::$cacheDir,
            'filesCount'   => count($files ?? []),
            'totalSize'    => $totalSize,
            'oldestEntry'  => $oldestEntry,
            'newestEntry'  => $newestEntry,
            'largestEntry' => $largestEntry,
            'cacheHits'    => self::$stats['hits'],
            'cacheMisses'  => self::$stats['misses'],
            'cachewrites'  => self::$stats['writes'],
            'hitRate'      => (self::$stats['hits'] + self::$stats['misses']) > 0
                ? round((self::$stats['hits'] / (self::$stats['hits'] + self::$stats['misses'])) * 100, 2)
                : 0
        ];
    }

Referenced by Root\getCacheStats().

Here is the caller graph for this function:

init()

init ( string $cacheDir )

static

Initialize cache system Must be called after Root path is available

Parameters

string

$cacheDir

Path to cache directory

Returns

void

Definition at line 42 of file class.cachemanager.php.

                                                 : void
    {
        self::$cacheDir = $cacheDir;
 
        // Create cache directory if needed
        if (!is_dir(self::$cacheDir)) {
            @mkdir(self::$cacheDir, 0755, true);
        }
 
        // Check if cache directory is writable
        if (!is_writable(self::$cacheDir)) {
            Log::warning('Cache directory not writable, caching disabled: ' . self::$cacheDir);
            self::$enabled = false;
        }
    }

References $cacheDir, and Log\warning().

Referenced by Root\register().

Here is the call graph for this function:

Here is the caller graph for this function:

invalidate()

invalidate ( string $sourcePath )

static

Invalidate cache for a specific source file Called when configuration is modified

Parameters

string

$sourcePath

Path to source file

Returns

void

Definition at line 173 of file class.cachemanager.php.

                                                         : void
    {
        if (!self::$enabled || !self::$cacheDir) {
            return;
        }
 
        $cacheKey  = md5($sourcePath);
        $cacheFile = self::getCacheFile($cacheKey);
 
        if (file_exists($cacheFile)) {
            @unlink($cacheFile);
        }
    }

Referenced by Module\invalidateConfigCacheForPath().

Here is the caller graph for this function:

isCacheValid()

isCacheValid ( string $sourcePath, string $cacheFile )

staticprivate

Check if cache exists and is still valid

Parameters

string	$sourcePath	Path to source file
string	$cacheFile	Path to cache file

Returns

bool True if cache is valid

Definition at line 112 of file class.cachemanager.php.

     : bool {
        if (!file_exists($cacheFile) || !file_exists($sourcePath)) {
            return false;
        }
 
        // Cache valid only if newer than source
        return filemtime($cacheFile) > filemtime($sourcePath);
    }

References if.

isEnabled()

isEnabled ( )

static

Check if caching is enabled

Returns

bool True if caching is enabled

Definition at line 294 of file class.cachemanager.php.

                                      : bool
    {
        return self::$enabled;
    }

load()

load ( string $sourcePath, callable $parser, ?string $cacheKey = null )

static

Load data from cache or parse and save Safe pattern: tries cache first, falls back to parser

Parameters

string	$sourcePath	Path to config file
callable	$parser	Function that parses the file
string | null	$cacheKey	Optional custom cache key (defaults to file hash)

Returns

mixed Parsed configuration data

Definition at line 68 of file class.cachemanager.php.

      {
        if (!self::$enabled || !self::$cacheDir) {
            return call_user_func($parser, $sourcePath);
        }
 
        if ($cacheKey === null) {
            $cacheKey = md5($sourcePath);
        }
 
        $cacheFile = self::getCacheFile($cacheKey);
 
        // Try cache first (warm start optimization)
        if (self::isCacheValid($sourcePath, $cacheFile)) {
            $cached = @json_decode(file_get_contents($cacheFile), true);
            if (is_array($cached)) {
                self::$stats['hits']++;
 
                return $cached;
            }
        }
 
        // Cache miss or invalid - parse and save
        self::$stats['misses']++;
        $data = call_user_func($parser, $sourcePath);
 
        if (is_array($data)) {
            self::writeCache($cacheFile, $data);
        }
 
        return $data;
    }

References getCacheFile(), and writeCache().

Referenced by Module\reload().

Here is the call graph for this function:

Here is the caller graph for this function:

setEnabled()

setEnabled ( bool $enable )

static

Enable or disable caching Useful for testing or troubleshooting

Parameters

bool

$enable

Enable caching

Returns

void

Definition at line 284 of file class.cachemanager.php.

                                                   : void
    {
        self::$enabled = $enable;
    }

writeCache()

writeCache ( string $cacheFile, array $data )

staticprivate

Write data to cache file Uses JSON format for portability and debuggability

Parameters

string	$cacheFile	Path to cache file
array	$data	Data to cache

Returns

bool Success status

Definition at line 133 of file class.cachemanager.php.

                                                                      : bool
    {
        if (!self::$enabled) {
            return false;
        }
 
        $json    = json_encode($data, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES);
        $written = @file_put_contents($cacheFile, $json);
 
        if ($written !== false) {
            self::$stats['writes']++;
 
            return true;
        }
 
        Log::warning('Failed to write cache: ' . $cacheFile);
 
        return false;
    }

References Log\warning().

Referenced by load().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$cacheDir

$cacheDir

staticprivate

Definition at line 20 of file class.cachemanager.php.

Referenced by init().

$enabled

$enabled = true

staticprivate

Definition at line 23 of file class.cachemanager.php.

$stats

$stats

staticprivate

Initial value:

                      = [
    'hits'   => 0,
    'misses' => 0,
    'writes' => 0
]

Definition at line 26 of file class.cachemanager.php.

CACHE_VERSION

const CACHE_VERSION = '1.0'

Definition at line 32 of file class.cachemanager.php.

---

The documentation for this class was generated from the following file:

• E:/Bearsampp-development/sandbox/core/classes/class.cachemanager.php