API - XOOPS 2.5.11 Beta 2
By monxoops.fr
HTMLPurifier_DoctypeRegistry Class Reference

Public Member Functions

 register ( $doctype, $xml=true, $modules=array(), $tidy_modules=array(), $aliases=array(), $dtd_public=null, $dtd_system=null)
 
 get ($doctype)
 
 make ($config)
 
 getDoctypeFromConfig ($config)
 

Protected Attributes

 $doctypes
 
 $aliases
 

Member Function Documentation

◆ get()

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$doctypeName of doctype
Returns
HTMLPurifier_Doctype Editable doctype object

◆ getDoctypeFromConfig()

getDoctypeFromConfig (   $config)

Retrieves the doctype from the configuration object

Parameters
HTMLPurifier_Config$config
Returns
string
Here is the caller graph for this function:

◆ make()

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
Here is the call graph for this function:

◆ register()

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$doctypeName of doctype or literal doctype object
bool$xml
array$modulesModules doctype will load
array$tidy_modulesModules doctype will load for certain modes
array$aliasesAlias names for doctype
string$dtd_public
string$dtd_system
Returns
HTMLPurifier_Doctype Editable registered doctype

Field Documentation

◆ $aliases

$aliases
protected

Lookup table of aliases to real doctype names. @type array

◆ $doctypes

$doctypes
protected

Hash of doctype names to doctype objects. @type array


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