XOOPS 2.5.6  Final
 All Classes Namespaces Files Functions Variables Pages
Public Member Functions | Public Attributes | Protected Member Functions | List of all members
HTMLPurifier_StringHashParser Class Reference

Public Member Functions

 parseFile ($file)
 
 parseMultiFile ($file)
 

Public Attributes

 $default = 'ID'
 

Protected Member Functions

 parseHandle ($fh)
 

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.

References $file, $ret, and parseHandle().

Here is the call graph for this function:

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
$fhFile handle with pointer at start of valid string-hash block.

Definition at line 68 of file StringHashParser.php.

References $default, and $ret.

Referenced by parseFile(), and parseMultiFile().

Here is the caller graph for this function:

HTMLPurifier_StringHashParser::parseMultiFile (   $file)

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

Definition at line 48 of file StringHashParser.php.

References $file, $ret, and parseHandle().

Here is the call graph for this function:

Member Data Documentation

HTMLPurifier_StringHashParser::$default = 'ID'

Definition at line 31 of file StringHashParser.php.

Referenced by parseHandle().

The documentation for this class was generated from the following file: