HTMLPurifier_DoctypeRegistry Class Reference

List of all members.

Public Member Functions
	register ($doctype, $xml=true, $modules=array(), $tidy_modules=array(), $aliases=array(), $dtd_public=null, $dtd_system=null)
	Registers a doctype to the registry.
	get ($doctype)
	Retrieves reference to a doctype of a certain name.
	make ($config)
	Creates a doctype based on a configuration object, will perform initialization on the doctype.
	getDoctypeFromConfig ($config)
	Retrieves the doctype from the configuration object.
	register ($doctype, $xml=true, $modules=array(), $tidy_modules=array(), $aliases=array(), $dtd_public=null, $dtd_system=null)
	Registers a doctype to the registry.
	get ($doctype)
	Retrieves reference to a doctype of a certain name.
	make ($config)
	Creates a doctype based on a configuration object, will perform initialization on the doctype.
	getDoctypeFromConfig ($config)
	Retrieves the doctype from the configuration object.
Protected Attributes
	$doctypes
	Hash of doctype names to doctype objects.
	$aliases
	Lookup table of aliases to real doctype names.

---

Detailed Description

Definition at line 3 of file DoctypeRegistry.php.

---

Member Function Documentation

HTMLPurifier_DoctypeRegistry::register	(	$	doctype,
		$	xml = true,
		$	modules = array(),
		$	tidy_modules = array(),
		$	aliases = array(),
		$	dtd_public = null,
		$	dtd_system = null
	)

Registers a doctype to the registry.

Note:

Accepts a fully-formed doctype object, or the parameters for constructing a doctype object

Parameters:

	$doctype	Name of doctype or literal doctype object
	$modules	Modules doctype will load
	$modules_for_modes	Modules doctype will load for certain modes
	$aliases	Alias names for doctype

Returns:

Editable registered doctype

Definition at line 26 of file DoctypeRegistry.php.

References $aliases.

HTMLPurifier_DoctypeRegistry::get

(

$

doctype

)

Retrieves reference to a doctype of a certain name.

Note:

This function resolves aliases

When possible, use the more fully-featured make()

Parameters:

$doctype

Name of doctype

Returns:

Editable doctype object

Definition at line 56 of file DoctypeRegistry.php.

HTMLPurifier_DoctypeRegistry::make

(

$

config

)

Creates a doctype based on a configuration object, will perform initialization on the doctype.

Note:

Use this function to get a copy of doctype that config can hold on to (this is necessary in order to tell Generator whether or not the current document is XML based or not).

Definition at line 74 of file DoctypeRegistry.php.

References getDoctypeFromConfig().

HTMLPurifier_DoctypeRegistry::getDoctypeFromConfig

(

$

config

)

Retrieves the doctype from the configuration object.

Definition at line 81 of file DoctypeRegistry.php.

Referenced by make().

HTMLPurifier_DoctypeRegistry::register	(	$	doctype,
		$	xml = true,
		$	modules = array(),
		$	tidy_modules = array(),
		$	aliases = array(),
		$	dtd_public = null,
		$	dtd_system = null
	)

Registers a doctype to the registry.

Note:

Accepts a fully-formed doctype object, or the parameters for constructing a doctype object

Parameters:

	$doctype	Name of doctype or literal doctype object
	$modules	Modules doctype will load
	$modules_for_modes	Modules doctype will load for certain modes
	$aliases	Alias names for doctype

Returns:

Editable registered doctype

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

References $aliases.

HTMLPurifier_DoctypeRegistry::get

(

$

doctype

)

Retrieves reference to a doctype of a certain name.

Note:

This function resolves aliases

When possible, use the more fully-featured make()

Parameters:

$doctype

Name of doctype

Returns:

Editable doctype object

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

HTMLPurifier_DoctypeRegistry::make

(

$

config

)

Creates a doctype based on a configuration object, will perform initialization on the doctype.

Note:

Use this function to get a copy of doctype that config can hold on to (this is necessary in order to tell Generator whether or not the current document is XML based or not).

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

References getDoctypeFromConfig().

HTMLPurifier_DoctypeRegistry::getDoctypeFromConfig

(

$

config

)

Retrieves the doctype from the configuration object.

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

---

Member Data Documentation

HTMLPurifier_DoctypeRegistry::$doctypes [protected]

Hash of doctype names to doctype objects.

Definition at line 9 of file DoctypeRegistry.php.

HTMLPurifier_DoctypeRegistry::$aliases [protected]

Lookup table of aliases to real doctype names.

Definition at line 14 of file DoctypeRegistry.php.

Referenced by register().

---

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

• library/HTMLPurifier/DoctypeRegistry.php
• library/HTMLPurifier.standalone.php

---