$type
$type :
Abstract class representing Definition cache managers that implements useful common methods and is a factory.
generateKey(\HTMLPurifier_Config $config) : string
Generates a unique identifier for a particular configuration
| \HTMLPurifier_Config | $config | Instance of HTMLPurifier_Config |
isOld(string $key, \HTMLPurifier_Config $config) : boolean
Tests whether or not a key is old with respect to the configuration's version and revision number.
| string | $key | Key to test |
| \HTMLPurifier_Config | $config | Instance of HTMLPurifier_Config to test against |
checkDefType(\HTMLPurifier_Definition $def) : boolean
Checks if a definition's type jives with the cache's type
| \HTMLPurifier_Definition | $def | Definition object to check |
true if good, false if not
add(\HTMLPurifier_Definition $def, \HTMLPurifier_Config $config) : integer|boolean
Adds a definition object to the cache
| \HTMLPurifier_Definition | $def | |
| \HTMLPurifier_Config | $config |
set(\HTMLPurifier_Definition $def, \HTMLPurifier_Config $config) : integer|boolean
Unconditionally saves a definition object to the cache
| \HTMLPurifier_Definition | $def | |
| \HTMLPurifier_Config | $config |
replace(\HTMLPurifier_Definition $def, \HTMLPurifier_Config $config) : integer|boolean
Replace an object in the cache
| \HTMLPurifier_Definition | $def | |
| \HTMLPurifier_Config | $config |
get(\HTMLPurifier_Config $config) : boolean|\HTMLPurifier_Config
Retrieves a definition object from the cache
| \HTMLPurifier_Config | $config |
remove(\HTMLPurifier_Config $config) : boolean
Removes a definition object to the cache
| \HTMLPurifier_Config | $config |
flush(\HTMLPurifier_Config $config) : boolean
Clears all objects from cache
| \HTMLPurifier_Config | $config |
cleanup(\HTMLPurifier_Config $config) : boolean
Clears all expired (older version or revision) objects from cache
| \HTMLPurifier_Config | $config |
generateFilePath(\HTMLPurifier_Config $config) : string
Generates the file path to the serial file corresponding to the configuration and definition name
| \HTMLPurifier_Config | $config |
generateDirectoryPath(\HTMLPurifier_Config $config) : string
Generates the path to the directory contain this cache's serial files
| \HTMLPurifier_Config | $config |
generateBaseDirectoryPath(\HTMLPurifier_Config $config) : mixed|string
Generates path to base directory that contains all definition type serials
| \HTMLPurifier_Config | $config |
_write(string $file, string $data, \HTMLPurifier_Config $config) : integer|boolean
Convenience wrapper function for file_put_contents
| string | $file | File name to write to |
| string | $data | Data to write into file |
| \HTMLPurifier_Config | $config |
Number of bytes written if success, or false if failure.
_prepareDir(\HTMLPurifier_Config $config) : boolean
Prepares the directory that this type stores the serials in
| \HTMLPurifier_Config | $config |
True if successful
_testPermissions(string $dir, integer $chmod) : boolean
Tests permissions on a directory and throws out friendly error messages and attempts to chmod it itself if possible
| string | $dir | Directory path |
| integer | $chmod | Permissions |
True if directory is writable