Docs For Class HTMLPurifier

Class HTMLPurifier_StringHashParser

Description

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.

Variable Summary

mixed $default

Method Summary

void parseFile ( $file)

void parseHandle ($fh $fh)

void parseMultiFile ( $file)

Variables

mixed $default = 'ID' (line 6499)

Methods

parseFile (line 6504)

Parses a file that contains a single string-hash.

void parseFile ( $file)

parseHandle (line 6536)

Internal parser that acepts a file handle.

void parseHandle ($fh $fh)

parseMultiFile (line 6516)

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

void parseMultiFile ( $file)

Documentation generated on Sun, 06 Mar 2011 00:24:10 -0500 by phpDocumentor 1.4.3