PHP Class HTMLPurifier_ElementDef, yii

Show file Open project: yiisoft/yii Class Usage Examples

Public Properties

Property	Type	Description
$attr		Associative array of attribute name to HTMLPurifier_AttrDef.
$attr_transform_post		List of tags HTMLPurifier_AttrTransform to be done after validation.
$attr_transform_pre		List of tags HTMLPurifier_AttrTransform to be done before validation.
$autoclose		This tag is explicitly auto-closed by the following tags.
$child		HTMLPurifier_ChildDef of this tag.
$content_model		Abstract string representation of internal ChildDef rules.
$content_model_type		Value of $child->type, used to determine which ChildDef to use, used in combination with $content_model.
$descendants_are_inline		Does the element have a content model (#PCDATA \| Inline)*? This is important for chameleon ins and del processing in HTMLPurifier_ChildDef_Chameleon. Dynamically set: modules don't have to worry about this one.
$excludes		Lookup table of tags excluded from all descendants of this tag.
$formatting		Whether or not this is a formatting element affected by the "Active Formatting Elements" algorithm.
$required_attr		Dynamically populated by HTMLPurifier_HTMLDefinition::getElement()
$standalone		Does the definition work by itself, or is it created solely for the purpose of merging into another definition?
$wrap		If a foreign element is found in this element, test if it is allowed by this sub-element; if it is, instead of closing the current element, place it inside this element.

Public Methods

Method	Description
create ( $content_model, $content_model_type, $attr )	Low-level factory constructor for creating new standalone element defs
mergeIn ( HTMLPurifier_ElementDef $def )	Merges the values of another element definition into this one.

Private Methods

Method	Description
_mergeAssocArray ( &$a1, $a2 )	Merges one array into another, removes values which equal false

Method Details

create() public static method

Low-level factory constructor for creating new standalone element defs

public static create ( $content_model, $content_model_type, $attr )

mergeIn() public method

Values from the new element def take precedence if a value is not mergeable.

public mergeIn ( HTMLPurifier_ElementDef $def )
$def	HTMLPurifier_ElementDef

Property Details

$attr public property

Associative array of attribute name to HTMLPurifier_AttrDef.

public $attr

$attr_transform_post public property

List of tags HTMLPurifier_AttrTransform to be done after validation.

public $attr_transform_post

$attr_transform_pre public property

List of tags HTMLPurifier_AttrTransform to be done before validation.

public $attr_transform_pre

$autoclose public property

This tag is explicitly auto-closed by the following tags.

public $autoclose

$child public property

HTMLPurifier_ChildDef of this tag.

public $child

$content_model public property

Abstract string representation of internal ChildDef rules.

See also: HTMLPurifier_ContentSets for how this is parsed and then transformed into an HTMLPurifier_ChildDef.

public $content_model

$content_model_type public property

Value of $child->type, used to determine which ChildDef to use, used in combination with $content_model.

public $content_model_type

$descendants_are_inline public property

Does the element have a content model (#PCDATA | Inline)*? This is important for chameleon ins and del processing in HTMLPurifier_ChildDef_Chameleon. Dynamically set: modules don't have to worry about this one.

public $descendants_are_inline

$excludes public property

Lookup table of tags excluded from all descendants of this tag.

public $excludes

$formatting public property

Whether or not this is a formatting element affected by the "Active Formatting Elements" algorithm.

public $formatting

$required_attr public property

Dynamically populated by HTMLPurifier_HTMLDefinition::getElement()

public $required_attr

$standalone public property

Does the definition work by itself, or is it created solely for the purpose of merging into another definition?

public $standalone

$wrap public property

If a foreign element is found in this element, test if it is allowed by this sub-element; if it is, instead of closing the current element, place it inside this element.

public $wrap