[mapserver-commits] r8119 - trunk/docs/mapscript/php
svn at osgeo.org
svn at osgeo.org
Wed Nov 26 00:14:18 EST 2008
Author: hobu
Date: 2008-11-26 00:14:18 -0500 (Wed, 26 Nov 2008)
New Revision: 8119
Removed:
trunk/docs/mapscript/php/class-constants.txt
trunk/docs/mapscript/php/class-functions.txt
Modified:
trunk/docs/mapscript/php/index.txt
Log:
delete extraneous files, tweak ReST
Deleted: trunk/docs/mapscript/php/class-constants.txt
===================================================================
--- trunk/docs/mapscript/php/class-constants.txt 2008-11-26 05:03:54 UTC (rev 8118)
+++ trunk/docs/mapscript/php/class-constants.txt 2008-11-26 05:14:18 UTC (rev 8119)
@@ -1,99 +0,0 @@
-*****************************************************************************
- Class Constants
-*****************************************************************************
-
-:Author: Jeff McKenna
-:Contact: jmckenna at gatewaygeomatics.com
-:Last Updated: 2008/07/16
-
-.. contents:: Table of Contents
- :depth: 2
- :backlinks: top
-
-- 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.
-
-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, MS_RASTER, MS_PLUGIN
-
- 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
-
- Alignment:
- MS_ALIGN_LEFT, MS_ALIGN_CENTER, MS_ALIGN_RIGHT
\ No newline at end of file
Deleted: trunk/docs/mapscript/php/class-functions.txt
===================================================================
--- trunk/docs/mapscript/php/class-functions.txt 2008-11-26 05:03:54 UTC (rev 8118)
+++ trunk/docs/mapscript/php/class-functions.txt 2008-11-26 05:14:18 UTC (rev 8119)
@@ -1,64 +0,0 @@
-*****************************************************************************
- Functions
-*****************************************************************************
-
-:Author: Jeff McKenna
-:Contact: jmckenna at gatewaygeomatics.com
-:Last Updated: 2008/07/16
-
-.. contents:: Table of Contents
- :depth: 2
- :backlinks: top
-
-- 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.
-
-The following MapServer functions are available:
-
-::
-
- 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.
-
\ No newline at end of file
Modified: trunk/docs/mapscript/php/index.txt
===================================================================
--- trunk/docs/mapscript/php/index.txt 2008-11-26 05:03:54 UTC (rev 8118)
+++ trunk/docs/mapscript/php/index.txt 2008-11-26 05:14:18 UTC (rev 8119)
@@ -4,17 +4,26 @@
PHP MapScript
*****************************************************************************
+:Author: Danielle Morissette
+:Contact: dmorissette at mapgears.com
+:Revision: $Revision$
+:Date: $Date$
+:Last Updated: 2008/11/24
+
.. toctree::
:maxdepth: 2
install
class-intro
- class-functions
- class-constants
by_example
-
-
+
+
+.. contents::
+ :depth: 2
+ :backlinks: top
+
+
This is a PHP module to make MapServer's MapScript functionalities
available in a PHP Dynamically Loadable Library.
@@ -31,11 +40,7 @@
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:
+Very important notes
---------------------
- Constant names and class member variable names are case-sensitive in PHP.
@@ -47,7 +52,7 @@
side-effects.
-Constants:
+Constants
----------
The following MapServer constants are available:
@@ -171,7 +176,7 @@
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:
+MapObj Class
-------------
Constructor
@@ -609,7 +614,7 @@
value of *nIndex* is -1, which means the last possible index. Returns
the index of the new Layer, or -1 in the case of a failure.
-LayerObj Class:
+LayerObj Class
---------------
Constructor
@@ -946,7 +951,7 @@
load by mapserver. For the other connection types this parameter
is not used.
-ClassObj Class:
+ClassObj Class
---------------
Constructor
@@ -1066,7 +1071,7 @@
int removeMetaData(string name)
Remove a metadata entry for the class. Returns MS_SUCCESS/MS_FAILURE.
-ImageObj Class:
+ImageObj Class
---------------
Constructor
@@ -1127,7 +1132,7 @@
Note: this function works only with 8 bits GD images (PNG or GIF).
-LabelObj Class:
+LabelObj Class
---------------
Constructor
@@ -1285,7 +1290,7 @@
int set(string property_name, new_value)
Set object property to a new value. Returns -1 on error.
-ColorObj Class:
+ColorObj Class
---------------
Constructor
@@ -1311,7 +1316,7 @@
Set red, green, blue values.
-PointObj Class:
+PointObj Class
---------------
Constructor
@@ -1375,7 +1380,7 @@
void free()
Releases all resources used by the object.
-LineObj Class:
+LineObj Class
--------------
Constructor
@@ -1426,7 +1431,7 @@
void free()
Destroys resources used by a line object.
-ShapeObj Class:
+ShapeObj Class
--------------
Constructor
@@ -1613,7 +1618,7 @@
added. Returns true if successful, else return false.
-RectObj Class:
+RectObj Class
--------------
Constructor
@@ -1665,7 +1670,7 @@
void free()
Destroys resources used by a rect object.
-ShapefileObj Class:
+ShapefileObj Class
-------------------
Constructor
@@ -1719,7 +1724,7 @@
releases all resources used by the object.
-ResultCacheMemberObj Class:
+ResultCacheMemberObj Class
---------------------------
Constructor
@@ -1740,7 +1745,7 @@
=============== ====================================================================
-ProjectionObj class:
+ProjectionObj Class
-------------------
Constructor
@@ -1772,7 +1777,7 @@
$poPoint->project($projInObj, $projOutObj);
-ScalebarObj Class:
+ScalebarObj Class
------------------
Constructor
@@ -1814,7 +1819,7 @@
Sets the imagecolor propery (baclground) of the object.
Returns false on error.
-LegendObj Class:
+LegendObj Class
----------------
Constructor
@@ -1852,7 +1857,7 @@
Set object property to a new value. Returns -1 on error.
-QuerymapObj Class:
+QuerymapObj Class
------------------
Constructor
@@ -1879,7 +1884,7 @@
Set object property to a new value. Returns -1 on error.
-StyleObj Class:
+StyleObj Class
---------------
Constructor
@@ -1961,7 +1966,7 @@
$oStyle->removebinding(MS_STYLE_BINDING_COLOR);
-OutputformatObj Class:
+OutputformatObj Class
----------------------
Constructor
@@ -2012,7 +2017,7 @@
Deprecated. See getOption().
-GridObj Class:
+GridObj Class
--------------
Constructor
@@ -2056,7 +2061,7 @@
Set object property to a new value.
-ErrorObj Class:
+ErrorObj Class
---------------
Instances of errorObj are created internally by MapServer as errors
@@ -2108,7 +2113,7 @@
$error = $error->next();
}
-LabelcacheObj Class:
+LabelcacheObj Class
--------------------
Accessible only through the map object (map->labelcache). This object
@@ -2126,7 +2131,7 @@
-SymbolObj Class:
+SymbolObj Class
----------------
Constructor
@@ -2243,7 +2248,7 @@
$oSymbol->set("character", "D");
$oSymbol->set("font", "ttfFontName");
-OwsrequestObj Class:
+OwsrequestObj Class
-------------------------
Constructor
More information about the mapserver-commits
mailing list