HTMLPurifier_StringHashParser Class Reference

Parses string hash files. More...

Collaboration diagram for HTMLPurifier_StringHashParser:

Public Member Functions
	parseFile ($file)
	Parses a file that contains a single string-hash. More...
	parseMultiFile ($file)
	Parses a file that contains multiple string-hashes delimited by '-—'. More...

Data Fields
	$default = 'ID'
	@type string More...

Protected Member Functions
	parseHandle ($fh)
	Internal parser that acepts a file handle. More...

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

parseFile()

HTMLPurifier_StringHashParser::parseFile

(

$file

)

Parses a file that contains a single string-hash.

Parameters

string

$file

Returns

array

Definition at line 41 of file StringHashParser.php.

    {
        if (!file_exists($file)) {
            return false;
        }
        $fh = fopen($file, 'r');
        if (!$fh) {
            return false;
        }
        $ret = $this->parseHandle($fh);
        fclose($fh);
        return $ret;
    }

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

Here is the call graph for this function:

parseHandle()

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

resource

$fh

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

Returns

array

Definition at line 86 of file StringHashParser.php.

    {
        $state   = false;
        $single  = false;
        $ret     = array();
        do {
            $line = fgets($fh);
            if ($line === false) {
                break;
            }
            $line = rtrim($line, "\n\r");
            if (!$state && $line === '') {
                continue;
            }
            if ($line === '----') {
                break;
            }
            if (strncmp('--#', $line, 3) === 0) {
                // Comment
                continue;
            } elseif (strncmp('--', $line, 2) === 0) {
                // Multiline declaration
                $state = trim($line, '- ');
                if (!isset($ret[$state])) {
                    $ret[$state] = '';
                }
                continue;
            } elseif (!$state) {
                $single = true;
                if (strpos($line, ':') !== false) {
                    // Single-line declaration
                    list($state, $line) = explode(':', $line, 2);
                    $line = trim($line);
                } else {
                    // Use default declaration
                    $state  = $this->default;
                }
            }
            if ($single) {
                $ret[$state] = $line;
                $single = false;
                $state  = false;
            } else {
                $ret[$state] .= "$line\n";
            }
        } while (!feof($fh));
        return $ret;
    }

References $default, and $ret.

Referenced by parseFile(), and parseMultiFile().

Here is the caller graph for this function:

parseMultiFile()

HTMLPurifier_StringHashParser::parseMultiFile

(

$file

)

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

Parameters

string

$file

Returns

array

Definition at line 60 of file StringHashParser.php.

    {
        if (!file_exists($file)) {
            return false;
        }
        $ret = array();
        $fh = fopen($file, 'r');
        if (!$fh) {
            return false;
        }
        while (!feof($fh)) {
            $ret[] = $this->parseHandle($fh);
        }
        fclose($fh);
        return $ret;
    }

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

Here is the call graph for this function:

Field Documentation

$default

HTMLPurifier_StringHashParser::$default = 'ID'

@type string

Definition at line 34 of file StringHashParser.php.

Referenced by parseHandle().

---

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

• Services/Html/HtmlPurifier/library/HTMLPurifier/StringHashParser.php