HTMLPurifier_DefinitionCache_Serializer Class Reference

List of all members.

Public Member Functions
	add ($def, $config)
	set ($def, $config)
	replace ($def, $config)
	get ($config)
	remove ($config)
	flush ($config)
	cleanup ($config)
	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)
	set ($def, $config)
	replace ($def, $config)
	get ($config)
	remove ($config)
	flush ($config)
	cleanup ($config)
	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)
	Convenience wrapper function for file_put_contents.
	_prepareDir ($config)
	Prepares the directory that this type stores the serials in.
	_testPermissions ($dir)
	Tests permissions on a directory and throws out friendly error messages and attempts to chmod it itself if possible.
	_write ($file, $data)
	Convenience wrapper function for file_put_contents.
	_prepareDir ($config)
	Prepares the directory that this type stores the serials in.
	_testPermissions ($dir)
	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::add	(	$	def,
		$	config
	)

Definition at line 7 of file Serializer.php.

References _prepareDir(), _write(), and generateFilePath().

HTMLPurifier_DefinitionCache_Serializer::set	(	$	def,
		$	config
	)

Definition at line 15 of file Serializer.php.

References _prepareDir(), _write(), and generateFilePath().

HTMLPurifier_DefinitionCache_Serializer::replace	(	$	def,
		$	config
	)

Definition at line 22 of file Serializer.php.

References _prepareDir(), _write(), and generateFilePath().

HTMLPurifier_DefinitionCache_Serializer::get

(

$

config

)

Definition at line 30 of file Serializer.php.

References generateFilePath().

HTMLPurifier_DefinitionCache_Serializer::remove

(

$

config

)

Definition at line 36 of file Serializer.php.

References generateFilePath().

HTMLPurifier_DefinitionCache_Serializer::flush

(

$

config

)

Definition at line 42 of file Serializer.php.

References _prepareDir(), and generateDirectoryPath().

HTMLPurifier_DefinitionCache_Serializer::cleanup

(

$

config

)

Definition at line 53 of file Serializer.php.

References _prepareDir(), and generateDirectoryPath().

HTMLPurifier_DefinitionCache_Serializer::generateFilePath

(

$

config

)

Generates the file path to the serial file corresponding to the configuration and definition name.

Todo:

Make protected

Definition at line 70 of file Serializer.php.

References generateDirectoryPath().

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

HTMLPurifier_DefinitionCache_Serializer::generateDirectoryPath

(

$

config

)

Generates the path to the directory contain this cache's serial files.

Note:

No trailing slash

Todo:

Make protected

Definition at line 80 of file Serializer.php.

References generateBaseDirectoryPath().

Referenced by _prepareDir(), cleanup(), flush(), and generateFilePath().

HTMLPurifier_DefinitionCache_Serializer::generateBaseDirectoryPath

(

$

config

)

Generates path to base directory that contains all definition type serials.

Todo:

Make protected

Definition at line 90 of file Serializer.php.

Referenced by _prepareDir(), and generateDirectoryPath().

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

Convenience wrapper function for file_put_contents.

Parameters:

	$file	File name to write to
	$data	Data to write into file

Returns:

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

Definition at line 102 of file Serializer.php.

References $data.

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

HTMLPurifier_DefinitionCache_Serializer::_prepareDir

(

$

config

)

[private]

Prepares the directory that this type stores the serials in.

Returns:

True if successful

Definition at line 110 of file Serializer.php.

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

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

HTMLPurifier_DefinitionCache_Serializer::_testPermissions

(

$

dir

)

[private]

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

Definition at line 135 of file Serializer.php.

Referenced by _prepareDir().

HTMLPurifier_DefinitionCache_Serializer::add	(	$	def,
		$	config
	)

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

HTMLPurifier_DefinitionCache_Serializer::set	(	$	def,
		$	config
	)

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

HTMLPurifier_DefinitionCache_Serializer::replace	(	$	def,
		$	config
	)

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

HTMLPurifier_DefinitionCache_Serializer::get

(

$

config

)

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

HTMLPurifier_DefinitionCache_Serializer::remove

(

$

config

)

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

HTMLPurifier_DefinitionCache_Serializer::flush

(

$

config

)

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

HTMLPurifier_DefinitionCache_Serializer::cleanup

(

$

config

)

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

HTMLPurifier_DefinitionCache_Serializer::generateFilePath

(

$

config

)

Generates the file path to the serial file corresponding to the configuration and definition name.

Todo:

Make protected

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

HTMLPurifier_DefinitionCache_Serializer::generateDirectoryPath

(

$

config

)

Generates the path to the directory contain this cache's serial files.

Note:

No trailing slash

Todo:

Make protected

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

HTMLPurifier_DefinitionCache_Serializer::generateBaseDirectoryPath

(

$

config

)

Generates path to base directory that contains all definition type serials.

Todo:

Make protected

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

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

Convenience wrapper function for file_put_contents.

Parameters:

	$file	File name to write to
	$data	Data to write into file

Returns:

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

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

HTMLPurifier_DefinitionCache_Serializer::_prepareDir

(

$

config

)

[private]

Prepares the directory that this type stores the serials in.

Returns:

True if successful

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

HTMLPurifier_DefinitionCache_Serializer::_testPermissions

(

$

dir

)

[private]

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

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

---

The documentation for this class was generated from the following files:

• library/HTMLPurifier/DefinitionCache/Serializer.php
• library/HTMLPurifier.standalone.php

---