[mapserver-commits] r8267 - trunk/docs/mapscript/php

[svn at osgeo.org]

Author: aboudreault
Date: 2008-12-19 10:46:13 -0500 (Fri, 19 Dec 2008)
New Revision: 8267

Modified:
   trunk/docs/mapscript/php/index.txt
Log:
Added hashTableObj in php documentation


Modified: trunk/docs/mapscript/php/index.txt
===================================================================
--- trunk/docs/mapscript/php/index.txt	2008-12-19 15:21:43 UTC (rev 8266)
+++ trunk/docs/mapscript/php/index.txt	2008-12-19 15:46:13 UTC (rev 8267)
@@ -696,6 +696,7 @@
 int             num_processing
 string          requires
 string          labelrequires
+hashTableObj    metadata
 =============== ====================================================================
 
 
@@ -996,6 +997,7 @@
 int             numstyles
 string          keyimage   
 string          group
+hashTableObj    metadata
 =============== ====================================================================
 
 Methods
@@ -1262,6 +1264,7 @@
 string          queryformat
 string          legendformat
 string          browseformat
+hashTableObj    metadata
 =============== ====================================================================
 
 Methods
@@ -2307,3 +2310,39 @@
 string getvaluebyname(string name)
     Return the value associated with the parameter *name*.
 
+
+hashTableObj Class
+-------------------------
+
+Constructor
+...............................................................................
+
+Instance of hashTableObj is always embedded inside the LayerObj, WebObj 
+and ClassObj. It is uses a read only.
+
+.. code-block:: php 
+
+    $hashTable = $oLayer->metadata;
+    $key = null;
+    while ($key = $hashTable->nextkey($key))
+        echo "Key: ".$key." value: ".$hashTable->get($key)."<br/>";
+
+Methods
+...............................................................................
+
+string get(string key)
+    Fetch class metadata entry by name.  Returns "" if no entry 
+    matches the name.  Note that the search is case sensitive.
+
+int set(string key, string value)
+    Set a metadata entry in the hashTable. Returns MS_SUCCESS/MS_FAILURE.
+     
+int  remove(string key)
+    Remove a metadata entry in the hashTable.  Returns MS_SUCCESS/MS_FAILURE.
+
+void clear()
+    Clear all items in the hashTable (To NULL).
+
+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