• Home
  • HTMLPurifier_DefinitionCache_Serializer

PHP Class HTMLPurifier_DefinitionCache_Serializer, yii

Inheritance: extends HTMLPurifier_DefinitionCache
Show file Open project: yiisoft/yii Class Usage Examples

Public Methods

Method Description
add ( HTMLPurifier_Definition $def, HTMLPurifier_Config $config ) : integer | boolean
cleanup ( HTMLPurifier_Config $config ) : boolean
flush ( HTMLPurifier_Config $config ) : boolean
generateBaseDirectoryPath ( HTMLPurifier_Config $config ) : mixed | string Generates path to base directory that contains all definition type serials
generateDirectoryPath ( HTMLPurifier_Config $config ) : string Generates the path to the directory contain this cache's serial files
generateFilePath ( HTMLPurifier_Config $config ) : string Generates the file path to the serial file corresponding to the configuration and definition name
get ( HTMLPurifier_Config $config ) : boolean | HTMLPurifier_Config
remove ( HTMLPurifier_Config $config ) : boolean
replace ( HTMLPurifier_Definition $def, HTMLPurifier_Config $config ) : integer | boolean
set ( HTMLPurifier_Definition $def, HTMLPurifier_Config $config ) : integer | boolean

Private Methods

Method Description
_prepareDir ( HTMLPurifier_Config $config ) : boolean Prepares the directory that this type stores the serials in
_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
_write ( string $file, string $data, HTMLPurifier_Config $config ) : integer | boolean Convenience wrapper function for file_put_contents

Method Details

add() public method

public add ( HTMLPurifier_Definition $def, HTMLPurifier_Config $config ) : integer | boolean
$def HTMLPurifier_Definition
$config HTMLPurifier_Config
return integer | boolean

cleanup() public method

public cleanup ( HTMLPurifier_Config $config ) : boolean
$config HTMLPurifier_Config
return boolean

flush() public method

public flush ( HTMLPurifier_Config $config ) : boolean
$config HTMLPurifier_Config
return boolean

generateBaseDirectoryPath() public method

Generates path to base directory that contains all definition type serials
public generateBaseDirectoryPath ( HTMLPurifier_Config $config ) : mixed | string
$config HTMLPurifier_Config
return mixed | string

generateDirectoryPath() public method

Generates the path to the directory contain this cache's serial files
public generateDirectoryPath ( HTMLPurifier_Config $config ) : string
$config HTMLPurifier_Config
return string

generateFilePath() public method

Generates the file path to the serial file corresponding to the configuration and definition name
public generateFilePath ( HTMLPurifier_Config $config ) : string
$config HTMLPurifier_Config
return string

get() public method

public get ( HTMLPurifier_Config $config ) : boolean | HTMLPurifier_Config
$config HTMLPurifier_Config
return boolean | HTMLPurifier_Config

remove() public method

public remove ( HTMLPurifier_Config $config ) : boolean
$config HTMLPurifier_Config
return boolean

replace() public method

public replace ( HTMLPurifier_Definition $def, HTMLPurifier_Config $config ) : integer | boolean
$def HTMLPurifier_Definition
$config HTMLPurifier_Config
return integer | boolean

set() public method

public set ( HTMLPurifier_Definition $def, HTMLPurifier_Config $config ) : integer | boolean
$def HTMLPurifier_Definition
$config HTMLPurifier_Config
return integer | boolean