[mapserver-commits] r9746 - trunk/docs/en/mapscript/php

[svn at osgeo.org]

Author: aboudreault
Date: 2010-01-25 12:19:48 -0500 (Mon, 25 Jan 2010)
New Revision: 9746

Modified:
   trunk/docs/en/mapscript/php/index.txt
Log:
Added labelcachemember object documentation

Modified: trunk/docs/en/mapscript/php/index.txt
===================================================================
--- trunk/docs/en/mapscript/php/index.txt	2010-01-25 16:52:57 UTC (rev 9745)
+++ trunk/docs/en/mapscript/php/index.txt	2010-01-25 17:19:48 UTC (rev 9746)
@@ -296,6 +296,17 @@
 int drawLabelCache(imageObj image)
     Renders the labels for a map. Returns -1 on error.
 
+labelcacheMemberObj getLabel(int index)
+    Returns a labelcacheMemberObj from the map given an index value (0=first label)
+    Labelcache have to be enabled.
+
+.. code-block:: php
+
+    while ($oLabelCacheMember = $oMap->getLabel($i)) {
+    /* do something with the labelcachemember */
+    ++$i;
+    }
+
 layerObj getLayer(int index)
     Returns a layerObj from the map given an index value (0=first layer)
 
@@ -2210,6 +2221,33 @@
 
 
 
+LabelcacheMemberObj Class
+--------------------
+
+Accessible only through the map object (map->getLabel()).
+
+Members
+...............................................................................
+
+=============== ====================================================================
+Type                Name
+=============== ====================================================================
+int             classindex (Read-Only)
+int             featuresize (Read-Only)
+int             layerindex (Read-Only)
+int             numstyles (Read-Only)
+int             shapeindex (Read-Only)
+int             status (Read-Only)
+string          text (Read-Only)
+int             tileindex (Read-Only)
+=============== ====================================================================
+
+Method
+...............................................................................
+
+None
+
+
 SymbolObj Class
 ----------------