\HTMLPurifier_DefinitionCache_Serializer
Synopsis
class HTMLPurifier_DefinitionCache_Serializer
extends HTMLPurifier_DefinitionCache
{
- // Inherited members from HTMLPurifier_DefinitionCache
- public $type;
- // methods
- public void add()
- public void set()
- public void replace()
- public void get()
- public void remove()
- public void flush()
- public void cleanup()
- public void generateFilePath()
- public void generateDirectoryPath()
- public void generateBaseDirectoryPath()
- private Number _write()
- private True _prepareDir()
- private void _testPermissions()
- // Inherited methods from HTMLPurifier_DefinitionCache
- public void __construct()
- public void generateKey()
- public void isOld()
- public Boolean checkDefType()
- public abstract void add()
- public abstract void set()
- public abstract void replace()
- public abstract void get()
- public abstract void remove()
- public abstract void flush()
- public abstract void cleanup()
Hierarchy
Extends
Tasks
Line | Task |
---|---|
70+ | Make protected |
80+ | Make protected |
90+ | Make protected |
Members
public
- $type
Methods
private
- _prepareDir() — Prepares the directory that this type stores the serials in
- _testPermissions() — Tests permissions on a directory and throws out friendly error messages and attempts to chmod it itself if possible
- _write() — Convenience wrapper function for file_put_contents
public
- add()
- cleanup()
- flush()
- generateBaseDirectoryPath() — Generates path to base directory that contains all definition type serials
- generateDirectoryPath() — Generates the path to the directory contain this cache's serial files
- generateFilePath() — Generates the file path to the serial file corresponding to the configuration and definition name
- get()
- remove()
- replace()
- set()
Inherited from HTMLPurifier_DefinitionCache
public
- add() — Adds a definition object to the cache
- checkDefType() — Checks if a definition's type jives with the cache's type
- cleanup() — Clears all expired (older version or revision) objects from cache
- flush() — Clears all objects from cache
- generateKey() — Generates a unique identifier for a particular configuration
- get() — Retrieves a definition object from the cache
- isOld() — Tests whether or not a key is old with respect to the configuration's version and revision number.
- remove() — Removes a definition object to the cache
- replace() — Replace an object in the cache
- set() — Unconditionally saves a definition object to the cache