OMV\Util\KeyValueFile Class Reference

Public Member Functions
	__construct ($filename, $keyValueDelimiter="=", $keyNameDelimiter="_", $commentDelimiter="#")
	setKeyNameDelimiter ($char)
	setKeyValueDelimiter ($char)
	setCommentDelimiter ($char)
	setKeyCaseSensitiv ($caseSensitive)
	exists ($key)
	get ($key)
	getAssoc ()

Constructor & Destructor Documentation

__construct()

OMV\Util\KeyValueFile::__construct	(		$filename,
			$keyValueDelimiter = "=",
			$keyNameDelimiter = "_",
			$commentDelimiter = "#"
	)

Constructor

Parameters

string	$filename	Path to the file.
string	$keyValueDelimiter	The key/value delimiter. Defaults to '='.
string	$keyNameDelimiter	The delimiter that is used to replace white spaces within the key name. Defaults to '_'.
string	$commentDelimiter	The comment line delimiter. Defaults to '#'.

Member Function Documentation

exists()

OMV\Util\KeyValueFile::exists (   $key )

final

Check whether the specified key exists.

Parameters

string

$key

The name of the key.

Returns

Returns TRUE if the key exists, otherwise FALSE.

get()

OMV\Util\KeyValueFile::get (   $key )

final

Get the value of the given key.

Parameters

string

$key

The name of the key.

Returns

The value of the given key.

getAssoc()

OMV\Util\KeyValueFile::getAssoc ( )

final

Get the key/value pairs as associative array.

Returns

The array of key/value pairs.

setKeyCaseSensitiv()

OMV\Util\KeyValueFile::setKeyCaseSensitiv (   $caseSensitive )

final

Specifies whether case-sensitive key matching should be used.

Parameters

caseSensitive

TRUE for case-sensitive matching.

Returns

None.

---

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

• keyvaluefile.inc