HTMLPurifier_DoctypeRegistry Class Reference

Collaboration diagram for HTMLPurifier_DoctypeRegistry:

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. More...
	get ($doctype)
	Retrieves reference to a doctype of a certain name. More...
	make ($config)
	Creates a doctype based on a configuration object, will perform initialization on the doctype. More...
	getDoctypeFromConfig ($config)
	Retrieves the doctype from the configuration object. More...

Protected Attributes
	$doctypes
	Hash of doctype names to doctype objects. More...
	$aliases
	Lookup table of aliases to real doctype names. More...

Detailed Description

Definition at line 3 of file DoctypeRegistry.php.

Member Function Documentation

get()

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

string

$doctype

Name of doctype

Returns

HTMLPurifier_Doctype Editable doctype object

Definition at line 83 of file DoctypeRegistry.php.

    {
        if (isset($this->aliases[$doctype])) {
            $doctype = $this->aliases[$doctype];
        }
        if (!isset($this->doctypes[$doctype])) {
            trigger_error('Doctype ' . htmlspecialchars($doctype) . ' does not exist', E_USER_ERROR);
            $anon = new HTMLPurifier_Doctype($doctype);
            return $anon;
        }
        return $this->doctypes[$doctype];
    }

getDoctypeFromConfig()

HTMLPurifier_DoctypeRegistry::getDoctypeFromConfig

(

$config

)

Retrieves the doctype from the configuration object.

Parameters

HTMLPurifier_Config

$config

Returns

string

Definition at line 116 of file DoctypeRegistry.php.

References $config.

Referenced by make().

    {
        // recommended test
        $doctype = $config->get('HTML.Doctype');
        if (!empty($doctype)) {
            return $doctype;
        }
        $doctype = $config->get('HTML.CustomDoctype');
        if (!empty($doctype)) {
            return $doctype;
        }
        // backwards-compatibility
        if ($config->get('HTML.XHTML')) {
            $doctype = 'XHTML 1.0';
        } else {
            $doctype = 'HTML 4.01';
        }
        if ($config->get('HTML.Strict')) {
            $doctype .= ' Strict';
        } else {
            $doctype .= ' Transitional';
        }
        return $doctype;
    }

Here is the caller graph for this function:

make()

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).

Parameters

HTMLPurifier_Config

$config

Returns

HTMLPurifier_Doctype

Definition at line 106 of file DoctypeRegistry.php.

References $config, and getDoctypeFromConfig().

    {
        return clone $this->get($this->getDoctypeFromConfig($config));
    }

Here is the call graph for this function:

register()

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

string	$doctype	Name of doctype or literal doctype object
bool	$xml
array	$modules	Modules doctype will load
array	$tidy_modules	Modules doctype will load for certain modes
array	$aliases	Alias names for doctype
string	$dtd_public
string	$dtd_system

Returns

HTMLPurifier_Doctype Editable registered doctype

Definition at line 31 of file DoctypeRegistry.php.

References $aliases, $name, and array.

      {
        if (!is_array($modules)) {
            $modules = array($modules);
        }
        if (!is_array($tidy_modules)) {
            $tidy_modules = array($tidy_modules);
        }
        if (!is_array($aliases)) {
            $aliases = array($aliases);
        }
        if (!is_object($doctype)) {
            $doctype = new HTMLPurifier_Doctype(
                $doctype,
                $xml,
                $modules,
                $tidy_modules,
                $aliases,
                $dtd_public,
                $dtd_system
            );
        }
        $this->doctypes[$doctype->name] = $doctype;
        $name = $doctype->name;
        // hookup aliases
        foreach ($doctype->aliases as $alias) {
            if (isset($this->doctypes[$alias])) {
                continue;
            }
            $this->aliases[$alias] = $name;
        }
        // remove old aliases
        if (isset($this->aliases[$name])) {
            unset($this->aliases[$name]);
        }
        return $doctype;
    }

Field Documentation

$aliases

HTMLPurifier_DoctypeRegistry::$aliases

protected

Lookup table of aliases to real doctype names.

array

Definition at line 16 of file DoctypeRegistry.php.

Referenced by register().

$doctypes

HTMLPurifier_DoctypeRegistry::$doctypes

protected

Hash of doctype names to doctype objects.

array

Definition at line 10 of file DoctypeRegistry.php.

---

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

• libs/composer/vendor/ezyang/htmlpurifier/library/HTMLPurifier/DoctypeRegistry.php