ProCacheFileMerger::getFileContents() method

Get the contents of a file

Same as PHP file_get_contents() except that it updates CSS files to convert relative paths to absolute paths where appropriate.

Usage

$string = $proCacheFileMerger->getFileContents($file);

Arguments

NameType(s)Description
file

Return value

string


Hooking ProCacheFileMerger::getFileContents(…)

You can add your own hook events that are executed either before or after the ProCacheFileMerger::getFileContents(…) 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 ProCacheFileMerger::getFileContents(…) method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.

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

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

  /* Your code here, perhaps modifying arguments */

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

Hooking after

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

$this->addHookAfter('ProCacheFileMerger::getFileContents', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $ProCacheFileMerger = $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)
  $file = $event->arguments(0);

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

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

ProCacheFileMerger methods and properties

API reference based on ProcessWire core version 3.0.244

Latest news

  • ProcessWire Weekly #559
    The 559th issue of ProcessWire Weekly brings in all the latest news from the ProcessWire community. Modules, sites, and more. Read on!
    Weekly.pw / 25 January 2025
  • ProcessWire 3.0.244 new main/master version
    ProcessWire 3.0.244 is our newest main/master/stable version. It's been more than a year in the making and is packed with tons of new features, issue fixes, optimizations and more. This post covers all the details.
    Blog / 18 January 2025
  • Subscribe to weekly ProcessWire news

“The end client and designer love the ease at which they can update the website. Training beyond how to log in wasn’t even necessary since ProcessWire’s default interface is straightforward.” —Jonathan Lahijani