ProCacheHtaccess 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 ProCacheHtaccess class also inherits all the methods and properties of: ProCacheClass and Wire.

Common

Name	Return	Summary
ProCacheHtaccess::checkHtaccessFile() ProCacheHtaccess::checkHtaccessFile() ProCacheHtaccess::checkHtaccessFile()	`string`	Check if current .htaccess file needs any updates and return them if so
ProCacheHtaccess::getAcceptedHtaccessVersions() ProCacheHtaccess::getAcceptedHtaccessVersions() ProCacheHtaccess::getAcceptedHtaccessVersions()	`array`	@return array
ProCacheHtaccess::getExampleHtaccessFile() ProCacheHtaccess::getExampleHtaccessFile() ProCacheHtaccess::getExampleHtaccessFile(bool $getUrl = false)	`string`	Get path/filename of example .htaccess file
ProCacheHtaccess::getFieldset() ProCacheHtaccess::getFieldset() ProCacheHtaccess::getFieldset()	`bool` `InputfieldFieldset`	Get Fieldset for ProcessProCache
ProCacheHtaccess::getHtaccessRulesV1() ProCacheHtaccess::getHtaccessRulesV1() ProCacheHtaccess::getHtaccessRulesV1(bool $getVersion = false)	`string`	Return old htaccess version (v1) which is still considered valid
ProCacheHtaccess::getLiveHtaccessContents() ProCacheHtaccess::getLiveHtaccessContents() ProCacheHtaccess::getLiveHtaccessContents()	`string`	Get contents of current live .htaccess file
ProCacheHtaccess::getLiveHtaccessFile() ProCacheHtaccess::getLiveHtaccessFile() ProCacheHtaccess::getLiveHtaccessFile(bool $getUrl = false)	`string`	Get htaccess file
ProCacheHtaccess::getLiveHtaccessVersion() ProCacheHtaccess::getLiveHtaccessVersion() ProCacheHtaccess::getLiveHtaccessVersion()	`string`	Get ProCache version hash found in current live .htaccess file
ProCacheHtaccess::getRequiredHtaccessVersion() ProCacheHtaccess::getRequiredHtaccessVersion() ProCacheHtaccess::getRequiredHtaccessVersion()	`string`	Get required htaccess version
ProCacheHtaccess::removeHtaccessRules() ProCacheHtaccess::removeHtaccessRules(string $fileContents) ProCacheHtaccess::removeHtaccessRules(string $fileContents, array $options = [])	`string`	Remove ProCache .htaccess rules from given fileContents and return it
ProCacheHtaccess::setLiveHtaccessFile() ProCacheHtaccess::setLiveHtaccessFile(string $htaccessFile) ProCacheHtaccess::setLiveHtaccessFile(string $htaccessFile)	None	Set full path/file to .htaccess file
ProCacheHtaccess::useExampleFiles() ProCacheHtaccess::useExampleFiles() ProCacheHtaccess::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.251