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.
Methods | ||||
---|---|---|---|---|
public
|
parseFile(string $file): array
Parses a file that contains a single string-hash.
Parses a file that contains a single string-hash. |
# | ||
public
|
parseMultiFile(string $file): array
Parses a file that contains multiple string-hashes delimited by '----'
Parses a file that contains multiple string-hashes delimited by '----' |
# | ||
protected
|
parseHandle(resource $fh): array
Internal parser that acepts a file handle.
Internal parser that acepts a file handle. Parameters
|
# |
Properties | |||
---|---|---|---|
public
|
|
$default = 'ID'
|
# |