PHP Class HTMLPurifier_HTMLDefinition, yii

Conventions: All member variables that are prefixed with info (including the main $info array) are used by HTML Purifier internals and should not be directly edited when customizing the HTMLDefinition. They can usually be set via configuration directives or custom modules. On the other hand, member variables without the info prefix are used internally by the HTMLDefinition and MUST NOT be used by other HTML Purifier internals. Many of them, however, are public, and may be edited by userspace code to tweak the behavior of HTMLDefinition.

Inheritance: extends HTMLPurifier_Definition

Mostra file Open project: yiisoft/yii Class Usage Examples

Public Properties

Property	Type	Description
$doctype		Doctype object
$info		Associative array of element names to HTMLPurifier_ElementDef.
$info_attr_transform_post		Indexed list of HTMLPurifier_AttrTransform to be performed after validation.
$info_attr_transform_pre		Indexed list of HTMLPurifier_AttrTransform to be performed before validation.
$info_block_wrapper		String name of element used to wrap inline elements in block context.
$info_content_sets		Nested lookup array of content set name (Block, Inline) to element name to whether or not it belongs in that content set.
$info_global_attr		Associative array of global attribute name to attribute definition.
$info_injector		Indexed list of HTMLPurifier_Injector to be used.
$info_parent		String name of parent element HTML will be going into.
$info_parent_def		Definition for parent element, allows parent element to be a tag that's not allowed inside the HTML fragment.
$info_tag_transform		Associative array of deprecated tag name to HTMLPurifier_TagTransform.
$manager
$type

Public Methods

Method	Description
__construct ( )	Performs low-cost, preliminary initialization.
addAttribute ( string $element_name, string $attr_name, mixed $def )	Adds a custom attribute to a pre-existing element
addBlankElement ( string $element_name ) : HTMLPurifier_ElementDef	Adds a blank element to your HTML definition, for overriding existing behavior
addElement ( $element_name, $type, $contents, $attr_collections, $attributes = [] )	Adds a custom element to your HTML definition
getAnonymousModule ( ) : HTMLPurifier_HTMLModule	Retrieves a reference to the anonymous module, so you can bust out advanced features without having to make your own module.
parseTinyMCEAllowedList ( array $list ) : array	Parses a TinyMCE-flavored Allowed Elements and Attributes list into separate lists for processing. Format is element[attr1\|attr2],element2.

Protected Methods

Method	Description
doSetup ( HTMLPurifier_Config $config )
processModules ( HTMLPurifier_Config $config )	Extract out the information from the manager
setupConfigStuff ( HTMLPurifier_Config $config )	Sets up stuff based on config. We need a better way of doing this.

Method Details

__construct() public method

Performs low-cost, preliminary initialization.

public __construct ( )

addAttribute() public method

Adds a custom attribute to a pre-existing element

public addAttribute ( string $element_name, string $attr_name, mixed $def )
$element_name	string	Element name to add attribute to
$attr_name	string	Name of attribute
$def	mixed	Attribute definition, can be string or object, see HTMLPurifier_AttrTypes for details

addBlankElement() public method

Adds a blank element to your HTML definition, for overriding existing behavior

See also: HTMLPurifier_HTMLModule::addBlankElement() for detailed parameter and return value descriptions.

public addBlankElement ( string $element_name ) : HTMLPurifier_ElementDef
$element_name	string
return	HTMLPurifier_ElementDef

addElement() public method

Adds a custom element to your HTML definition

See also: HTMLPurifier_HTMLModule::addElement() for detailed parameter and return value descriptions.

public addElement ( $element_name, $type, $contents, $attr_collections, $attributes = [] )

doSetup() protected method

protected doSetup ( HTMLPurifier_Config $config )
$config	HTMLPurifier_Config

getAnonymousModule() public method

Retrieves a reference to the anonymous module, so you can bust out advanced features without having to make your own module.

public getAnonymousModule ( ) : HTMLPurifier_HTMLModule
return	HTMLPurifier_HTMLModule

parseTinyMCEAllowedList() public method

public parseTinyMCEAllowedList ( array $list ) : array
$list	array	String list to parse
return	array

processModules() protected method

Extract out the information from the manager

protected processModules ( HTMLPurifier_Config $config )
$config	HTMLPurifier_Config

setupConfigStuff() protected method

Sets up stuff based on config. We need a better way of doing this.

protected setupConfigStuff ( HTMLPurifier_Config $config )
$config	HTMLPurifier_Config

Property Details

$doctype public_oe property

Doctype object

public $doctype

$info public_oe property

Associative array of element names to HTMLPurifier_ElementDef.

public $info

$info_attr_transform_post public_oe property

Indexed list of HTMLPurifier_AttrTransform to be performed after validation.

public $info_attr_transform_post

$info_attr_transform_pre public_oe property

Indexed list of HTMLPurifier_AttrTransform to be performed before validation.

public $info_attr_transform_pre

$info_block_wrapper public_oe property

String name of element used to wrap inline elements in block context.

public $info_block_wrapper

$info_content_sets public_oe property

Nested lookup array of content set name (Block, Inline) to element name to whether or not it belongs in that content set.

public $info_content_sets

$info_global_attr public_oe property

Associative array of global attribute name to attribute definition.

public $info_global_attr

$info_injector public_oe property

Indexed list of HTMLPurifier_Injector to be used.

public $info_injector

$info_parent public_oe property

String name of parent element HTML will be going into.

public $info_parent

$info_parent_def public_oe property

Definition for parent element, allows parent element to be a tag that's not allowed inside the HTML fragment.

public $info_parent_def

$info_tag_transform public_oe property

Associative array of deprecated tag name to HTMLPurifier_TagTransform.

public $info_tag_transform

$manager public_oe property

public $manager

$type public_oe property

public $type