spunQ_HierarchicalConfigFile Class Reference

A config file that uses a hierarchical layout. More...

List of all members.

Static Public Member Functions
static	get ($path)
	Factory method.
Protected Member Functions
	fillCacheWithoutCacheFile ()

---

Detailed Description

A config file that uses a hierarchical layout.

The config values are stored as key=value pairs, seperated by newlines. Both the key and the value will be trimmed. Indenting a line with a tab character (ASCII #11) causes the key above that line to be prepended to the key with a dot as a separator. This allows conveniently storing hierarchical keys. Lines starting with a hash character and empty lines are ignored. Example:

• File:
  |# Comment |key1 = value1 | 2 = value1.2
• Added key/value pairs:
  |'key1' => 'value1'
|'key1.2' => 'value1.2'

The contents of the file will be cached transparently.

Definition at line 24 of file HierarchicalConfigFile.class.php.

---

Member Function Documentation

static spunQ_HierarchicalConfigFile::get

(

$

path

)

[static]

Factory method.

Creates an object that will operate on the given path.

Parameters:

$path

A string describing a path on the file system

Returns:

spunQ_HierarchicalConfigFile

Definition at line 32 of file HierarchicalConfigFile.class.php.

---

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

• HierarchicalConfigFile.class.php