API:clearCache

From MODx Wiki

Jump to: navigation, search

API Function Definition:

clearCache

Versions: > 0.6.0 ?
Return Values: Success: stripped string; Fail: null
Data Type: boolean
Object Hierarchy: DocumentParser

boolean clearCache();

Clears the cache directory.

[edit]

Examples


 // do some changes that are not noted by the cache manager 
 // typically in a module
 
 $modx->clearCache();

[edit]

Related Functions

[edit]

Source Code

File:	manager/includes/document.parser.class.inc.php
Line:	1495

function clearCache() {
        $basepath= $this->config["base_path"] . "assets/cache";
        if (@ $handle= opendir($basepath)) {
            $filesincache= 0;
            $deletedfilesincache= 0;
            while (false !== ($file= readdir($handle))) {
                if ($file != "." && $file != "..") {
                    $filesincache += 1;
                    if (preg_match("/\.pageCache/", $file)) {
                        $deletedfilesincache += 1;
                        unlink($basepath . "/" . $file);
                    }
                }
            }
            closedir($handle);
            return true;
        } else {
            return false;
        }
    }