PHP/MapScript Mapserver Module
                    ==============================

$Id: README 7251 2008-01-08 17:04:53Z Assefa $
                      --------------------------

This is a PHP module to make MapServer's MapScript functionalities 
available in a PHP Dynamically Loadable Library.  

PHP MapScript was originally developed for PHP-3.0.14 but after MapServer
3.5 support for PHP3 has been dropped and as of the last update of this
document, PHP 4.1.2 or more recent was required.

The module has been tested and used on Linux, Solaris, *BSD, and WinNT.

There are documentation and examples for PHP MapScript available via
the MapServer documentation webpage at:
  http://mapserver.gis.umn.edu/doc.html

See also the MapServer Wiki for links to more informations on this module:
  http://mapserver.gis.umn.edu/cgi-bin/wiki.pl?PHPMapScript

                      --------------------------

Currently supported classes, properties and methods:
====================================================

  Very important notes:
  ---------------------

  - Constant names and class member variable names are case-sensitive in PHP.

  - Several MapScript functions (all those that access files in the back end
    such as ms_newMapObj(), drawMap(), etc) will affect the value of the 
    current working directory (CWD) in the PHP environment. This will be 
    fixed eventually but in the meantime you should be careful about these 
    side-effects.


  Constants:
  ----------
  The following MapServer constants are available:

    Boolean values:
    MS_TRUE, MS_FALSE, MS_ON, MS_OFF, MS_YES, MS_NO

    Map units:
    MS_INCHES, MS_FEET, MS_MILES, MS_METERS, MS_KILOMETERS, MS_DD,
        MS_PIXELS

    Layer types:
        MS_LAYER_POINT, MS_LAYER_LINE, MS_LAYER_POLYGON, 
        MS_LAYER_RASTER, MS_LAYER_ANNOTATION, MS_LAYER_QUERY,
        MS_LAYER_CIRCLE, MS_LAYER_TILEINDEX, MS_LAYER_CHART

    Layer/Legend/Scalebar/Class Status:
        MS_ON, MS_OFF, MS_DEFAULT, MS_EMBED, MS_DELETE

    Layer alpha transparency : allows alpha transparent pixmaps 
    to be used with RGB map images
        MS_GD_ALPHA
    
    Font types:
        MS_TRUETYPE, MS_BITMAP

    Label positions:
        MS_UL, MS_LR, MS_UR, MS_LL, MS_CR, MS_CL, MS_UC, MS_LC,
        MS_CC, MS_AUTO, MS_XY, MS_FOLLOW

    Bitmap font styles:
        MS_TINY , MS_SMALL, MS_MEDIUM, MS_LARGE, MS_GIANT

    Shape types:
        MS_SHAPE_POINT, MS_SHAPE_LINE, MS_SHAPE_POLYGON, MS_SHAPE_NULL

    Shapefile types:
        MS_SHP_POINT, MS_SHP_ARC, MS_SHP_POLYGON, MS_SHP_MULTIPOINT

    Query/join types:
        MS_SINGLE, MS_MULTIPLE

    Querymap styles:
        MS_NORMAL, MS_HILITE, MS_SELECTED

    Connection Types:
        MS_INLINE, MS_SHAPEFILE, MS_TILED_SHAPEFILE, MS_SDE, MS_OGR, 
        MS_TILED_OGR, MS_POSTGIS, MS_WMS, MS_ORACLESPATIAL, MS_WFS,
        MS_GRATICULE, MS_MYGIS

    Error codes:
        MS_NOERR, MS_IOERR, MS_MEMERR, MS_TYPEERR, MS_SYMERR, 
        MS_REGEXERR, MS_TTFERR, MS_DBFERR, MS_GDERR, MS_IDENTERR, 
        MS_EOFERR, MS_PROJERR, MS_MISCERR, MS_CGIERR, MS_WEBERR, 
        MS_IMGERR, MS_HASHERR, MS_JOINERR, MS_NOTFOUND, MS_SHPERR, 
        MS_PARSEERR, MS_SDEERR, MS_OGRERR, MS_QUERYERR, MS_WMSERR, 
        MS_WMSCONNERR, MS_ORACLESPATIALERR, MS_WFSERR, MS_WFSCONNERR, 
        MS_MAPCONTEXTERR, MS_HTTPERR, MS_WCSERR

    Symbol types:
        MS_SYMBOL_SIMPLE,  MS_SYMBOL_VECTOR, MS_SYMBOL_ELLIPSE,
        MS_SYMBOL_PIXMAP, MS_SYMBOL_TRUETYPE, MS_SYMBOL_CARTOLINE

    Image Mode types (outputFormatObj):

        MS_IMAGEMODE_PC256, MS_IMAGEMODE_RGB, MS_IMAGEMODE_RGBA, 
        MS_IMAGEMODE_INT16, MS_IMAGEMODE_FLOAT32, MS_IMAGEMODE_BYTE, 
        MS_IMAGEMODE_NULL

    Style/Attribue binding
        MS_STYLE_BINDING_SIZE,  MS_STYLE_BINDING_ANGLE, MS_STYLE_BINDING_COLOR,
        MS_STYLE_BINDING_OUTLINECOLOR, MS_STYLE_BINDING_SYMBOL

    Label/Attribute binding
        MS_LABEL_BINDING_SIZE, MS_LABEL_BINDING_ANGLE, MS_LABEL_BINDING_COLOR,
        MS_LABEL_BINDING_OUTLINECOLOR, MS_LABEL_BINDING_FONT, 
        MS_LABEL_BINDING_PRIORITY 

 Functions:
 ----------

   string ms_GetVersion()
        Returns the MapServer version and options in a string.  This string
        can be parsed to find out which modules were compiled in, etc.

   int ms_GetVersionInt()
        Returns the MapServer version number (x.y.z) as an integer 
        (x*10000 + y*100 + z). (New in v5.0) e.g. V5.4.3 would return 50403.

   array ms_TokenizeMap(string map_file_name)
        Preparses a mapfile through the MapServer parser and return an 
        array with one item for each token from the mapfile.  Strings, 
        logical expressions, regex expressions and comments are returned
        as individual tokens.

   void ms_ioinstallstdouttobuffer()
       Installs a mapserver IO handler directing future stdout output 
       to a memory buffer. 

   void ms_ioinstallstdinfrombuffer()
      Installs a mapserver IO handler directing future stdin reading 
      (ie. post request capture) to come from a buffer. 

   void ms_iogetstdoutbufferstring()
      Fetch the current stdout buffer contents as a string.  This method 
      does not clear the buffer.

    int ms_iogetStdoutBufferBytes() 
       Writes the current buffer to stdout.  The PHP header() function should be 
       used to set the documents's content-type prior to calling the function.
       Returns the number of bytes written if output is sent to stdout.  
       See http://mapserver.gis.umn.edu/docs/howto/wxs_mapscript/view for
       more info.

   void ms_ioresethandlers()   
     Resets the default stdin and stdout handlers in place of "buffer" based
     handlers. 
     
   void ms_iostripstdoutbuffercontenttype()
     Strip the Content-type header off the stdout buffer if it has one, and
     if a content type is found it is return. Otherwise return false.

 MapObj Class:
 -------------

 Constructor:

   mapObj ms_newMapObj(string map_file_name [, string new_map_path])
        Returns a new object to deal with a MapServer map file.

        By default, the SYMBOLSET, FONTSET, and other paths in the mapfile
        are relative to the mapfile location.  If new_map_path is provided
        then this directory will be used as the base path for all the 
        relative paths inside the mapfile.

 Members:

   int          numlayers  (read-only)
   string       name
   int          status
   int          debug
   int          width           (see setSize())
   int          height          (see setSize())
   int          maxsize
   outputformatObj outputformat
   double       resolution      (pixels per inch, defaults to 72)
   rectObj      extent; 
   double       cellsize
   int          units (map units type)
   double       scaledenom (read-only, set by drawMap())
   double       scale      (Deprecated in v5.0. Use scaledenom instead)
   string       shapepath
   int          keysizex
   int          keysizey
   int          keyspacingx
   int          keyspacingy
   webObj       web
   referenceMapObj reference
   colorObj     imagecolor
   scalebarObj  scalebar
   legendObj    legend                  
   string       symbolsetfilename (read-only, set by setSymbolSet())
   string       fontsetfilename (read-only, set by setFontSet())
   labelcacheObj labelcache (no members. Used only to be able to free the
                             the label cache (ex : map->labelcache->free())
   int          transparent   (deprecated, use outputFormatObj)
   int          interlace     (deprecated, use outputFormatObj)
   int          imagetype     (deprecated, use outputFormatObj)
   int          imagequality  (deprecated, use outputFormatObj)
          
 Methods:

   mapObj clone()
        Returns a handle to a new mapObj which is a clone of the current
        mapObj.  All parameters in the current mapObj are copied to the
        new mapObj.  Returns NULL (0) on error.

   int set(string property_name, new_value)
        Set map object property to new value. Returns -1 on error.

   int getsymbolbyname(string symbol_name)  
        Returns the symbol index using the name.

   symbol getsymbolobjectbyid(int symbolid)
        Returns the symbol object using a symbol id. Refer to
        the symbol object reference section for more details.

   void preparequery()
        Calculate the scale of the map and set map->scaledenom.
             
   imageObj prepareImage()
        Return handle on blank image object.

   imageObj draw()
        Render map and return handle on image object.

   imageObj drawQuery()
        Render a query map and return handle on image object.

   imageObj drawLegend()
        Render legend and return handle on image object.

   imageObj drawReferenceMap()
        Render reference map and return handle on image object.

   imageObj drawScaleBar()
        Render scale bar and return handle on image object.

   int embedlegend(imageObj image) 
        embeds a legend. Actually the legend is just added to the label 
        cache so you must invoke drawLabelCache() to actually do the 
        rendering (unless postlabelcache is set in which case it is 
        drawn right away).

   int embedScalebar(imageObj image) 
        embeds a scalebar. Actually the scalebar is just added to the label 
        cache so you must invoke drawLabelCache() to actually do the rendering 
        (unless postlabelcache is set in which case it is drawn right away).

   int drawLabelCache(imageObj image)
        Renders the labels for a map. Returns -1 on error.

   layerObj getLayer(int index)
        Returns a layerObj from the map given an index value (0=first layer)

   layerObj getLayerByName(string layer_name)
        Returns a layerObj from the map given a layer name.  
        Returns FALSE if layer doesn't exist.

   colorObj getcolorbyindex(int iCloIndex)
    Returns a colorObj corresponding to the color index in the palette

   void setExtent(double minx, double miny, double maxx, double maxy)
    Set the map extents using the georef extents passed in argument.

   int setRotation(double rotation_angle)
        Set map rotation angle. The map view rectangle (specified in 
        EXTENTS) will be rotated by the indicated angle in the counter-
        clockwise direction. Note that this implies the rendered map 
        will be rotated by the angle in the clockwise direction.
        Returns MS_SUCCESS or MS_FAILURE.

   int setSize(int width, int height)
        Set the map width and height. This method updates the internal
        geotransform and other data structures required for map rotation
        so it should be used instead of setting the width and height members
        directly.
        Returns MS_SUCCESS or MS_FAILURE.

   void zoompoint(int nZoomFactor, pointObj oPixelPos, int nImageWidth, 
                  int nImageHeight, rectObj oGeorefExt)

    Zoom to a given XY postion;

    Parmeters are :                                                 
       - Zoom factor : positive values do zoom in, negative values  
                      zoom out. Factor of 1 will recenter.           
       - Pixel position (pointObj) : x, y coordinates of the click, 
                                     with (0,0) at the top-left
       - Width : width in pixel of the current image.                 
       - Height : Height in pixel of the current image.               
       - Georef extent (rectObj) : current georef extents.            
       - MaxGeoref extent (rectObj) : (optional) maximum georef extents.
         If provided then it will be impossible to zoom/pan outside of
         those extents.

   void zoomrectangle(rectObj oPixelExt, int nImageWidth, int nImageHeight,
             rectObj oGeorefExt)
    Set the map extents to a given extents.
    
    Parmeters are :
    - oPixelExt (rect object) : Pixel Extents, with (0,0) at the top-left
          The rectangle contains the coordinates of the LL and UR coordinates
          in pixel. (the maxy in the rect object should be < miny value)
          
          ------- UR (values in the rect object : maxx, maxy)
          |     | 
          |     |
          |     |
          ------
        LL (values in the rectobject minx, miny)                      
         
        - Width : width in pixel of the current image.
        - Height : Height in pixel of the current image. 
        - Georef extent (rectObj) : current georef extents.

   void zoomscale(double nScaleDenom, pointObj oPixelPos, int nImageWidth, 
                  int nImageHeight, rectObj oGeorefExt [, rectObj oMaxGeorefExt])

    Zoom in or out to a given XY position so that the map is displayed
        at specified scale.

    Parmeters are :                                                 
       - ScaleDenom : Scale denominator of the scale at which the map 
                      should be displayed.
       - Pixel position (pointObj) : x, y coordinates of the click, 
                                     with (0,0) at the top-left
       - Width : width in pixel of the current image.                 
       - Height : Height in pixel of the current image.               
       - Georef extent (rectObj) : current georef extents.            
       - MaxGeoref extent (rectObj) : (optional) maximum georef extents.
         If provided then it will be impossible to zoom/pan outside of
         those extents.

   int queryByPoint(pointObj point, int mode, double buffer)
        Query all selected layers in map at point location specified in 
        georeferenced map coordinates (i.e. not pixels).  
        The query is performed on all the shapes that are part of a CLASS 
        that contains a TEMPLATE value or that match any class in a
        layer that contains a LAYER TEMPLATE value.
        Mode is MS_SINGLE or MS_MULTIPLE depending on number of results
        you want. 
        Passing buffer <=0 defaults to tolerances set in the map file 
        (in pixels) but you can use a constant buffer (specified in 
        ground units) instead.
        Returns MS_SUCCESS if shapes were found or MS_FAILURE if nothing
        was found or if some other error happened (note that the error 
        message in case nothing was found can be avoided in PHP using 
        the '@' control operator).

   int queryByRect(rectObj rect)
        Query all selected layers in map using a rectangle specified in 
        georeferenced map coordinates (i.e. not pixels).
        The query is performed on all the shapes that are part of a CLASS 
        that contains a TEMPLATE value or that match any class in a
        layer that contains a LAYER TEMPLATE value.
        Returns MS_SUCCESS if shapes were found or MS_FAILURE if nothing
        was found or if some other error happened (note that the error 
        message in case nothing was found can be avoided in PHP using 
        the '@' control operator).

   int queryByShape(shapeObj shape)
        Query all selected layers in map based on a single shape, the 
        shape has to be a polygon at this point.
        Returns MS_SUCCESS if shapes were found or MS_FAILURE if nothing
        was found or if some other error happened (note that the error 
        message in case nothing was found can be avoided in PHP using 
        the '@' control operator).

   int queryByFeatures(int slayer) 
        Perform a query based on a previous set of results from
        a layer. At present the results MUST be based on a polygon layer.
        Returns MS_SUCCESS if shapes were found or MS_FAILURE if nothing
        was found or if some other error happened (note that the error 
        message in case nothing was found can be avoided in PHP using 
        the '@' control operator).

   int queryByIndex(layerindex, tileindex, shapeindex, addtoquery)
        Add a specific shape on a given layer to the query result.
        If addtoquery (which is a non mandatory argument) is set to MS_TRUE,
        the shape will be added to the existing query list. Default behavaior
        is to free the existing query list and add only the new shape.

   int savequery(filename)
        Save the current query in a file. Returns MS_SUCESS or MS_FAILURE.
        Can be used with loadquery

   int loadquery(filename)
        Loads a query from a file. Returns MS_SUCESS or MS_FAILURE.
        To be used with savequery.

   void freequery(layerindex)
        Frees the query result on a specified layer. If the layerindex is -1,
        all queries on layers will be freed.

   int save(string filename)
        Save current map object state to a file. Returns -1 on error.
        Use absolute path. If a relative path is used, then it will be 
        relative to the mapfile location.

   string getProjection()
        Returns a string represenation of the projection. If no 
        projection is set, MS_FALSE is returned.

   int setProjection(string proj_params, boolean bSetUnitsAndExtents)
        Set map projection and coordinate system.  Parameters are given as 
        a single string of comma-delimited PROJ.4 parameters.
        The argument : bSetUnitsAndExtents is used to automatically update
        the map units and extents based on the new projection. Possible 
        values are MS_TRUE and MS_FALSE. By defualt it is set at MS_FALSE

   int setWKTProjection(string proj_params, boolean bSetUnitsAndExtents)
        Same as setProjection(), but takes an OGC WKT projection 
        definition string as input.

   int getMetaData(string name)
        Fetch metadata entry by name (stored in the WEB object in the map
        file).  Returns "" if no entry matches the name.  Note that the
        search is case sensitive.

   int setMetaData(string name, string value)
        Set a metadata entry for the map (stored in the WEB object in the map
        file).  Returns MS_SUCCESS/MS_FAILURE.

   int removeMetaData(string name)
        Remove a metadata entry for the map (stored in the WEB object in the map
        file).  Returns MS_SUCCESS/MS_FAILURE.

   array getLayersIndexByGroup(string groupname)
        Return an array containing all the layer's indexes given
        a group name.

   array getAllGroupNames()
        Return an array containing all the group names used in the
        layers.  

   array getAllLayerNames()
        Return an array containing all the layer names.

   boolean moveLayerUp(int layerindex)
        Move layer up in the hierarcy of drawing. 

   boolean moveLayerDown(int layerindex)
        Move layer down in the hierarcy of drawing.

   array   getlayersdrawingorder()
        Return an array containing layer's index in the order which they
        are drawn.

   boolean  setlayersdrawingorder(array layeryindex)
        Set the layer's order array. The argument passed must be a valid
        array with all the layer's index. 
        Return TRUE on success or else FALSE.

   string processtemplate(array params, boolean generateimages)
        Process the template file specified in the web object and return 
        the resut in a buffer. 
        The processing consists of opening the template file and replace
        all the tags found in it.
        Only tags that have an equivalent element in the map object are
        replaced (ex [scaledenom]). 
        The are two expetions to the previous statement :
          - [img], [scalebar], [ref], [legend] would be replaced with the 
            appropriate url if the parameter generateimages is set to 
            MS_TRUE. (Note :  the images corresponding to the diffrent objects 
            are generated if the object is set to MS_ON in the map file)
         - the user can use the params parameter to specify tags and 
           their values. For example if the user have a specific tag call
           [my_tag] and would like it to be replaced by "value_of_my_tag"
           he would do :
              $tmparray["my_tag"] = "value_of_my_tag";
              $map->processtemplate($tmparray, MS_FALSE);
         
   string processquerytemplate(array params, boolean generateimages)     
       Process query template files and return the resut in a buffer.
       Second argument generateimages is not manadatory. If not given
        It will be set to TRUE.

       See also : processtemplate function.
   
   string processlegendtemplate(array params)     
       Process legend template files and return the resut in a buffer.

     See also : processtemplate function.

   int setSymbolSet(string fileName)
       Load and set a symbol file dynamictly.
       
   int getNumSymbols()
       Return the number of symbols in map.
       
   int setFontSet(string fileName)
       Load and set a new fontset.
       

   int selectOutputFormat(string type)
        Selects the output format to be used in the map. 
        Returns MS_SUCCESS/MS_FAILURE.
       
        Note : the type used should correspond to one of the output
               formats declared in the map file.
               The type argument passed is compared with the mimetype
               parameter in the output format structure and then to
               the name parameter in the structure. 

   int saveMapContext(string filename)
        Available only if WMS support is enabled.
        Save current map object state in WMS Map Context format. 
        Only WMS layers are saved in the WMS Map Context XML file.
        Returns MS_SUCCESS/MS_FAILURE.

   int loadMapContext(string filename [, boolean unique_layer_name])
        Available only if WMS support is enabled.
        Load a WMS Map Context XML file into the current mapObj.
        If the map already contains some layers then the layers defined
        in the WMS Map context document are added to the current map.
        The 2nd argument unique_layer_name is optional and if set to 
        MS_TRUE layers created will have a unique name (unique prefix
        added to the name). If set to MS_FALSE the layer name will be the 
        the same name as in the context. The default value is MS_FALSE.
        Returns MS_SUCCESS/MS_FAILURE.


  int applySLD(string sldxml)
        Apply the SLD document to the map file. The matching between the
        sld document and the map file will be done using the layer's name.
        See SLD How to for more information on the SLD support.

  int applySLDURL(string sldurl)
        Apply the SLD document pointed by the URL to the map file. The 
        matching between the sld document and the map file will be done 
        using the layer's name.
        See SLD How to for more information on the SLD support.

  string generateSLD()
        Returns an SLD XML string based on all the classes found in all 
        the layers.

  string getconfigoption(string key)
        Returns the config value associated with the key.
        Returns an empty sting if key not found.

  int  setconfigoption(string key, string value)
        Sets a config parameter using the key and the value passed

  int applyconfigoptions()
        Applies the config options set in the map file. For example
        seeting the PROJ_LIB using the setconfigoption only modifies
        the value in the map object. applyconfigoptions will actually
        change the PROJ_LIB  value that will be used when dealing with
        projection.


  int loadowsparameters(owsrequest request, string version)
        Load OWS request parameters (BBOX, LAYERS, &c.) into map.  Returns
    MS_SUCCESS or MS_FAILURE.   
        2nd argument version is not mandatory. If not given, the version
       will be set to 1.1.1
    
  int owsdispatch(owsrequest request)
    Processes and executes the passed OpenGIS Web Services request on the 
    map.  Returns MS_DONE (2) if there is no valid OWS request in the req 
    object, MS_SUCCESS (0) if an OWS request was successfully processed and
    MS_FAILURE (1) if an OWS request was not successfully processed.  OWS
    requests include WMS, WFS, WCS and SOS requests supported by MapServer. 
    Results of a dispatched request are written to stdout and can be captured
    using the msIO services (ie. ms_ioinstallstdouttobuffer() and 
    ms_iogetstdoutbufferstring())


 LayerObj Class:
 ---------------

 Constructor:
   Layer Objects can be returned by the MapObj class, or can be created
   using:

   layerObj ms_newLayerObj(MapObj map [, layerObj layer])

   A second optional argument can be given to ms_newLayerObj() to create
   the new layer as a copy of an existing layer. If a layer is given as 
   argument then all members of a this layer will be copied in the new
   layer created.

 Members:
   int    numclasses  (read-only)
   int    index       (read-only)
   int    status      (MS_ON, MS_OFF, MS_DEFAULT or MS_DELETE)
   int    debug
   string classitem
   string name
   string group
   string data
   int    type
   int    dump
   double tolerance
   int    toleranceunits
   int    sizeunits
   double symbolscaledenom
   double minscaledenom
   double maxscaledenom
   double labelminscaledenom
   double labelmaxscaledenom
   double symbolscale   (Deprecated in v5.0, use symbolscaledenom instead)
   double minscale      (Deprecated in v5.0, use minscaledenom instead)
   double maxscale      (Deprecated in v5.0, use maxscaledenom instead)
   double labelminscale (Deprecated in v5.0, use labelminscaledenom instead)
   double labelmaxscale (Deprecated in v5.0, use labelmaxscaledenom instead)
   int    maxfeatures
   colorObj    offsite
   int    annotate
   int    transform
   int    labelcache
   int    postlabelcache
   string labelitem
   string labelsizeitem
   string labelangleitem
   string tileitem
   string tileindex
   string header
   string footer
   string connection
   int    connectiontype
   string filteritem
   string template
   int    opacity
   int    transparency (Deprecated in v5.0. Use opacity instead.)
   string styleitem
   gridObj grid //only available on a layer defined as grid (MS_GRATICULE)
   int num_processing
   string requires
   string labelrequires

 Methods:

   int set(string property_name, new_value)
        Set object property to a new value. Returns -1 on error.

   int draw(imageObj image)
        Draw a single layer, add labels to cache if required. 
        Returns -1 on error.

   int drawQuery(imageObj image)
        Draw query map for a single layer.

   classObj getClass(int classIndex)
        Returns a classObj from the layer given an index value (0=first class)

   int queryByPoint(pointObj point, int mode, double buffer)
        Query layer at point location specified in georeferenced map 
        coordinates (i.e. not pixels).  
        The query is performed on all the shapes that are part of a CLASS 
        that contains a TEMPLATE value or that match any class in a
        layer that contains a LAYER TEMPLATE value.
        Mode is MS_SINGLE or MS_MULTIPLE depending on number of results
        you want. 
        Passing buffer <=0 defaults to tolerances set in the map file 
        (in pixels) but you can use a constant buffer (specified in 
        ground units) instead.
        Returns MS_SUCCESS if shapes were found or MS_FAILURE if nothing
        was found or if some other error happened (note that the error 
        message in case nothing was found can be avoided in PHP using 
        the '@' control operator).

   int queryByRect(rectObj rect)
        Query layer using a rectangle specified in georeferenced map 
        coordinates (i.e. not pixels).
        The query is performed on all the shapes that are part of a CLASS 
        that contains a TEMPLATE value or that match any class in a
        layer that contains a LAYER TEMPLATE value.
        Returns MS_SUCCESS if shapes were found or MS_FAILURE if nothing
        was found or if some other error happened (note that the error 
        message in case nothing was found can be avoided in PHP using 
        the '@' control operator).

   int queryByShape(shapeObj shape)
        Query layer based on a single shape, the shape has to be a polygon
        at this point.
        Returns MS_SUCCESS if shapes were found or MS_FAILURE if nothing
        was found or if some other error happened (note that the error 
        message in case nothing was found can be avoided in PHP using 
        the '@' control operator).

   int queryByFeatures(int slayer) 
        Perform a query set based on a previous set of results from
        another layer. At present the results MUST be based on a polygon
        layer.
        Returns MS_SUCCESS if shapes were found or MS_FAILURE if nothing
        was found or if some other error happened (note that the error 
        message in case nothing was found can be avoided in PHP using 
        the '@' control operator).

   int queryByAttributes(string qitem, string qstring, int mode)
        Query layer for shapes that intersect current map extents.
        qitem is the item (attribute) on which the query is performed, 
        and qstring is the expression to match.
        The query is performed on all the shapes that are part of a CLASS 
        that contains a TEMPLATE value or that match any class in a
        layer that contains a LAYER TEMPLATE value.  
        Note that the layer's FILTER/FILTERITEM are ignored by this function.
        Mode is MS_SINGLE or MS_MULTIPLE depending on number of results
        you want. 
        Returns MS_SUCCESS if shapes were found or MS_FAILURE if nothing
        was found or if some other error happened (note that the error 
        message in case nothing was found can be avoided in PHP using 
        the '@' control operator).

   int setFilter(string expression)
        Set layer filter expression.

   string getFilterString()
        Returns the expression for this layer.

   string getFilter()
        Deprecated in v5.0, use getFilterString() instead.

   string getProjection()
        Returns a string represenation of the projection. If no 
        projection is set, MS_FALSE is returned.

   int setProjection(string proj_params)
        Set layer projection and coordinate system.  Parameters are given as 
        a single string of comma-delimited PROJ.4 parameters.

   int setWKTProjection(string proj_params)
        Same as setProjection(), but takes an OGC WKT projection 
        definition string as input.

   int getNumResults()
        Returns the number of results from this layer in the last query.

   resultCacheMemberObj getResult(int index)
        Returns a resultCacheMemberObj by index from a layer object with 
        index in the range 0 to numresults-1.  
        Returns a valid object or FALSE(0) if index is invalid.

   int open()
        Open the layer for use with getShape().  
        Returns MS_SUCCESS/MS_FAILURE.

   int whichshapes(rectobj)
        Performs a spatial, and optionally an attribute based feature search. 
        The function basically prepares things so that candidate features can be 
        accessed by query or drawing functions (eg using nextshape function).
        Returns MS_SUCCESS or MS_FAILURE.

   shapeobj nextShape()
       Called after msWhichShapes has been called to actually retrieve shapes 
       within a given area           
       returns a shape object or MS_FALSE

        example of usage :

        $map = ms_newmapobj("d:/msapps/gmap-ms40/htdocs/gmap75.map");
        $layer = $map->getLayerByName('road');
        $status = $layer->open();
        $status = $layer->whichShapes($map->extent);
        while ($shape = $layer->nextShape()) 
        {
           echo $shape->index ."<br>\n";
        }
        $layer->close();


   void close()
        Close layer previously opened with open().

   shapeObj getFeature(int shapeindex [, int tileindex = -1])
        Retrieve shapeObj from a layer by index.
        Tileindex is optional and is used only for tiled shapefiles 
        (you get it from the resultCacheMemberObj returned by getResult()
        for instance). 
        Simply omit or pass tileindex = -1 for other data sources.

   shapeObj getShape(int tileindex, int shapeindex)
        Deprecated in v5.0, use getFeature() instead (note that the order
        of the arguments is reversed since tileindex is optional in 
        getFeature())

   rectObj getExtent()
        Returns the layer's data extents. 
        If the layer's EXTENT member is set then this value is used, 
        otherwise this call opens/closes the layer to read the 
        extents. This is quick on shapefiles, but can be
        an expensive operation on some file formats or data sources.
        This function is safe to use on both opened or closed layers: it
        is not necessary to call open()/close() before/after calling it.

   int addFeature(shapeObj shape)
        Add a new feature in a layer.  Returns -1 on error.

   int getMetaData(string name)
        Fetch layer metadata entry by name.  Returns "" if no entry 
        matches the name.  Note that the search is case sensitive.

   int setMetaData(string name, string value)
        Set a metadata entry for the layer.  Returns MS_SUCCESS/MS_FAILURE.

   int removeMetaData(string name)
        Remove a metadata entry for the layer.  Returns MS_SUCCESS/MS_FAILURE.

   string getWMSFeatureInfoURL(int clickX, int clickY, int featureCount, 
                               string infoFormat)
        Return a WMS GetFeatureInfo URL (works only for WMS layers)
        clickX, clickY is the location of to query in pixel coordinates
        with (0,0) at the top left of the image.
        featureCount is the number of results to return.
        infoFormat is the format the format in which the result should be
        requested.  Depends on remote server's capabilities.  MapServer
        WMS servers support only "MIME" (and should support "GML.1" soon).
        Returns "" and outputs a warning if layer is not a WMS layer 
        or if it is not queriable.
        
   aString getItems()
        return a list of items. Must call open function first.

   boolean setProcessing(string)
        Add the string to the processing string list for the layer.
        The layer->num_processing is incremented by 1.
        Ex : $oLayer->setprocessing("SCALE_1=AUTO");
             $oLayer->setprocessing("SCALE_2=AUTO");       

   aString getProcessing()
        Returns an array containing the processing strings

   boolean clearProcessing()
        Clears all the processing strings

   string   executeWFSGetfeature()
       Executes a GetFeature request on a WFS layer and returns the
       name of the temporary GML file created. Returns an empty
       string on error.

   int applySLD(string sldxml, string namedlayer)
        Apply the SLD document to the layer object. 
        The matching between the sld document and the layer will be done 
        using the layer's name.
        If a namedlayer argument is passed (argument is optional), 
        the NamedLayer in the sld that matchs it will be used to style 
        the layer.
        See SLD How to for more information on the SLD support.

  int applySLDURL(string sldurl, string namedlayer)
        Apply the SLD document pointed by the URL to the layer object. The 
        matching between the sld document and the layer will be done using 
        the layer's name.
        If a namedlayer argument is passed (argument is optional), 
        the NamedLayer in the sld that matchs it will be used to style 
        the layer.
        See SLD How to for more information on the SLD support.

  string generateSLD()
        Returns an SLD XML string based on all the classes found in the layers.

  int moveclassup(int index)
        The class specified by the class index will be moved up into
        the array of layers. Returns MS_SUCCESS or MS_FAILURE.
        ex layer->moveclassup(1) will have the effect of moving class 1
           up to postion 0, and the class at position 0 will be moved
           to position 1.

  int moveclassdown(int index)
        The class specified by the class index will be moved down into
        the array of layers. Returns MS_SUCCESS or MS_FAILURE.
        ex layer->moveclassdown(0) will have the effect of moving class 0
           up to postion 1, and the class at position 1 will be moved
           to position 0.

  classObj removeClass(int index)
        Removes the class indicated and returns a copy, or NULL in the case
        of a failure.  Note that subsequent classes will be renumbered by
        this operation. The numclasses field contains the number of classes
        available.

  boolean isVisible()
       Returns MS_TRUE/MS_FALSE depending on whether the layer is 
       currently visible in the map (i.e. turned on, in scale, etc.). 


 ClassObj Class:
 ---------------

 Constructor:
   Class Objects can be returned by the LayerObj class, or can be created
   using:

   classObj ms_newClassObj(layerObj layer [, classObj class])

  The second argument class is optional. If given, the new class
  created will be a copy of this class.

 Members:

   string name
   string title
   int    type
   int    status      (MS_ON, MS_OFF or MS_DELETE)
   double    minscaledenom
   double    maxscaledenom
   double    minscale  (Deprecated in v5.0, use minscaledenom instead)
   double    maxscale  (Deprecated in v5.0, use maxscaledenom instead)
   string template
   labelObj label
   int    numstyles
   string keyimage   
      
 Methods:

   int set(string property_name, new_value)
        Set object property to a new value. Returns -1 on error.

   int setExpression(string expression)
        Set the expression string for the class object.
   
   string getExpressionString()
        Returns the expression string for the class object.
            
   string getExpression()
        Deprecated in v5.0. Use getExpressionString() instead.
            
   int settext(string text)
        Set the text string for the class object.
   
   string getTextString()
        Returns the text string for the class object.
            
   int drawLegendIcon(int width, int height, imageObj im, int dstX, int dstY)
        Draw the legend icon on im object at dstX, dstY.
        Returns MS_SUCCESS/MS_FAILURE.

   imageObj createLegendIcon(int width, int height)
        Draw the legend icon and return a new imageObj.
     
   styleObj getStyle(int index)
        Return the style object using an index. index >= 0 &&
        index < class->numstyles.

   classObj clone()
        Returns a cloned copy of the class.  

   int movestyleup(int index)
       The style specified by the style index will be moved up into
       the array of classes. Returns MS_SUCCESS or MS_FAILURE.
       ex calss->movestyleup(1) will have the effect of moving style 1
          up to postion 0, and the style at position 0 will be moved
          to position 1.
 
   int movestyledown(int index)
       The style specified by the style index will be moved down into
       the array of classes. Returns MS_SUCCESS or MS_FAILURE.
       ex class->movestyledown(0) will have the effect of moving style 0
          up to postion 1, and the style at position 1 will be moved
          to position 0.

   int deletestyle(int index)
       Delete the style specified by the style index. If there are any
       style that follow the deleted style, their index will decrease by 1.

       NOTE : if you are using the numstyles parameter while using the
              deletestyle function on the class object you need to refetch
              a new class object. Example :
              
                 //class has 2 styles
                $class = $oLayer->getclass(0);
                $class->deletestyle(1);
                echo $class->numstyles; : will echo 2

                $class = $oLayer->getclass(0);
                echo $class->numstyles; : will echo 1 


 ImageObj Class:
 ---------------

 Constructor:

   Instances of ImageObj are always created by the map class methods.

 Members:

   int    width     (read-only)
   int    height    (read-only)
   string imagepath
   string imageurl

 Methods:

   void free()
        Destroys resources used by an image object.

   int saveImage(string filename, MapObj oMap)
        Writes image object to specifed filename.
        Passing an empty filename sends output to stdout.  In this case,
        the PHP header() function should be used to set the documents's
        content-type prior to calling saveImage().
        The output format is the one that is currently selected in the 
        map file.
        The second argument oMap is not manadatory. It is usful when 
        saving to formats like GTIFF that needs georeference informations
        contained in the map file.
        The function returns -1 on error.  On success, it returns either 0
        if writing to an external file, or the number of bytes written if 
        output is sent to stdout.

   string saveWebImage()
        Writes image to temp directory.  Returns image URL.
        The output format is the one that is currently selected in the 
        map file.
       

   void pasteImage(imageObj srcImg, int transparentColorHex 
                   [[, int dstX, int dstY], int angle])
        Copy srcImg on top of the current imageObj.
        transparentColorHex is the color (in 0xrrggbb format) from srcImg 
        that should be considered transparent (i.e. those pixels won't 
        be copied).  Pass -1 if you don't want any transparent color.
        If optional dstx,dsty are provided then it defines the position 
        where the image should be copied (dstx,dsty = top-left corner 
        position).
        The optional angle is a value between 0 and 360 degrees to rotate
        the source image counterclockwise.  Note that if an angle is specified
        (even if its value is zero) then the dstx and dsty coordinates 
        specify the CENTER of the destination area.
        Note: this function works only with 8 bits GD images (PNG or GIF).


 LabelObj Class:
 ---------------

 Constructor:

   LabelObj are always embedded inside other classes.

 Members:

   string font
   int    type
   colorObj    color
   colorObj    outlinecolor
   colorObj    shadowcolor
   int    shadowsizex
   int    shadowsizey
   colorObj    backgroundcolor
   colorObj    backgroundshadowcolor
   int    backgroundshadowsizex
   int    backgroundshadowsizey
   int    size
   int    minsize
   int    maxsize
   int    position
   int    offsetx
   int    offsety
   double angle
   int    autoangle
   int    buffer
   int    antialias
   int    wrap
   int    minfeaturesize
   int    autominfeaturesize
   int    mindistance
   int    partials
   int    force
   string encoding

 Methods:

   int set(string property_name, new_value)
        Set object property to a new value. Returns -1 on error.

   int setBinding(const labelbinding, string value)
       Set the attribute binding for a specfiled label property. Returns true on success.

        Example:
           $oLabel->setbinding(MS_LABEL_BINDING_COLOR, "FIELD_NAME_COLOR");
           This would bind the color parameter with the data (ie will extract
           the value of the color from the field called "FIELD_NAME_COLOR"
   
   int removeBinding(const labelbinding)
        Remove the attribute binding for a specfiled style property. Returns true on success.  
        Example:
           $oStyle->removebinding(MS_LABEL_BINDING_COLOR);
     
 webObj Class
 -----------

 Constructor:

   Instances of webObjare always are always embedded inside the mapObj.

 Members:

   string log;
   string imagepath
   string template      
   string imageurl
   string header
   string footer
   string empty     (read-only)
   string error     (read-only)
   string mintemplate
   string maxtemplate
   double minscaledenom
   double maxscaledenom
   double minscale  (Deprecated in v5.0, use minscaledenom instead)
   double maxscale  (Deprecated in v5.0, use maxscaledenom instead)
   rectObj extent   (read-only)
   string queryformat

 Methods:

      int set(string property_name, new_value)
        Set object property to a new value. Returns -1 on error.



 referenceMapObj Class
 --------------------

Constructor:

   Instances of referenceMapObj are always embedded inside the mapObj.

 Members:
 
   string   image
   int      width
   int      height
   int      status
   rectObj  extent
   ColorObj color
   ColorObj outlinecolor

 Method :

   int set(string property_name, new_value)
        Set object property to a new value. Returns -1 on error.
 
 ColorObj Class:
 ---------------

 Constructor:

  Instances of ColorObj are always embedded inside other classes.

 Members:

   int    red
   int    green
   int    blue

 Methods:

   void setRGB(int red, int green, int blue)
        Set red, green, blue values.


 PointObj Class:
 ---------------

 Constructor:

   PointObj ms_newPointObj()

 Members:

   double x
   double y
   double z (used for 3d shape files. set to 0 for other types)
   double m  (used only for measured shape files. set to 0 for other types.)

 Methods:

   int setXY(double x, double y [, double m])
        Set X,Y coordinate values.
        Note : the 3rd parameter m is used for measured shape files only.
        It is not mandatory.
        Returns 0 on success, -1 on error.

   int setXYZ(double x, double y , double z, [, double m])
        Set X,Y,Z coordinate values.
        Note : the 4th parameter m is used for measured shape files only.
        It is not mandatory.
        Returns 0 on success, -1 on error.
     

   int draw(mapObj map, layerObj layer, imageObj img, 
            int class_index, string text)
        Draws the individual point using layer.  The class_index is used
        to classify the point based on the classes defined for the layer.
        The text string is used to annotate the point.
        Returns MS_SUCCESS/MS_FAILURE.

  double distanceToPoint(pointObj poPoint)
       Calculates distance between two points.  

  double distanceToLine(pointObject p1, pointObject p2)
        Calculates distance between a point ad a lined defined by the
        two points passed in argument. 

  double distanceToShape(shapeObj shape)
        Calculates the minimum distance between a point and a shape.

  int project(projectionObj in, projectionObj out)
        Project the point from "in" projection (1st argument) to "out" 
        projection (2nd argument).  Returns MS_SUCCESS/MS_FAILURE.
      
  void free()
       Releases all resources used by the object.       

 LineObj Class:
 --------------

 Constructor:

   LineObj ms_newLineObj()

 Members:

   int    numpoints  (read-only)

 Methods:

   int add(pointObj point)
        Add a point to the end of line.

   int addXY(double x, double y [, double m])
        Add a point to the end of line.
        Note : the 3rd parameter m is used for measured shape files only. 
        It is not mandatory.

   int addXYZ(double x, double y, double z [, double m])
        Add a point to the end of line.
        Note : the 4th parameter m is used for measured shape files only. 
        It is not mandatory.

   PointObj point(int i)
        Returns a reference to point number i.  Reference is valid only
        during the life of the lineObj that contains the point.

   int project(projectionObj in, projectionObj out)
        Project the line from "in" projection (1st argument) to "out" 
        projection (2nd argument).  Returns MS_SUCCESS/MS_FAILURE.

   void free()
        Destroys resources used by a line object.     

 ShapeObj Class:
 --------------

 Constructor:

   ShapeObj ms_newShapeObj(int type)
        'type' is one of MS_SHAPE_POINT, MS_SHAPE_LINE, MS_SHAPE_POLYGON or
        MS_SHAPE_NULL

   ShapeObj ms_shapeObjFromWkt(string wkt)
        Creates new shape object from WKT string.

 Members:

   string  text
   int     classindex
   int     type      (read-only)
   int     numlines  (read-only)
   int     index     
   int     tileindex (read-only)
   rectObj bounds    (read-only)
   int     numvalues (read-only)
   array   values    (read-only)

   The values array is an associative array with the attribute values for
   this shape.  It is set only on shapes obtained from layer->getShape().
   The key to the values in the array is the attribute name, e.g. 
     $population = $shape->values["Population"];

 Methods:

   int set(string property_name, new_value)
        Set object property to a new value. Returns -1 on error.
 
   int add(lineObj line)
        Add a line (i.e. a part) to the shape.

   LineObj line(int i)
        Returns a reference to line number i.  Reference is valid only
        during the life of the shapeObj that contains the point.

   int draw(mapObj map, layerObj layer, imageObj img)
        Draws the individual shape using layer.
        Returns MS_SUCCESS/MS_FAILURE.

   boolean contains(pointObj point)
        Returns MS_TRUE if the point is inside the shape, MS_FALSE otherwise.

   boolean intersects(shapeObj shape)
        Returns MS_TRUE if the two shapes intersect, MS_FALSE otherwise.
     
   int project(projectionObj in, projectionObj out)
        Project the shape from "in" projection (1st argument) to "out" 
        projection (2nd argument).  Returns MS_SUCCESS/MS_FAILURE.

   pointObj getpointusingmeasure(double m)
        Apply only on Measured shape files. Given a measure m, retun the 
        corresponding XY location on the shapeobject.
   
   pointObj  getmeasureusingpoint(pointObject point)
       Apply only on Measured shape files. Given an XY Location, find the 
       nearest point on the shape object. Return a point object
       of this point with the m value set.

   void free()
        Destroys resources used by a shape object.  


   string getvalue(layerObj layer, string filedname)
        Returns the value for a given field name.
 
   shapeobj buffer(width)
        Returns a new buffered shapeObj based on the supplied distance (given
        in the coordinates of the existing shapeObj). 
        Only available if php/mapscript is built with GEOS library.   

   shapeobj convexhull()
        Returns a shape object representing the convex hull of shape.
        Only available if php/mapscript is built with GEOS 
        library.

   shapeobj boundary()
        Returns the boundary of the shape.
        Only available if php/mapscript is built with GEOS library.

   int containsShape(shapeobj shape2)
        Returns true if shape2 passed as argument is entirely within the shape. 
        Else return false.
        Only available if php/mapscript is built with GEOS 
        library.

  shapeobj union(shapeobj shape)
        Returns a shape object representing the union of the shape object 
        with the one passed as parameter. 
        Only available if php/mapscript is built with GEOS 
        library

   shapeobj union_geos(shapeobj shape) (Deprecated in v5.2. Use union instead)
        Returns a shape object representing the union of the shape object 
        with the one passed as parameter. 
        Only available if php/mapscript is built with GEOS 
        library.

   shapeobj intersection(shapeobj shape)
        Returns a shape object representing the intersection of the shape 
        object with the one passed as parameter. 
        Only available if php/mapscript is built with GEOS library.

   shapeobj difference(shapeobj shape)
        Returns a shape object representing the difference of the
        shape object with the one passed as parameter. 
        Only available if php/mapscript is built with GEOS library.

   shapeobj symdifference(shapeobj shape)
        Returns the computed symmetric difference of the supplied and existing
        shape.
        Only available if php/mapscript is built with GEOS library.
  
   int overlaps(shapeobj shape)  
       Returns true if the shape passed as argument overlaps the shape.
       Else returns false.
       Only available if php/mapscript is built with GEOS library.

   int within(shapeobj shape2) 
       Returns true if the shape is entirely within the shape2 passed as argument. 
       Else returns false. 
       Only available if php/mapscript is built with GEOS library.

   int crosses(shapeobj shape)  
       Returns true if the shape passed as argument crosses the shape.
       Else return false.
       Only available if php/mapscript is built with GEOS library.

   int touches(shapeobj shape)  
       Returns true if the shape passed as argument touches the shape.
       Else return false.
       Only available if php/mapscript is built with GEOS library.

   int equals(shapeobj shape)  
       Returns true if the shape passed as argument is equal to the 
       shape (geometry only). Else return false.
       Only available if php/mapscript is built with GEOS library.
    
   int disjoint(shapeobj shape)  
       Returns true if the shape passed as argument is disjoint to the 
       shape. Else return false.
       Only available if php/mapscript is built with GEOS library.

   pointObj getCentroid()  
       Returns a point object representing the centroid of the shape.
       Only available if php/mapscript is built with GEOS library.

   double getArea()  
       Returns the area of the shape (if applicable).
       Only available if php/mapscript is built with GEOS library.

   double getLength()  
       Returns the length (or perimeter) of the shape.
       Only available if php/mapscript is built with GEOS library.

   pointObj getLabelPoint()  
       Returns a point object with coordinates suitable for labelling 
       the shape.

   string toWkt()
        Returns WKT representation of the shape's geometry.

 RectObj Class:
 --------------

 Constructor:

   RectObj are sometimes embedded inside other objects.  New ones can
   also be created with:

   RectObj ms_newRectObj() (Note: the memebers (minx, miny,maxx,maxy) are 
                                  initialized to -1); 

 Members:

   double minx
   double miny
   double maxx
   double maxy

 Methods:

   int set(string property_name, new_value)
        Set object property to a new value. Returns -1 on error.

   void setextent(double minx, double miny, double maxx, double maxy)
    Set the rectangle extents.

   int draw(mapObj map, layerObj layer, imageObj img, 
            int class_index, string text)
        Draws the individual rectangle using layer.  The class_index is used
        to classify the rectangle based on the classes defined for the layer.
        The text string is used to annotate the rectangle.
        Returns MS_SUCCESS/MS_FAILURE.

  double fit(int width, int height)
        Adjust extents of the rectangle to fit the width/height specified.

  int project(projectionObj in, projectionObj out)
        Project the rectangle from "in" projection (1st argument) to "out" 
        projection (2nd argument).  Returns MS_SUCCESS/MS_FAILURE.

  void free()
        Destroys resources used by a rect object.  

 ShapefileObj Class:
 -------------------

 Constructor:

   shapefileObj ms_newShapefileObj(string filename, int type)
        Opens a shapefile and returns a new object to deal with it. 
        Filename should be passed with no extension.
        To create a new file (or overwrite an existing one), type should 
        be one of MS_SHP_POINT, MS_SHP_ARC, MS_SHP_POLYGON or 
        MS_SHP_MULTIPOINT.
        Pass type as -1 to open an existing file for read-only access,
    and type=-2 to open an existing file for update (append).

 Members:

   int     numshapes  (read-only)
   int     type       (read-only)
   string  source     (read-only)
   rectObj bounds     (read-only)

 Methods:

   shapeObj getShape(int i)
        Retrieve shape by index.

   shapeObj getPoint(int i)
        Retrieve point by index.
      
   shapeObj getTransformed(mapObj map, int i)
        Retrieve shape by index.

   rectObj getExtent(int i)
        Retrieve a shape's bounding box by index.

   int addShape(shapeObj shape)
        Appends a shape to an open shapefile.
        
   int addPoint(pointObj point)
        Appends a point to an open shapefile.

   void free()
        Closes a shape file (and commits all changes in write mode) and 
        releases all resources used by the object.


 ResultCacheMemberObj Class:
 ---------------------------

 Constructor:

   Instances of ResultCacheMemberObj are always obtained through 
   layerObj's getResult() method.

 Members:

   int    shapeindex    (read-only)
   int    tileindex     (read-only)
   int    classindex    (read-only)


 ProjectionObj class:
 -------------------

 Constructor:
  
    ProjectionObjObj ms_newProjectionObj(string projectionstring)
        
   Creates a projection object based on the projection string passed
   as argument.
   Eg : $projInObj = ms_newprojectionobj("proj=latlong") will create a 
        geographic projection class.

   Eg of usage : the following example will convert a lat/long point to
   an LCC projection :  

        $projInObj = ms_newprojectionobj("proj=latlong");
        $projOutObj = ms_newprojectionobj("proj=lcc,ellps=GRS80,lat_0=49,".
                                          "lon_0=-95,lat_1=49,lat_2=77");
        $poPoint = ms_newpointobj();
        $poPoint->setXY(-92.0, 62.0);         
        $poPoint->project($projInObj, $projOutObj);


 ScalebarObj Class:
 ------------------

 Constructor:

   Instances of scalebarObj are always are always embedded inside the mapObj.

 Members:

   int height;
   int width;
   int style;      
   int intervals;
   colorObj color;
   colorObj backgroundcolor;            
   colorObj outlinecolor;
   int units;
   int status; //MS_ON, MS_OFF, MS_EMBED
   int position; //for embeded scalebars, MS_UL, MS_UC, ...
   int transparent;
   int interlace;
   int postlabelcache;
   labelObj label;
   colorObj imagecolor;
     
 Methods:

      int set(string property_name, new_value)
        Set object property to a new value. Returns -1 on error.
        
      int setimagecolor(int red, int green, int blue)
        Sets the imagecolor propery (baclground) of the object.
        Returns false on error.  

 LegendObj Class:
 ----------------

 Constructor:

   Instances of legendObj are always are always embedded inside the mapObj.

 Members:

    int height;
    int width;
    int keysizex;      
    int keysizey;
    int keyspacingx;
    int keyspacingy;
    colorObj outlinecolor; //Color of outline of box, -1 for no outline
    int status; //MS_ON, MS_OFF, MS_EMBED
    int position; //for embeded legends, MS_UL, MS_UC, ...
    int transparent;
    int interlace;
    int postlabelcache; //MS_TRUE, MS_FALSE
    labelObj label;
    colorObj imagecolor;
    string   template
     
 Methods:

    int set(string property_name, new_value)
        Set object property to a new value. Returns -1 on error.


 QuerymapObj Class:
 ------------------

 Constructor:

    Instances of querymapObj are always are always embedded inside the mapObj.

 Members:

    int width
    int height
    int style   (MS_NORMAL, MS_HILITE, MS_SELECTED)
    colorObj color
     
 Methods:

    int set(string property_name, new_value)
        Set object property to a new value. Returns -1 on error.


 StyleObj Class:
 ---------------

 Constructor:

   Instances of styleObj are always embedded inside the classObj.

   styleObj ms_newStyleObj(classObj class [, styleObj style])

   The second argument 'style' is optional. If given, the new style
   created will be a copy of the style passed as argument.
        
 Members:

  int           symbol
  string        symbolname
  int           size
  int           minsize 
  int           maxsize 
  int           offsetx
  int           offsety
  int           antialias
  colorObj      color
  colorObj      backgroundcolor
  colorObj      outlinecolor
  int           width
  int           minwidth
  int           maxwidth
  double        angle
  string        angleitem  
  string        sizeitem
  double        minvalue
  double        maxvalue
  string        rangeitem
      
        
        
  Methods:

   int set(string property_name, new_value)
        Set object property to a new value. Returns -1 on error.
 
   styleObj clone()
     Returns a cloned copy of the style.  

   int setBinding(const stylebinding, string value)
       Set the attribute binding for a specfiled style property. Returns true on success.

        Example:
           $oStyle->setbinding(MS_STYLE_BINDING_COLOR, "FIELD_NAME_COLOR");
           This would bind the color parameter with the data (ie will extract
           the value of the color from the field called "FIELD_NAME_COLOR"
   
   int removeBinding(const stylebinding)
        Remove the attribute binding for a specfiled style property. Returns true on success.  
        Example:
           $oStyle->removebinding(MS_STYLE_BINDING_COLOR);

 OutputformatObj Class:
 ----------------------

 Constructor :

  Instance of outputformatObj is always embedded inside the mapObj.
  It is uses a read only.

  No constructor available (coming soon, see bug 979)


 Members:

   string    name
   string    mimetype
   string    driver
   string    extension
   int       renderer
   int       imagemode     // MS_IMAGEMODE_* value.
   int       transparent
        
  Methods related to the output format :

   int set(string property_name, new_value)
        Set object property to a new value.

   void setOption(string property_name, string new_value)
        Add or Modify the format option list. return true on success.

        Example: $oMap->outputformat->setOption("OUTPUT_TYPE", "RASTER");
     
   string  getOption(string property_name)
        Returns the associated value for the format option property passed
        as argument. Returns an empty string if property not found.

   void setFormatOption(string property_name, string new_value)
        Deprecated. See setOption().

   string  getFormatOption(string property_name)
        Deprecated. See getOption().


 GridObj Class:
 --------------

 Constructor :

   The grid is always embedded inside a layer object defined as
   a grid (layer->connectiontype = MS_GRATICULE)
   (for more docs : http://mapserver.gis.umn.edu/cgi-bin/wiki.pl?MapServerGrid)

   A layer can become a grid layer by adding a grid object to it using :
      ms_newGridObj(layerObj layer)

  Example :   $oLayer = ms_newlayerobj($oMap);
              $oLayer->set("name", "GRID");
              ms_newgridobj($oLayer);
              $oLayer->grid->set("labelformat", "DDMMSS");


 Members:

   double    minsubdivide;
   double    maxsubdivide;
   double    minarcs;
   double    maxacrs;
   double    mininterval;
   double    maxinterval;
   string    labelformat;
  

 Method :

   int set(string property_name, new_value)
        Set object property to a new value.


 ErrorObj Class:
 ---------------

   Instances of errorObj are created internally by MapServer as errors
   happen.  Errors are managed as a chained list with the first item being
   the most recent error.  The head of the list can be fetched using 
   ms_GetErrorObj(), and the list can be cleared using ms_ResetErrorList()

  Functions:

    errorObj ms_GetErrorObj()
        Returns a reference to the head of the list of errorObj.

    void ms_ResetErrorList()
        Clear the current error list.  
        Note that clearing the list invalidates any errorObj handles obtained 
        via the $error->next() method.

  Members:

    int      code      /* See error code constants above */
    string   routine
    string   message

  Method:

    errorObj next()
        Returns the next errorObj in the list, or NULL if we reached the end
        of the list.

  Example:
   This example draws a map and reports all errors generated during
   the draw() call, errors can potentially come from multiple layers.

       ms_ResetErrorList();
       $img = $map->draw();
       $error = ms_GetErrorObj();
       while($error && $error->code != MS_NOERR)
       {
           printf("Error in %s: %s<br>\n", $error->routine, $error->message);
           $error = $error->next();
       }



 LabelcacheObj Class:
 --------------------

  Accessible only through the map object (map->labelcache). This object
  is only used to give the possiblity to free the label cache 
  (map->labelcache->free())


  Method:

    boolean free()
        Free the label cache. Returns true on success or false if an error
        occurs.
        Ex : (map->labelcache->free();



 SymbolObj Class:
 ----------------

  Constructor:
        
        symboldid = ms_newSymbolObj(mapObj map, string symbolname);
        
        Creates a new symbol with default values in the symbolist. 
        Returns the Id of the new symbol. If a symbol with the same
        name exists, It's id will be returned.

  To get a symbol object, you need to use a method on the map object:
        $oSymbol = $map->getSymbolObjectById($nId);

  Members:

    string name;
    type name;  //Please refer to symbol type constants
    int inmapfile; If set to TRUE, the symbol will be saved inside
                   the mapfile.
    double sizex;
    double sizey
    int numpoints
    int filled;
    int patternlength;
    int stylelength;  (Deprecated in v5.0, use patternlength instead.)

  Methods:

    int set(string property_name, new_value)
        Set object property to a new value.

    int setpoints(array double)
        Set the points of the symbol. Note that the values passed if an
        array containing the x and y values of the points. Example
        array[0] = 1  : x value of the first point
        array[1] = 0 : y values of the first point
        array[2] = 1 : x value of the 2nd point
        ....

    int setpattern(array int)
        Set the pattern of the symbol (used for dash patterns)

    array getpointsarray()
        Returns an array containing the points of the symbol. Refer
        to setpoints to see how the array should be interpreted.

    array getpatternarray()  
        Returns an array containing the pattern.
            
    int setimagepath(char filename)
        Loads a pixmap symbol specified by the filename. 
        The file should be of either  Gif or Png format.

    int setstyle(array int)
        Deprecated in v5.0, will be removed in a future release.
        Use setpattern() instead.

    array getstylearray()  
        Deprecated in v5.0, will be removed in a future release.
        Use getpatternarray() instead.

    Example of usage : crete a symbol to be used as a dash line

        $nId = ms_newsymbolobj($gpoMap, "mydash");
        $oSymbol = $gpoMap->getsymbolobjectbyid($nId);
        $oSymbol->set("filled", MS_TRUE);
        $oSymbol->set("sizex", 1);
        $oSymbol->set("sizey", 1);
        $oSymbol->set("inmapfile", MS_TRUE);
    
        $aPoints[0] = 1;
        $aPoints[1] = 1;
        $oSymbol->setpoints($aPoints);
    
        $aPattern[0] = 10;
        $aPattern[1] = 5;
        $aPattern[2] = 5;
        $aPattern[3] = 10;
        $oSymbol->setpattern($aPattern);

        $style->set("symbolname", "mydash");

      

  OwsrequestObj Class: 
  -------------------------

  Constructor:
        
       request = ms_newOwsrequestObj();

       Create a new ows request object.

  Members:
       int numparams  
          Number of parameters in the request object. Read only.

  Methods:

       int loadparams()
          Initializes the OWSRequest object from the cgi environment variables
          REQUEST_METHOD, QUERY_STRING and HTTP_COOKIE.  Returns the number of 
          name/value pairs collected.

       int setparameter(string name, string value)
          Set a request parameter.  For example :
            $request->setparameter('REQUEST', 'GetMap');

       string getname(int index)
         Return the name of the parameter at *index* in the request's array
         of parameter names.

       string getvalue(int index)
          Return the value of the parameter at *index* in the request's array
          of parameter values.

       string getvaluebyname(string name)
           Return the value associated with the parameter *name*.

                     --------------------------