PHP Class HTMLPurifier_HTMLModule_Tidy, yii

Inheritance: extends HTMLPurifier_HTMLModule

显示文件 Open project: yiisoft/yii Class Usage Examples

Public Properties

Property	Type	Description
$defaultLevel		Disabled by default.
$fixesForLevel		Format is: HTMLModule_Tidy->fixesForLevel[$level] = array('fix-1', 'fix-2');
$levels		Index zero is a special case "no fixes" level.

Public Methods

Method	Description
getFixType ( $name ) : array(string	Parses a fix name and determines what kind of fix it is, as well as other information defined by the fix
getFixesForLevel ( string $level ) : array	Retrieves all fixes per a level, returning fixes for that specific level as well as all levels below it.
makeFixes ( ) : array	Defines all fixes the module will perform in a compact associative array of fix name to fix implementation.
makeFixesForLevel ( array $fixes )	Dynamically populates the $fixesForLevel member variable using the fixes array. It may be custom overloaded, used in conjunction with $defaultLevel, or not used at all.
populate ( array $fixes )	Populates the module with transforms and other special-case code based on a list of fixes passed to it
setup ( HTMLPurifier_Config $config )	Lazy load constructs the module by determining the necessary fixes to create and then delegating to the populate() function.

Method Details

getFixType() public method

Parses a fix name and determines what kind of fix it is, as well as other information defined by the fix

public getFixType ( $name ) : array(string
$name		String name of fix
return	array(string

getFixesForLevel() public method

Retrieves all fixes per a level, returning fixes for that specific level as well as all levels below it.

public getFixesForLevel ( string $level ) : array
$level	string	level identifier, see $levels for valid values
return	array	Lookup up table of fixes

makeFixes() public method

Defines all fixes the module will perform in a compact associative array of fix name to fix implementation.

public makeFixes ( ) : array
return	array

makeFixesForLevel() public method

Dynamically populates the $fixesForLevel member variable using the fixes array. It may be custom overloaded, used in conjunction with $defaultLevel, or not used at all.

public makeFixesForLevel ( array $fixes )
$fixes	array

populate() public method

Populates the module with transforms and other special-case code based on a list of fixes passed to it

public populate ( array $fixes )
$fixes	array	Lookup table of fixes to activate

setup() public method

Lazy load constructs the module by determining the necessary fixes to create and then delegating to the populate() function.

public setup ( HTMLPurifier_Config $config )
$config	HTMLPurifier_Config

Property Details

$defaultLevel public_oe property

Disabled by default.

public $defaultLevel

$fixesForLevel public_oe property

Format is: HTMLModule_Tidy->fixesForLevel[$level] = array('fix-1', 'fix-2');

public $fixesForLevel

$levels public_oe property

Index zero is a special case "no fixes" level.

public $levels