ProCache Static Clear

Methods for clearing the static cache files and directories.

$clear = $procache->static->clear();
$clear->clearAll();

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the ProCacheStaticClear class also inherits all the methods and properties of: ProCacheClass and Wire.

Common
For hooks

Common

Name	Return	Summary
$clear->addTestData() $clear->addTestData(string $action) $clear->addTestData(string $action, $page = null, string $file = '')	None	Add test mode data
$clear->cacheMaintenance() $clear->cacheMaintenance() $clear->cacheMaintenance(array $options = [])	`int` `array`	Cache maintenance to clear out cache files and DB entries have have expired
$clear->clearAll() $clear->clearAll() $clear->clearAll()	`int`	Clear entire cache
$clear->clearBranch() $clear->clearBranch(Page $page) $clear->clearBranch(Page $page)	`int`	Clear entire Page branch (Page and everything below it)
$clear->clearPage() $clear->clearPage(Page $page) $clear->clearPage(Page $page, array $options = [])	`int` `array`	Clear the cache for a specific page
$clear->clearPages() $clear->clearPages(PageArray $items) $clear->clearPages(PageArray $items, array $options = [])	`int` `array`	Clear the cache for multiple pages
$clear->clearPath() $clear->clearPath(string $path) $clear->clearPath(string $path, array $options = [])	`int` `array`	Clear by path or wildcard path, regardless of page
$clear->testMode() $clear->testMode() $clear->testMode()	`bool`	Are we in test mode?

For hooks

These methods are only useful for hooking and should not be called directly.

Name	Return	Summary
$clear->allowClearCacheEntry() $clear->allowClearCacheEntry(Page $page, ProCacheStaticEntry $entry) $clear->allowClearCacheEntry(Page $page, ProCacheStaticEntry $entry)	`bool`	Allow clearing given cache entry?
$clear->writeCacheFileReady() $clear->writeCacheFileReady(Page $page, $content, $file) $clear->writeCacheFileReady(Page $page, $content, $file, array $options = [])	`string`	Called when cache file is ready to write

Additional methods and properties

In addition to the methods and properties above, ProCacheStaticClear also inherits the methods and properties of these classes:

API reference based on ProcessWire core version 3.0.252