HTMLPurifier_StringHashParser Klassenreferenz

Öffentliche Methoden
	parseFile ($file)
	parseMultiFile ($file)

Datenfelder
	$default = 'ID'

Geschützte Methoden
	parseHandle ($fh)

Ausführliche Beschreibung

Parses string hash files. File format is as such:

 DefaultKeyValue
 KEY: Value
 KEY2: Value2
 --MULTILINE-KEY--
 Multiline
 value.

Which would output something similar to:

 array(
     'ID' => 'DefaultKeyValue',
     'KEY' => 'Value',
     'KEY2' => 'Value2',
     'MULTILINE-KEY' => "Multiline\nvalue.\n",
 )

We use this as an easy to use file-format for configuration schema files, but the class itself is usage agnostic.

You can use -— to forcibly terminate parsing of a single string-hash; this marker is used in multi string-hashes to delimit boundaries.

Definiert in Zeile 28 der Datei StringHashParser.php.

Dokumentation der Elementfunktionen

parseFile

(

$file)

Parses a file that contains a single string-hash.

Parameter

string

$file

Rückgabe

array

Definiert in Zeile 41 der Datei StringHashParser.php.

Benutzt parseHandle().

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

parseHandle (   $fh)

protected

Internal parser that acepts a file handle.

Zu beachten

While it's possible to simulate in-memory parsing by using custom stream wrappers, if such a use-case arises we should factor out the file handle into its own class.

Parameter

resource

$fh

File handle with pointer at start of valid string-hash block.

Rückgabe

array

Definiert in Zeile 86 der Datei StringHashParser.php.

Benutzt $default.

Wird benutzt von parseFile() und parseMultiFile().

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

parseMultiFile

(

$file)

Parses a file that contains multiple string-hashes delimited by '-—'

Parameter

string

$file

Rückgabe

array

Definiert in Zeile 60 der Datei StringHashParser.php.

Benutzt parseHandle().

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

Dokumentation der Datenelemente

$default = 'ID'

string

Definiert in Zeile 34 der Datei StringHashParser.php.

Wird benutzt von parseHandle().

---

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

• HTMLPurifier/StringHashParser.php