ProCacheStatic::getCachePath()

Return the path where we store cache files, optionally for a page

Usage

// basic usage
$string = $proCacheStatic->getCachePath();

// usage with all arguments
$string = $proCacheStatic->getCachePath($page = null, array $options = []);

Arguments

Name	Type(s)	Description
`$page` (optional)	`Page` `null`
`$options` (optional)	`array`	`urlSegments` (array): Array of URL segments Default:[] 'urlSegmentStr' (string): URL segment string, as alternative to urlSegments array Default:'' `language` (Language\|null): Language to use Default:null `pageNum` (int): Page/pagination number Default:1 `create` (bool\|null): Create if it does not exist? true, false or null for auto-detect Default:null `convertUTF8` (bool): Convert UTF-8 paths to encoded plain text? Default:false

Return value

string

Hooking ProCacheStatic::getCachePath(…)

You can add your own hook events that are executed either before or after the ProCacheStatic::getCachePath(…) method is executed. Examples of both are included below. A good place for hook code such as this is in your /site/ready.php file.

Hooking before

The 'before' hooks are called immediately before each ProCacheStatic::getCachePath(…) method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.

$this->addHookBefore('ProCacheStatic::getCachePath', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $ProCacheStatic = $event->object;

  // Get values of arguments sent to hook (and optionally modify them)
  $page = $event->arguments(0);
  $options = $event->arguments(1);

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
  $event->arguments(0, $page);
  $event->arguments(1, $options);
});

Hooking after

The 'after' hooks are called immediately after each ProCacheStatic::getCachePath(…) method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.

$this->addHookAfter('ProCacheStatic::getCachePath', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $ProCacheStatic = $event->object;

  // An 'after' hook can retrieve and/or modify the return value
  $return = $event->return;

  // Get values of arguments sent to hook (if needed)
  $page = $event->arguments(0);
  $options = $event->arguments(1);

  /* Your code here, perhaps modifying the return value */

  // Populate back return value, if you have modified it
  $event->return = $return;
});

ProCacheStatic methods and properties

API reference based on ProcessWire core version 3.0.251