ProCacheStatic::static method

Get cache file for given page and options if it exists, or false if it does not

This is very similar to getCacheFile() but more geared towards the public API.

Usage

// basic usage
$bool = $procache->static->hasCacheFile(Page $page);

// usage with all arguments
$bool = $procache->static->hasCacheFile(Page $page, array $options = []);

Arguments

NameType(s)Description
$pagePage
$options (optional)array
  • host (string): Hostname or omit for current hostname
  • https (bool|null): True for HTTPS-only file, false for HTTP-only file, or omit for current scheme.
  • getFile (bool): Specify true to return the filename whether it exists or not Default:false
  • pageNum (int): Pagination number or omit for first pagination or pagination not applicable.
  • language (Language|string|int|null): Language or omit for current language or if not applicable.
  • urlSegments (array): URL segments to include or omit if not applicable.
  • urlSegmentStr (string): Optionally specify URL segments here as "seg1/seg2/etc" as alternative to above.

Return value

bool string

Returns false if not cached, or returns string with cache filename if cached.


$procache->static methods and properties

API reference based on ProcessWire core version 3.0.255