ProCacheFileMerger class

Copyright (C) 2023 by Ryan Cramer

This is a commercially licensed and supported module DO NOT DISTRIBUTE

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the ProCacheFileMerger class also inherits all the methods and properties of: Wire.

Common

Name	Return	Summary
ProCacheFileMerger::clean() ProCacheFileMerger::clean() ProCacheFileMerger::clean(string $ext = '', int $expiredSeconds = 0)	`int`	Clean up the merged file cache, removing old/expired files
ProCacheFileMerger::clear() ProCacheFileMerger::clear() ProCacheFileMerger::clear(string $ext = '')	`int`	Clear out all cached files
ProCacheFileMerger::clearFiles() ProCacheFileMerger::clearFiles($basenames) ProCacheFileMerger::clearFiles($basenames)	`int`	Clear files by basename
ProCacheFileMerger::compileLESS() ProCacheFileMerger::compileLESS(string $file) ProCacheFileMerger::compileLESS(string $file, array $options = [])	`string`	Compile a LESS file
ProCacheFileMerger::compileSCSS() ProCacheFileMerger::compileSCSS(string $file) ProCacheFileMerger::compileSCSS(string $file, array $options = [])	`string` `bool`	Compile an SCSS file
ProCacheFileMerger::getDestination() ProCacheFileMerger::getDestination() ProCacheFileMerger::getDestination($url = false)	None
ProCacheFileMerger::getFileContents() ProCacheFileMerger::getFileContents($file) ProCacheFileMerger::getFileContents($file)	`string`	Get the contents of a file
ProCacheFileMerger::getFiles() ProCacheFileMerger::getFiles() ProCacheFileMerger::getFiles(string $ext = '')	`array`	Get all files in the merge cache (both css and js)
ProCacheFileMerger::getHashSRI() ProCacheFileMerger::getHashSRI() ProCacheFileMerger::getHashSRI()	`string`	SRI hash for inclusion in script tag, only available after a merge() call that specified use of $sri
ProCacheFileMerger::getLESS() ProCacheFileMerger::getLESS() ProCacheFileMerger::getLESS(bool $cache = true)	`lessc`	Return instance of LESS compiler
ProCacheFileMerger::getMinifierCSS() ProCacheFileMerger::getMinifierCSS() ProCacheFileMerger::getMinifierCSS()	None
ProCacheFileMerger::getMinifierJS() ProCacheFileMerger::getMinifierJS() ProCacheFileMerger::getMinifierJS()	None
ProCacheFileMerger::getNumFiles() ProCacheFileMerger::getNumFiles() ProCacheFileMerger::getNumFiles(string $ext = '')	`int`	Get the number of files in the merge cache
ProCacheFileMerger::getSCSS() ProCacheFileMerger::getSCSS() ProCacheFileMerger::getSCSS(bool $cache = true)	`ScssPhp\ScssPhp\Compiler`	Return instance of SCSS compiler
ProCacheFileMerger::merge() ProCacheFileMerger::merge($files) ProCacheFileMerger::merge($files, bool $minify = false, bool $sri = false)	`$this`	Given a list of file URLs, merge them into a single file
ProCacheFileMerger::mergeCSSFilesInMarkup() ProCacheFileMerger::mergeCSSFilesInMarkup(string $html) ProCacheFileMerger::mergeCSSFilesInMarkup(string $html, bool $minify = true)	`string`	Given contents of an HTML document merge and minify <link rel='stylesheet'> tags
ProCacheFileMerger::mergeJSFilesInMarkup() ProCacheFileMerger::mergeJSFilesInMarkup(string $html) ProCacheFileMerger::mergeJSFilesInMarkup(string $html, bool $head = true, bool $minify = true)	`string`	Given contents of an HTML document merge and minify <script src='...'></script> tags
ProCacheFileMerger::minifyInlineCSS() ProCacheFileMerger::minifyInlineCSS(string $out) ProCacheFileMerger::minifyInlineCSS(string $out)	`int`	Minify inline CSS in the given HTML string
ProCacheFileMerger::minifyInlineJS() ProCacheFileMerger::minifyInlineJS(string $out) ProCacheFileMerger::minifyInlineJS(string $out)	`int`	Minify inline JS in the given HTML string
ProCacheFileMerger::path() ProCacheFileMerger::path() ProCacheFileMerger::path()	`string`	Get the path for the merged file
ProCacheFileMerger::procache() ProCacheFileMerger::procache() ProCacheFileMerger::procache($procache = null)	`ProCache`	Get or set ProCache instance
ProCacheFileMerger::setDestination() ProCacheFileMerger::setDestination($destination) ProCacheFileMerger::setDestination($destination)	`$this`	Set the destination for merged files
ProCacheFileMerger::setExpiration() ProCacheFileMerger::setExpiration($seconds) ProCacheFileMerger::setExpiration($seconds)	`$this`	Set the max age of a cached CSS/JS file
ProCacheFileMerger::setExtension() ProCacheFileMerger::setExtension($ext) ProCacheFileMerger::setExtension($ext)	`$this`	Set the file extension
ProCacheFileMerger::setMaxImportSizeCSS() ProCacheFileMerger::setMaxImportSizeCSS(int $size) ProCacheFileMerger::setMaxImportSizeCSS(int $size)	`$this`	Set the max CSS file import size (for background images, etc.)
ProCacheFileMerger::setPrefix() ProCacheFileMerger::setPrefix($prefix) ProCacheFileMerger::setPrefix($prefix)	`$this`	Set the file prefix (default=pwpc)
ProCacheFileMerger::setSource() ProCacheFileMerger::setSource($source) ProCacheFileMerger::setSource($source)	`$this`	Set the relative source directory
ProCacheFileMerger::updateCSS() ProCacheFileMerger::updateCSS($out, $file) ProCacheFileMerger::updateCSS($out, $file)	None	Adjustments to CSS file contents
ProCacheFileMerger::url() ProCacheFileMerger::url() ProCacheFileMerger::url()	`string`	Get the URL for the merged file

Additional methods and properties

In addition to the methods and properties above, ProCacheFileMerger also inherits the methods and properties of these classes:

Wire

API reference based on ProcessWire core version 3.0.251