hashTableObj

final class hashTableObj (View source)

Instance of hashTableObj is always embedded inside the classObj, layerObj, mapObj and webObj. It is uses a read only.

$hashTable = $oLayer->metadata; $key = null; while ($key = $hashTable->nextkey($key)) echo "Key: ".$key." value: ".$hashTable->get($key)."
";

Methods

void
clear()

Clear all items in the hashTable (To NULL).

string
get(string $key)

Fetch class metadata entry by name. Returns "" if no entry matches the name. Note that the search is case sensitive.

string
nextkey(string $previousKey)

Return the next key or first key if previousKey = NULL.

int
remove(string $key)

Remove a metadata entry in the hashTable. Returns MS_SUCCESS/MS_FAILURE.

int
set(string $key, string $value)

Set a metadata entry in the hashTable. Returns MS_SUCCESS/MS_FAILURE.

Details

at line 745
final void clear()

Clear all items in the hashTable (To NULL).

Return Value

void

at line 754
final string get(string $key)

Fetch class metadata entry by name. Returns "" if no entry matches the name. Note that the search is case sensitive.

Parameters

string $key

Return Value

string

at line 764
final string nextkey(string $previousKey)

Return the next key or first key if previousKey = NULL.

Return NULL if no item is in the hashTable or end of hashTable is reached

Parameters

string $previousKey

Return Value

string

at line 772
final int remove(string $key)

Remove a metadata entry in the hashTable. Returns MS_SUCCESS/MS_FAILURE.

Parameters

string $key

Return Value

int

at line 781
final int set(string $key, string $value)

Set a metadata entry in the hashTable. Returns MS_SUCCESS/MS_FAILURE.

Parameters

string $key
string $value

Return Value

int