ProCacheStatic::addTestData() ProCacheStatic::addTestData(string $action) ProCacheStatic::addTestData(string $action, Page $page = null, string $file = '') | (nothing) | Add test mode data | |
ProCacheStatic::cacheIndexBasename() ProCacheStatic::cacheIndexBasename() ProCacheStatic::cacheIndexBasename(string $hostname = '', $https = null, string $ext = 'html') | string | Return the index filename relative to the given host and https state | |
ProCacheStatic::cacheIndexBasenames() ProCacheStatic::cacheIndexBasenames() ProCacheStatic::cacheIndexBasenames($ext = 'html', bool $getVerbose = false) | array | Get all possible index file basenames for cache files | |
ProCacheStatic::cacheMaintenance() ProCacheStatic::cacheMaintenance() ProCacheStatic::cacheMaintenance() | int | Cache maintenance to clear out cache files and DB entries have have expired | |
ProCacheStatic::clearAll() ProCacheStatic::clearAll() ProCacheStatic::clearAll() | int | Clear entire cache | |
ProCacheStatic::clearBranch() ProCacheStatic::clearBranch(Page $page) ProCacheStatic::clearBranch(Page $page) | int | Clear entire Page branch (Page and everything below it) | |
ProCacheStatic::clearPage() ProCacheStatic::clearPage(Page $page) ProCacheStatic::clearPage(Page $page, array $options = []) | int array | Clear the cache for a specific page, including pageNum and urlSegment versions | |
ProCacheStatic::clearPageNum() ProCacheStatic::clearPageNum(Page $page) ProCacheStatic::clearPageNum(Page $page, $pageNum = true, array $options = []) | int array | Clear page pagination(s) | |
| int array | Clear only root index file for given Page | |
ProCacheStatic::clearPageUrlSegments() ProCacheStatic::clearPageUrlSegments(Page $page) ProCacheStatic::clearPageUrlSegments(Page $page, $urlSegments = true, array $options = []) | int array | Clear only URL segment(s) for page (optionally specifying which ones) | |
ProCacheStatic::clearPages() ProCacheStatic::clearPages(PageArray $items) ProCacheStatic::clearPages(PageArray $items, array $options = []) | int array | Clear the cache for multiple pages | |
ProCacheStatic::clearPath() ProCacheStatic::clearPath(string $path) ProCacheStatic::clearPath(string $path, array $options = []) | int array | Clear by path or wildcard path, regardless of page | |
ProCacheStatic::columnExists() ProCacheStatic::columnExists(string $column) ProCacheStatic::columnExists(string $column, string $table = '') | bool | Does given column exist? | |
ProCacheStatic::executeCacheClearBehaviors() ProCacheStatic::executeCacheClearBehaviors(Page $page) ProCacheStatic::executeCacheClearBehaviors(Page $page) | array | Execute cache clear behaviors for given Page (to be called after Page has been modified and saved) | |
ProCacheStatic::findCacheEntries() ProCacheStatic::findCacheEntries() ProCacheStatic::findCacheEntries(array $options = []) | ProCacheStaticEntry | Find cache database rows of cache URLs for page matching given criteria | |
ProCacheStatic::getBehaviorAbbrs() ProCacheStatic::getBehaviorAbbrs() ProCacheStatic::getBehaviorAbbrs() | array | Get array of [ ProCache::CACHE_CLEAR_* => 'C' ] where 'C' is 1 char behavior abbreviation | |
ProCacheStatic::getCacheClearBehaviors() ProCacheStatic::getCacheClearBehaviors() ProCacheStatic::getCacheClearBehaviors($options = []) | array | Get the cache clearing behaviors for all templates or a given template | |
| string | Get cache clear behaviors as string | |
ProCacheStatic::getCacheFile() ProCacheStatic::getCacheFile(Page $page) ProCacheStatic::getCacheFile(Page $page, array $options = []) | string | Get cache file for given Page and options | |
ProCacheStatic::getCachePath() ProCacheStatic::getCachePath() ProCacheStatic::getCachePath($page = null, array $options = []) | string | Return the path where we store cache files, optionally for a page | |
ProCacheStatic::getCachePathRoot() ProCacheStatic::getCachePathRoot() ProCacheStatic::getCachePathRoot() | string | Get root of path for storing cache files | |
ProCacheStatic::getCacheTime() ProCacheStatic::getCacheTime() ProCacheStatic::getCacheTime($template = null) | array int string | Get the cache time for the given Template, or for all templates | |
ProCacheStatic::getCacheTimesStr() ProCacheStatic::getCacheTimesStr() ProCacheStatic::getCacheTimesStr() | string | Get a string with all custom cache times | |
ProCacheStatic::getContentTypeExt() ProCacheStatic::getContentTypeExt($item) ProCacheStatic::getContentTypeExt($item) | string | Get the content-type extension for the given Page or Template | |
ProCacheStatic::getPageCachePathsLanguages() ProCacheStatic::getPageCachePathsLanguages(Page $page) ProCacheStatic::getPageCachePathsLanguages(Page $page, array $options = []) | array | Get cache paths for Page in all languages that it is published in | |
ProCacheStatic::getTable() ProCacheStatic::getTable() ProCacheStatic::getTable() | string | Get primary ProCache DB table name while also checking that schema is up-to-date | |
ProCacheStatic::getTestData() ProCacheStatic::getTestData() ProCacheStatic::getTestData(bool $reset = true) | array | Get test mode data | |
ProCacheStatic::getTestMode() ProCacheStatic::getTestMode() ProCacheStatic::getTestMode() | bool | @return bool | |
ProCacheStatic::hasCacheFile() ProCacheStatic::hasCacheFile(Page $page) ProCacheStatic::hasCacheFile(Page $page, array $options = []) | bool string | Get cache file for given page and options if it exists, or false if it does not | |
ProCacheStatic::install() ProCacheStatic::install() ProCacheStatic::install() | (nothing) | Install | |
ProCacheStatic::newEntry() ProCacheStatic::newEntry() ProCacheStatic::newEntry(array $data = []) | ProCacheStaticEntry | Create and return a new ProCacheStaticEntry | |
ProCacheStatic::numCachedPages() ProCacheStatic::numCachedPages() ProCacheStatic::numCachedPages() | int | Return the number of pages in the cache | |
ProCacheStatic::pageInfo() ProCacheStatic::pageInfo(Page $page) ProCacheStatic::pageInfo(Page $page) | array bool | Return an info array about the given page’s ProCache info or false if not cached | |
ProCacheStatic::renderCache() ProCacheStatic::renderCache(Page $page, string $out) ProCacheStatic::renderCache(Page $page, string $out) | bool | Save a new static cache file | |
ProCacheStatic::setTestMode() ProCacheStatic::setTestMode(bool $testMode) ProCacheStatic::setTestMode(bool $testMode) | (nothing) | Enable or disable test mode | |
ProCacheStatic::uninstall() ProCacheStatic::uninstall() ProCacheStatic::uninstall() | (nothing) | Uninstall | |