ProCacheStatic::static method

Get cache file for given Page and options

Usage

// basic usage
$string = $procache->static->getCacheFile(Page $page);

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

Arguments

NameType(s)Description
$pagePage
$options (optional)array
  • ext (string): File extension (omit to determine automatically).
  • 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.
  • create (bool): Create dirs if they don't exist? 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): Alternative to URL segments array, option to specify as string

Return value

string

$procache->static methods and properties

API reference based on ProcessWire core version 3.0.255