ProCache .htaccess

Methods for managing ProCache’s directives in ProcessWire’s .htaccess file.

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

Show $var?     Show args?       Only hookable?    

Common

NameReturnSummary 
$procache->htaccess->checkHtaccessFile()
string

Check if current .htaccess file needs any updates and return them if so

 
$procache->htaccess->getExampleHtaccessFile()
string

Get path/filename of example .htaccess file

 
$procache->htaccess->getFieldset()
bool InputfieldFieldset

Get Fieldset for ProcessProCache

 
$procache->htaccess->getHtaccessRulesV1()
string

Return old htaccess version (v1) which is still considered valid

 
$procache->htaccess->getLiveHtaccessContents()
string

Get contents of current live .htaccess file

 
$procache->htaccess->getLiveHtaccessFile()
string

Get htaccess file

 
$procache->htaccess->getLiveHtaccessVersion()
string

Get ProCache version hash found in current live .htaccess file

 
$procache->htaccess->getRequiredHtaccessVersion()
string

Get required htaccess version

 
$procache->htaccess->removeHtaccessRules(string $fileContents)
string

Remove ProCache .htaccess rules from given fileContents and return it

 
$procache->htaccess->setLiveHtaccessFile(string $htaccessFile)
None

Set full path/file to .htaccess file

 
$procache->htaccess->useExampleFiles()
None

Allow writing to example htaccess files?

 

Additional methods and properties

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

API reference based on ProcessWire core version 3.0.252