Parses string hash files. More...

Public Member Functions
	parseFile ($file)
	Parses a file that contains a single string-hash.
	parseMultiFile ($file)
	Parses a file that contains multiple string-hashes delimited by '----'.
	parseFile ($file)
	Parses a file that contains a single string-hash.
	parseMultiFile ($file)
	Parses a file that contains multiple string-hashes delimited by '----'.
Public Attributes
	$default = 'ID'
Protected Member Functions
	parseHandle ($fh)
	Internal parser that acepts a file handle.
	parseHandle ($fh)
	Internal parser that acepts a file handle.

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

Definition at line 28 of file StringHashParser.php.

Member Function Documentation

HTMLPurifier_StringHashParser::parseFile ( $ file )

Parses a file that contains a single string-hash.

Definition at line 36 of file StringHashParser.php.

HTMLPurifier_StringHashParser::parseFile ( $ file )

Parses a file that contains a single string-hash.

HTMLPurifier_StringHashParser::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.

Parameters:

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

HTMLPurifier_StringHashParser::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.

Parameters: