Inheritance diagram for HTMLPurifier_DefinitionCache_Serializer:

Public Member Functions
	add ($def, $config)
	Adds a definition object to the cache.
	set ($def, $config)
	Unconditionally saves a definition object to the cache.
	replace ($def, $config)
	Replace an object in the cache.
	get ($config)
	Retrieves a definition object from the cache.
	remove ($config)
	Removes a definition object to the cache.
	flush ($config)
	Clears all objects from cache.
	cleanup ($config)
	Clears all expired (older version or revision) objects from cache.
	generateFilePath ($config)
	Generates the file path to the serial file corresponding to the configuration and definition name.
	generateDirectoryPath ($config)
	Generates the path to the directory contain this cache's serial files.
	generateBaseDirectoryPath ($config)
	Generates path to base directory that contains all definition type serials.
	add ($def, $config)
	Adds a definition object to the cache.
	set ($def, $config)
	Unconditionally saves a definition object to the cache.
	replace ($def, $config)
	Replace an object in the cache.
	get ($config)
	Retrieves a definition object from the cache.
	remove ($config)
	Removes a definition object to the cache.
	flush ($config)
	Clears all objects from cache.
	cleanup ($config)
	Clears all expired (older version or revision) objects from cache.
	generateFilePath ($config)
	Generates the file path to the serial file corresponding to the configuration and definition name.
	generateDirectoryPath ($config)
	Generates the path to the directory contain this cache's serial files.
	generateBaseDirectoryPath ($config)
	Generates path to base directory that contains all definition type serials.
Private Member Functions
	_write ($file, $data, $config)
	Convenience wrapper function for file_put_contents.
	_prepareDir ($config)
	Prepares the directory that this type stores the serials in.
	_testPermissions ($dir, $chmod)
	Tests permissions on a directory and throws out friendly error messages and attempts to chmod it itself if possible.
	_write ($file, $data, $config)
	Convenience wrapper function for file_put_contents.
	_prepareDir ($config)
	Prepares the directory that this type stores the serials in.
	_testPermissions ($dir, $chmod)
	Tests permissions on a directory and throws out friendly error messages and attempts to chmod it itself if possible.

Detailed Description

Definition at line 3 of file Serializer.php.

Member Function Documentation

HTMLPurifier_DefinitionCache_Serializer::_prepareDir ( $ config ) [private]

Prepares the directory that this type stores the serials in.

Parameters:

$config Config object

Returns:: True if successful

Definition at line 122 of file Serializer.php.

References $config, _testPermissions(), generateBaseDirectoryPath(), and generateDirectoryPath().

Referenced by add(), cleanup(), flush(), replace(), and set().

HTMLPurifier_DefinitionCache_Serializer::_prepareDir ( $ config ) [private]

Prepares the directory that this type stores the serials in.

Parameters:

$config Config object

Returns:: True if successful

Definition at line 12271 of file HTMLPurifier.standalone.php.

References $config, _testPermissions(), generateBaseDirectoryPath(), and generateDirectoryPath().

HTMLPurifier_DefinitionCache_Serializer::_testPermissions	(	$	dir,
		$	chmod
	)		`[private]`

Tests permissions on a directory and throws out friendly error messages and attempts to chmod it itself if possible.

Parameters:

$dir	Directory path
$chmod	Permissions

Returns:: True if directory writable

Definition at line 154 of file Serializer.php.

Referenced by _prepareDir().

HTMLPurifier_DefinitionCache_Serializer::_testPermissions	(	$	dir,
		$	chmod
	)		`[private]`

Tests permissions on a directory and throws out friendly error messages and attempts to chmod it itself if possible.

Parameters:

$dir	Directory path
$chmod	Permissions

Returns:: True if directory writable

Definition at line 12303 of file HTMLPurifier.standalone.php.

HTMLPurifier_DefinitionCache_Serializer::_write	(	$	file,
		$	data,
		$	config
	)		`[private]`

Convenience wrapper function for file_put_contents.

Parameters:

$file	File name to write to
$data	Data to write into file
$config	Config object

Returns:: Number of bytes written if success, or false if failure.

Definition at line 12252 of file HTMLPurifier.standalone.php.

References $config, and $data.

HTMLPurifier_DefinitionCache_Serializer::_write	(	$	file,
		$	data,
		$	config
	)		`[private]`

Convenience wrapper function for file_put_contents.

Parameters:

$file	File name to write to
$data	Data to write into file
$config	Config object

Returns:: Number of bytes written if success, or false if failure.

Definition at line 103 of file Serializer.php.

References $config, and $data.

Referenced by add(), replace(), and set().

HTMLPurifier_DefinitionCache_Serializer::add	(	$	def,
		$	config
	)

Adds a definition object to the cache.

Reimplemented from HTMLPurifier_DefinitionCache.

Definition at line 7 of file Serializer.php.

References $config, $def, _prepareDir(), _write(), HTMLPurifier_DefinitionCache::checkDefType(), and generateFilePath().

HTMLPurifier_DefinitionCache_Serializer::add	(	$	def,
		$	config
	)

Adds a definition object to the cache.

Reimplemented from HTMLPurifier_DefinitionCache.

Definition at line 12156 of file HTMLPurifier.standalone.php.

References $config, $def, _prepareDir(), _write(), HTMLPurifier_DefinitionCache::checkDefType(), and generateFilePath().

HTMLPurifier_DefinitionCache_Serializer::cleanup ( $ config )

Clears all expired (older version or revision) objects from cache.

Note:: Be carefuly implementing this method as flush. Flush must not interfere with other Definition types, and cleanup() should not be repeatedly called by userland code.

Reimplemented from HTMLPurifier_DefinitionCache.

Definition at line 12202 of file HTMLPurifier.standalone.php.

References $config, _prepareDir(), generateDirectoryPath(), and HTMLPurifier_DefinitionCache::isOld().

HTMLPurifier_DefinitionCache_Serializer::cleanup ( $ config )

Clears all expired (older version or revision) objects from cache.

Note:: Be carefuly implementing this method as flush. Flush must not interfere with other Definition types, and cleanup() should not be repeatedly called by userland code.

Reimplemented from HTMLPurifier_DefinitionCache.

Definition at line 53 of file Serializer.php.

References $config, _prepareDir(), generateDirectoryPath(), and HTMLPurifier_DefinitionCache::isOld().

HTMLPurifier_DefinitionCache_Serializer::flush ( $ config )

Clears all objects from cache.

Reimplemented from HTMLPurifier_DefinitionCache.

Definition at line 12191 of file HTMLPurifier.standalone.php.

References $config, _prepareDir(), and generateDirectoryPath().

HTMLPurifier_DefinitionCache_Serializer::flush ( $ config )

Clears all objects from cache.

Reimplemented from HTMLPurifier_DefinitionCache.

Definition at line 42 of file Serializer.php.