HTMLPurifier_HTMLModule_Tidy Klassenreferenz

Klassendiagramm für HTMLPurifier_HTMLModule_Tidy:

Zusammengehörigkeiten von HTMLPurifier_HTMLModule_Tidy:

Öffentliche Methoden
	setup ($config)
	getFixesForLevel ($level)
	makeFixesForLevel ($fixes)
	populate ($fixes)
	getFixType ($name)
	makeFixes ()
Öffentliche Methoden geerbt von HTMLPurifier_HTMLModule
	getChildDef ($def)
	addElement ($element, $type, $contents, $attr_includes=array(), $attr=array())
	addBlankElement ($element)
	addElementToContentSet ($element, $type)
	parseContents ($contents)
	mergeInAttrIncludes (&$attr, $attr_includes)
	makeLookup ($list)
	setup ($config)

Datenfelder
	$levels = array(0 => 'none', 'light', 'medium', 'heavy')
	$defaultLevel = null
	$fixesForLevel
Datenfelder geerbt von HTMLPurifier_HTMLModule
	$name
	$elements = array()
	$info = array()
	$content_sets = array()
	$attr_collections = array()
	$info_tag_transform = array()
	$info_attr_transform_pre = array()
	$info_attr_transform_post = array()
	$info_injector = array()
	$defines_child_def = false
	$safe = true

Ausführliche Beschreibung

Abstract class for a set of proprietary modules that clean up (tidy) poorly written HTML.

Noch zu erledigen:

Figure out how to protect some of these methods/properties

Definiert in Zeile 8 der Datei Tidy.php.

Dokumentation der Elementfunktionen

getFixesForLevel

(

$level)

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

Parameter

string

$level

level identifier, see $levels for valid values

Rückgabe

array Lookup up table of fixes

Definiert in Zeile 75 der Datei Tidy.php.

Wird benutzt von setup().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

getFixType

(

$name)

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

Parameter

$name

String name of fix

Rückgabe

array(string $fix_type, array $fix_parameters)

Zu beachten

$fix_parameters is type dependant, see populate() for usage of these parameters

Definiert in Zeile 182 der Datei Tidy.php.

Benutzt HTMLPurifier_HTMLModule\$name.

Wird benutzt von populate().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

makeFixes

(

)

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

Rückgabe

array

Definiert in Zeile 225 der Datei Tidy.php.

Wird benutzt von setup().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

makeFixesForLevel

(

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

Parameter

array

$fixes

Definiert in Zeile 109 der Datei Tidy.php.

Benutzt $defaultLevel.

Wird benutzt von setup().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

populate

(

$fixes)

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

Parameter

array

$fixes

Lookup table of fixes to activate

Definiert in Zeile 129 der Datei Tidy.php.

Benutzt HTMLPurifier_HTMLModule\$name, HTMLPurifier_HTMLModule\addBlankElement() und getFixType().

Wird benutzt von setup().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

setup

(

$config)

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

Parameter

HTMLPurifier_Config

$config

Noch zu erledigen:

Wildcard matching and error reporting when an added or subtracted fix has no effect.

Definiert in Zeile 43 der Datei Tidy.php.

Benutzt HTMLPurifier_HTMLModule\$name, getFixesForLevel(), makeFixes(), makeFixesForLevel() und populate().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Dokumentation der Datenelemente

$defaultLevel = null

Default level to place all fixes in. Disabled by default. string

Definiert in Zeile 22 der Datei Tidy.php.

Wird benutzt von makeFixesForLevel().

$fixesForLevel

Initialisierung:

= array(
        'light' => array(),
        'medium' => array(),
        'heavy' => array()
    )

Lists of fixes used by getFixesForLevel(). Format is: HTMLModule_Tidy->fixesForLevel[$level] = array('fix-1', 'fix-2'); array

Definiert in Zeile 30 der Datei Tidy.php.

$levels = array(0 => 'none', 'light', 'medium', 'heavy')

List of supported levels. Index zero is a special case "no fixes" level. array

Definiert in Zeile 15 der Datei Tidy.php.

---

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

• HTMLPurifier/HTMLModule/Tidy.php