Référence de la classe HTMLPurifier_StringHashParser

Fonctions membres publiques
	parseFile ($file)
	parseMultiFile ($file)

Champs de données
	$default = 'ID'

Fonctions membres protégées
	parseHandle ($fh)

Description détaillée

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.

Documentation des fonctions membres

parseFile()

parseFile

(

$file

)

Parses a file that contains a single string-hash.

Paramètres

string

$file

Renvoie

array

Voici le graphe d'appel pour cette fonction :

parseHandle()

parseHandle (   $fh )

protected

Internal parser that acepts a file handle.

Note

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.

Paramètres

resource

$fh

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

Renvoie

array

Voici le graphe des appelants de cette fonction :

parseMultiFile()

parseMultiFile

(

$file

)

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

Paramètres

string

$file

Renvoie

array

Voici le graphe d'appel pour cette fonction :

Documentation des champs

$default

$default = 'ID'

@type string

---

La documentation de cette classe a été générée à partir du fichier suivant :

• XoopsCore25-2.5.11-Beta1/htdocs/xoops_lib/modules/protector/library/HTMLPurifier/StringHashParser.php