Home

"user manual"

Contents

1. See Section 4 3 3 3 Initial Mapstates 4 3 3 3 Initial Mapstates Initial map states set the initial aspects of the layers selection interface when starting using CartoClient un folded nodes selected layers Some of these properties are not modifiable in the layers selection interface hidden layers for instance and thus stay unchanged throughout the session Several initial map states can be created in myMap ini but at least one must be present Each one is identified by a unique initialMapStateId The choice to activate one or another is done client side in client conf client ini Available properties and syntax for layers in initial map states are e maplnfo initialMapStates initialMapStateld layers layerId selected truelfalse if true layer is initially selected e maplnfo initialMapStates initialMapStatelId layers layerId unfolded truelfalse if true the layerGroup is represented as an unfolded node children layers are visible e mapInfo initialMapStates initialMapStateld layers layerld hidden truelfalse if true this layer and its children are not shown in the layers list but are still displayed on the map if they re activated e mapInfo initialMapStates initialMapStateld layers layerld frozen truelfalse if true this layer and its children as well is listed in tree but without checkbox Its selection status defined by selected property thus cannot be changed Example of Initial MapS
2. 1107925732 serverMessages Array imagesResult stdClass Object className ImagesResult mainmap gt stdClass Object isDrawn gt 1 path gt images 110839565198671 7jpg width gt 500 height gt 500 format gt keymap gt stdClass Object isDrawn gt path gt width gt height gt format gt scalebar gt stdClass Object isDrawn gt 1 path gt images 110839565198672 png width gt 300 height gt 31 format gt 168 Calling Plugins locationResult gt stdClass Object className gt LocationResult bbox gt stdClass Object minx gt 536770 840477 miny gt 136770 840477 maxx gt 563229 159523 maxy gt 163229 159523 scale gt 200000 1 4 3 Executing a Query The following code shows how to use queries to display hilighted selection and to retrieve corresponding attributes First thing to do is to declare the SOAP client Class SoapClient will need the WSDL code dynamically generated by script cartoserver wsdl php lt php Sclient new SoapClient http url to server cartoserver wsdl php mapId swiss project swiss The map ID is required also in the request object request mapId swiss project swiss In this example only main map and key map are requested So scale bar s isDrawn attribute is set to false request images request images request im
3. Retrieves message this message myPluginResult message public function renderForm Smarty smarty Translation and display smarty assign message Il8n gt this message Example for use of I18n gt functions server side SCH class ServerMyPlugin extends ClientResponderAdapter 200 Internationalization Hy public function handlePreDrawing request SmyPluginResult new MyPluginResult Message must be translated but not now SmyPluginResult gt message I18nNoop gt hello world return myPluginResult In this example message sent by server has to be translated But as translation process is always done on client we only indicates to the script that there is a text to add to the translation template 5 2 Character Set Encoding As already described in Section 16 2 Character Set Encoding Configuration character set encoding is done using Encoder set of classes It uses functions Encoder encode and Encoder decode e Encoder encode text context converts text from context s character set to CartoWeb s internal character set UTF 8 e Encoder decode text S context converts text from CartoWeb s internal character set UTF 8 to context s character Context can be either config or output default is output Corresponding configuration is set in server ini and client ini see Section 16 2 Charac
4. div if label tr count_characters true lt 10 style width 72px if gt Slabel tr lt div gt See also Chapter 16 nternationalization 17 3 Resources Resources are identified using the r tag r tags have a mandatory type attribute and an optional plugin one First attribute is used to indicate the relative file location files are grouped by types in the file system whereas the second one tells what plugin uses the resource Filename is placed between opening and closing tags For instance to get the logo png file located in htdocs gfx layout type in your template img srce r type gfx layout logo png r alt 121 Templating To get the zoom in icons from the location plugin type lt img src r type gfx plugin location zoom in gif r alt Following list shows all CartoWeb resource types e Htdocs root directory o path htdocs css toto css o Smarty r type css toto css r o generated URL css toto css e Coreplugins o path coreplugins layers htdocs css toto css o Smarty r type css plugin layers toto css r o generated URL layers css toto css Plugins o path plugins hello htdocs css toto css o Smarty r type css plugin hello toto css r o generated URL hello css toto css e Projects o path projects myproject htdocs css toto css o Smarty r type css toto css r o generated URL myproject css toto css e Projects Coreplugins override o path projects myproje
5. To configure table appearance use tables client side rules described in Developer s Documentation Section 2 4 3 Tables 9 2 Server side Configuration 9 2 1 query ini Here are the options that can be set in server s query ini e drawQueryUsingHilight if true query hilighting will use Hilight plugin In this case Hilight plugin must be loaded on server If false objects will be hilighed using MapServer query functionality See also Section 9 3 3 Hilight Configuration default false e noRowld if true row id will not be included in the table In this case the row id will not be displayed in the output table html pdf etc default false 9 2 2 MapServer Query Configuration MapQuery plugin can be used by any plugin to retrieve objects information from MapServer Following options can be set in server s mapquery ini e maxResults Maximum number of results to handle in the query plugin This limit is to avoid high load on the server It should be the client responsibility not to ask too many objects to avoid reaching this limit Ignoring big queries can be done with the ignoreQuery Threshold parameter which give a better behaviour for the user 68 Queries ignoreQueryThreshold Do not take into account the elements selected by a shape rectangle polygon in a query if this shape intersects more than ignoreQueryThreshold objects It should be less than maxResults to have informative messages to the
6. Method only needs map ID as argument try Sresult Sclient gt getMapInfo swiss_project swiss print riSresult catch SoapFault Sfault print fault faultstring P Result is shown below It includes server configuration for the corresponding project and mapfile stdClass Object timeStamp gt 1107043488 mapLabel gt Switzerland keymapGeoDimension gt stdClass Object dimension gt stdClass Object width gt 100 height gt 100 bbox gt stdClass Object minx gt 485000 miny gt 65000 maxx gt 835000 maxy gt 298000 initialMapStates gt Array 0 gt stdClass Object 164 Calling Plugins id gt default location gt stdClass Object bbox gt stdClass Object minx 470000 miny gt 50000 maxx gt 860000 maxy gt 320000 layers gt Array 0 gt stdClass Object id gt swiss layer 1 hidden gt frozen gt selected gt 1 unfolded gt 1 gt stdClass Object id gt swiss_layer_2 hidden gt 1 frozen gt selected gt 1 unfolded gt layersInit gt stdClass Object notAvailableIcon gfx icons swiss project swiss na png notAvailablePlusIcon gfx icons swiss project swiss nap png notAvailableMinusIcon gfx icons swiss project swiss nam png layers Array 0 gt stdClass Object className La
7. Provided that no static icon is defined for a layer in 1ayers ini the icon of the first visible class is used for the layer 6 5 WMS Layers Legends Mapserver could act like a WMS client and retrieved layer from distant WMS server In this specific case layers legends could be retrieved directly from a distant server with SLD support get LegendGraphic method You must also add a metadata on each WMS layer to retrieve its legend icon wms_legend_graphic Here is an example LAYER NAME prov_boundary TYPE RASTER CONNECTION http www2 dmsolutions ca cgi bin mswms_gmap CONNECTIONTYPE WMS METADATA wms srs EPSG 4326 wms name prov bound wms server version spesa et wms format image png wms legend graphic true END END 6 6 Auto Layers In some cases it may be useful to generate several layers out of a single template layer An example would be floors each floor must be displayed with the same color etc but the data source is different different shapefile or different where clause for a database layer In CartoWeb it is possible to add PHP code into mapfiles True mapfiles are then generated by a batch script The generated layers are called Auto Layers 6 6 1 Auto Layers in layers ini 55 Layers First you have to declare the list of auto layers indexes Indexes will be used as suffixes for generated layers autoLayersIndexes indexl index2 Then you can use auto layers j
8. date Ymd Hi table csv if true exported CSV file will be UTF 8 encoded if false it will be ISO 8859 1 encoded default charsetUtf8 false 11 4 DXF Export DXF is a drawing format supported by AutoCAD and assimilated software With CartoWeb it is possible to export a DXF description of the shapes drawn with the outline plugin The latter plugin must be activated before using exportDxf plugin A few configuration parameters are available in c1ient conf exportDxf ini 8l Export Plugins e roundLevel integer indicates how many digits must appear after the decimal point in points coordinates Default is 2 e fileName string specifies the filename naming convention to use It may be static or contain athe generation date under various formats Date formating is performed by indicating between a couple of brackets the keyword date followed by a comma and PHP date like date format see http php net date Default filename convention is export date Ynd Hi dxf Which gives for instance export 20060725 2021 dxf 11 5 Image Output CartoWeb enables to return a raw image map with no HTML It is not an export plugin and thus has not to be activated anywhere CartoWeb simply needs to receive a mode image REQUEST parameter GET or POST For instance http your cartoweb3 recenter x 123456 amp recenter y 654321 amp show crosshair 1 amp mode image 82 PDF Export 12 PDF Export 12 1 Introduction Th
9. mapOverlay result SmapOverlay gt updateMap Slayer At this point the layer and its classes are created or updated Now we need to insert the feature f ms newShapeObj MS SHAPE POINT p addXY 30000 20000 f set classindex result layers 0 classes 0 index A ms newShapeOb j is created and the class index is fetched from the updat eMap return instance msLayer S this serverContext getMapObj getLayer result layers 0 index msLayer addFeature f msLayer set status MS ON This example also show that you can mix standard phpMapscript and mapOverlay code 3 2 3 Filter data Slayer new LayerOverlay Slayer gt name field Slayer gt data geom FROM SELECT gid geom name FROM fields WHERE farm id farmId AS foo USING UNIQUE gid USING SRID 1 196 Dynamic mapfile modifications mapOverlay S this serverContext getPluginManager mapOverlay mapOverlay updateMap layer The para field of the field layer is update to only display some informations S armId is defined elsewhere 3 2 4 Debugging At any time you can see the result of the modifications by calling this serverContext getMapObj save tmp debug map This will save the updated mapfile to tmp debug map 197 Using the Security Infrastructure 4 Using the Security Infrastructure 4 1 Introduction This chapter describes the s
10. option selected frame noresize This is correct dl compact compact gt input checked checked input readonly readonly input disabled disabled option selected selected frame noresize noresize Here is a list of the minimized attributes in HTML and how they should be written in XHTML dl compact compact gt lt input checked checked gt lt input readonly readonly gt lt input disabled disabled gt lt option selected selected gt lt frame noresize noresize gt 6 4 5 Id vs Name HTML 4 01 defines a name attribute for the elements a applet frame iframe img and map In XHTML the name attribute is deprecated Use id instead This is wrong lt img src picture gif name picturel gt This is correct lt img src picture gif id picturel gt Note To interoperate with older browsers for a while you should use both name and id with identical attribute values like this img src picture gif id picturel name picturel gt IMPORTANT Compatibility Note To make your XHTML compatible with today s browsers you should add an extra space before the symbol 6 4 6 Image alt 209 Code Convention alt attribute is mandatory for img gt tag in XHTML But it can and sometimes should have a void value alt is used to specify a replacement text when image is not loaded image unavailable not yet loade
11. FROM roads europe edges LIMIT 3 id source target cost reverse cost 4 4 4 4 LI X Z 2 3 SCH 4 2 a 3 rows We can see that it contains NULL values for the cost column The function update_cost_from_distance can update the cost column with the distance of the lines contained in the geometry table attached to each edge SELECT update_cost_from_distance roads_europe The costs are now id source target cost reverse cost 4 4 4 R 1 1 d 2 6357 EE 2 S en 5349 9592150392 S l Sc 6 ELE 3 lignes Then you need to add the column which will contain the town labels which will be shown in the drop down list for selecting the two points of a path The label information is contained in the roads table which was originally imported using the shp2pgsql utility The following commands will create a temporary table 29 Installation fill it with the town information and then update the vertices table The towns contained in the shapefile may not be on the exact same point that the intersections of the roads Thus all intersections which are in a distance less that 2000 meters are associated to the town label This distance may be adjusted according to the dataset you are using CREATE TABLE roads source town AS SELECT DISTINCT t txt source id distance PointN r the geom 1
12. U users USERNAME 111 V View deletion 106 View loading 105 View recording 106 View update 106 Views 103 Views configuration 103 W weightFullextent 61 weightOutlineLine 73 weightOutlinePoint 73 weightOutlinePoly 73 weightOutlineRectangle 73 weightPan 61 weightQueryByBbox 68 weightQueryByCircle 68 weightQueryByPoint 68 weightQueryByPolygon 68 weightZoomin 61 weightZoomout 61 wins 127 WMS Legend 55 wmsBrowser 59 wms_legend_graphic 55 Z zoomFactor 62 246
13. add the following at the bottom of the layers definition section LAYER NAME cartoweb point outline EE RISINBIS CLASS 299 Create a New Project STYLE SYMBOL circle COLOR 0 0 205 SIZE END LABEL TYPE TRUETYPE FONT Vera EZ 7 COLOR 0 Q 0 OUTLINE COLOR 255 255 255 RFOSITION Le END END END LAYER NAME cartoweb_line_outline TYPE LINE TRANSPARENCY 100 CLASS STYLE OUTLINECOLOR 255 0 0 SYMBOL line dashed SIZE 3 END LABEL TYPE TRUETYPE FONT Vera SIZE 7 COLOR Q 0 0 OUTLINE COLOR 255 255 255 ANGLE auto POSITION uc END END END LAYER NAME cartoweb polygon outline TYPE POLYGON TRANSPARENCY 60 CLASS STYLE SOINS EE LS 2 OUTLINECOLOR 0 0 O END LABEL TYPE TRUETYPE FONT Vera STAR 7 OUTLINECOLOR 255 255 255 COLOR 0 0 0 POSITION CO END END END Launch the setup script This step is compulsary to convert ini in files into ini configuration files read by Cartoweb By clicking on the reset session button in the browser window you should see new buttons in the toolbar and the corresponding folder in the leftbar 240 Create a New Project C 8 Pdf Printing As done for the outline plugin add exportPdf to the list of plugins to load on both client and server side After launching the setup script and refreshing the application reset session you should be able to test the new functionality as a new folder appeared in the interface But a warning printed in the pd
14. inversedlborderhilight 10 4 4 ToolPicker Default Values If the toolPicker is used with the Outline plugin the default values for Color OutlineColor Transparency and Symbol are set in the mapfile The default layer name are cartoweb point outline cartoweb line outline and cartoweb polygon outline See Section 10 2 1 outline ini 10 4 5 Examples of Usage toolPicker 4 outline point symbol this will call the symbol picker id 4 the input id is outline point symbol and the output id will be outline point symbol too Toores TAI engen laine jerome colo enel xxi this will call the color picker the input id is outline point color and the output id will be color return toolPicker 4 1 symbol_input color_input return symbol return color 78 Annotation and Redlining this will call the symbol picker and the color picker the input id is symbol input for the first tool here the symbol picker and color input for the second tool color picker and the output id will be return symbol for the first tool and return color for the second 10 4 6 Creating New Tools You can add new tools Add the new tool name in the toolArrayRef array at the begining of the script var toolArrayRef new Array colorPicker hashArray pencilArray symbolArray Zaemer ener Y 2 Create the following four functions these functions can be empty function vourloolinzt rinpubvalue x 4 STEE EE
15. numRows gt 2 totalRows gt 0 offset gt 0 columnlIds gt Array 0 gt attribute 3 1 gt attribute A columnTitles Array 0 gt attribute 3 1 gt attribute A noRowId gt rows Array 0 gt stdClass Object rowId 123 cells Array 0 gt Foo 1 Se 84 98 1 gt stdClass Object rowId gt 456 cells Array 0 gt Bar 1 gt 32 47 172 New Plugins 2 New Plugins 2 1 What are Plugins 2 1 1 Definition CartoWeb plugins are modular packages of files PHP classes HTML templates images and other resources that are used to perform a dedicated action main map formatting layers browsing interface map browsing zooming paning etc queries user authentication search interfaces and many more 2 1 2 Plugins and Coreplugins There are two kinds of plugins e coreplugins fundamental plugins that perform low level actions such as map size handling browsing tools layers selection Plugins that are frequently used in many CartoWeb applications may be included in this category as well They are always available and activated As a result other plugins may interact with them Coreplugins files are grouped in the corepl1ugins directory e plugins normal plugins perform more specificactions and are not always activated Normal plugins activation is done by setting the loadPlugins parameter in client conf client ini f
16. projects lt yourProjectName gt coreplugins layers templates layers tpl projects lt yourProjectName gt coreplugins layers htdocs projects lt yourProjectName gt coreplugins layers htdocs js projects lt yourProjectName gt coreplugins layers htdocs js layers js If you don t need to override the CSS file it is no use to create a css directory containing a copy of the upstream layers css If you want to neutralize a file you can simply override it with a blank version For instance to have a void output create a template file with no content It is also possible to override the plugin configuration files by adding lt pluginName gt ini files in the project configuration directories client_conf and or server conf mapId When the plugin is launched upstream and project configuration files are merged so you don t need to duplicate the configuration parameters that stay unchanged with your adapted plugin 2 3 3 Extending a Plugin Extending a plugin is required when your adaptations involve deep changes such as additions or overloadings of methods in the plugin PHP classes 179 New Plugins To do so you will have to extend the plugin PHP classes in the object oriented programing definition Since plugin main classes are named using a plugin name based convention eg ClientLayers and ServerLayers for the CartoClient and CartoServer main classes of the layers coreplugin and since extended classes cannot have the same n
17. t the geom AS d FROM roads europe r town t roads europe vertices WHERE t txt UNK AND distance PointN r the geom 1 t the geom 2000 AND geom id source id ORDER BY t txt d CREATE TABLE roads source town uniq AS SELECT FROM roads source town a WHERE a txt IN SELECT b txt FROM roads source town b where a txt b txt LIMIT 1 AND a d IN SELECT b d FROM roads source town b WHERE a txt b txt LIMIT 1 ALTER TABLE roads europe vertices ADD COLUMN txt character varying 50 SELECT AddGeometryColumn roads europe vertices the geom 1 POINT 2 UPDATE roads europe vertices SET txt SELECT DISTINCT txt FROM roads source town uniq WHERE roads europe vertices geom id roads source town uniq source id clean the temporary tables DROP TABLE roads source town DROP TABLE roads source town uniq The last step is to fill the geometry column of the vertices table CREATE TABLE roads europe vertices geom AS SELECT v id v geom id v txt startPoint geometryn r the geom 1 AS the geom FROM roads europe r LEFT JOIN roads europe vertices v ON v geom id r source id INSERT INTO roads europe vertices geom SELECT v id v geom id v txt endPoint geometryn r the geom 1 AS the geom FROM roads europe r LEFT JOIN roads europe vertices v ON v geom id r target id DELETE FROM roads europe vertices INSERT INTO roads europe vertices SELECT DISTINCT ON id FROM roads europe vertices geom DROP TABLE roads
18. the LOG_HOME variable has a special meaning it is expanded to the log directory of the CartoWeb distribution One powerful feature of Log4php among others is the ability to filter log message 220 Logging and Debugging according to their severity Each log message has a severity which may be ALL DEBUG INFO WARN ERROR FATAL OFF As described in the configuration file comments the lines like 1og4php 1ogger CLASSNAME can be used to apply a filtering of the log message for the class CLASSNAME For instance adding a line log4php logger Cartoclient INFO means that only log message of severity INFO or above will be printed This is useful to avoid displaying unwanted log messages 9 2 3 Default Log File Location Default log messages will be written to Llog cartoclient log and the CartoServer ones to log cartoserver log Of course the Log4php configuration files can be adapted to write messages elsewhere 9 2 4 Using Log4php in Source Files The Log4php usage in code is quite easy 1 For objects it is advised to store a Logger object as an instance variable class MyClass Qvar Logger SS private Slog ell Cei ErUCEOR SCH Se EE on EES EE this log amp LoggerManager getLogger CLASS life mete di parent NE OnDSit edt NT For non object a reference to a Logger object can be obtained this way Slog amp LoggerManager getLogger METHOD Tip Usin
19. to delimit PHP code not the lt P BS shorthand 6 3 1 8 Naming Conventions 6 3 1 8 1 Classes Classes should be given descriptive names that should always begin with an uppercase letter Avoid using abbreviations 205 Code Convention 6 3 1 8 2 Functions and Methods Functions and methods should be named using the studly caps style also referred to as bumpy case or camel caps function handleKeymapTool Functions and methods names should always describe actions Developpers should declare the access modifiers public private protected for each function or method 6 3 1 8 3 Constants Constants should always be all uppercase with underscores to seperate words 6 3 2 Comments 6 3 2 1 Php Doc Comments To improve php code and object structure readability automatic code documentation is implemented in CartoWeb It is based on specific comments describing classes methods interfaces and objects See Chapter 8 Code Documentation for more information 6 3 2 2 Inline Comments As often as necessary the developers should add code comments to explain verbosly the purposes of commands 6 4 HTML Coding Standards In CartoWeb mainly for the templates HTML coding should respect some rules To take benefits of recent browsers enhancements and above all to make HTML codes easier to read and maintain some HTML coding guidelines should be followed e for indentation preferably use 2 white spa
20. 96 e defaultResolution 96 e activatedBlocks NULL e filename map date dMY His pdf e overviewScaleFactor 10 e overviewColor NULL e overviewOutlineColor red output redirection 85 PDF Export e allowedRoles empty ie nobody e importRemotePng false e extraFonts NULL 12 2 2 Formats Configuration Formats are described as a set of formats sub objects For instance formats A4 bigDimension 297 formats A4 smallDimension 210 formats A3 label A3 formats A3 bigDimension 420 Format ids A3 A4 etc must match those listed in general formats e formats lt format_name gt Jabel string user friendly name Is translated using Cw3I18n device Chapter 16 Internationalization e formats format name bigDimension float largest sheet side in distUnit e formats format name smallDimension float smallest sheet side in distUnit e formats format name horizontalMargin float optional if set overrides general horizontalMargin for the given format e formats format name verticalMargin float optional if set overrides general verticalMargin for the given format e formats format name maxResolution integer optional maximum allowed resolution for the given format If selected resolution is above maxResolution it will be set to maxResolution value e formats format name allowedRoles comma separated list of strings list of roles allowed to use the form
21. Plugins main classes client and or server if any must extend CartoWeb definedc1ientPlugin and or ServerPlugin classes which provide base plugin tools 174 New Plugins For instance class ClientYourPlugin extends ClientPlugin here comes your plugin client class definition 2 2 2 Plugin or Coreplugin First of all you have to determine if you are about to design a simple plugin or a coreplugin To be a coreplugin your plugin must be really generic and present a great interest to the CartoWeb users community since it might be included in the upstream distribution Contact CartoWeb development team for more info In most cases it is better and sufficient to create a simple plugin To activate a coreplugin update the Cartocl1ient getCorePluginNames method in client Cartoclient php and or the ServerContext getCorePluginNames one in server ServerContext php For instance private function getCorePluginNames return array images location layers query mapquery tables yourPluginName To load a regular plugin update the 10adP1ugins parameter from client conf client ini and or server conf mapId mapId ini as in following example loadPlugins auth outline exportHtml 2 2 3 How Plugins Are Called As explained in Section 2 1 What are Plugins plugins are independent aggregations of PHP code that are called by the CartoWeb core classes to perform dedicated action
22. Will be empty if script is executed on a client only trace file or if 223 Performance Tests direct mode is on e Exec MS obj time elapsed while creating Mapserver main object It includes reading the mapfile Will be empty is script is executed on a client only trace file e Exec MS other time elapsed in other Mapserver tasks Will be empty is script is executed on a client only trace file e Exec total time elapsed in total If direct mode is off it also includes time elapsed in SOAP data transmission 10 2 3 Graphical Interface Unix like To have more information about execution times and calls stack you can use a powerful graphical viewer called KCachegrind This tool is available on Unix like environments only On Win32 it can be used via KDE on CygWin KCachegrind is included in KDE package kdesdk To install it on a Debian distribution type apt get install kcachegrind APD package includes a script called pprof2calltree that can translate a trace generated by APD to a file in KCachegrind format To translate a pprof file type pprof2calltree f pprof file gt dev null Redirecting to dev nu11 is needed because script generates a large number of PHP notices Then you can open the resulting file in KCachegrind 226 Upgrading Views Data 11 Upgrading Views Data 11 1 Introduction Views saves given CartoWeb states by recording the plugins session data Only client side plugins implementin
23. about this parameter see Section 4 2 client ini 229 Performance Tests 10 Performance Tests 10 1 Main Parameters This is a non exhaustive list of interesting parameters for CartoWeb performance tests You may want to vary these parameters values when testing performance before and after development of new functionalities e Cartoweb configuration o Local SOAP distant SOAP or direct mode o Data on PC or through NFS o Map size o Number of active layers o Dynamic legends or not Logs and cache o MapInfo cached or not o MapResult cached or not o SOAP XML cached or not o Logs activated or not Map data o Number of layers 10 50 250 10 2 Executing Tests This section describes performance tests execution using APD a debugging profiling tool available as a Zend PHP module 10 2 1 APD Module Installation First thing to do is to install APD s PHP Zend module You can download archive here http pecl php net package apd Follow instructions to compile APD Then load the module by adding the following two lines in php ini zend extension php home lib php extensions no debug non zts 20040412 apd so apd dumpdir tmp apd On a win32 installation 224 Performance Tests zend extension debug ts php lib home Napd dll apd dumpdir c apd traces Path to apd so may vary See also README file in APD archive You may now activate tracing by adding an empty file trace ap
24. are allowed e layers layerld children list of layerIds comma separated list of layerIds these children may be Layers or other LayerGroups e Jayers layerld children switchId list of layerIds comma separated list of layerlds when using switching see Section 6 2 4 Children Switching This option cannot be used together with simple children option e Jayers layerld aggregate truelfalse if true the children objects are not listed in the tree and not individually selectable Default is false e layers layerld label string caption of the layer in the layer tree on the client this is a raw label before any internationalization The 118n scripts automatically include this label in the strings that can be translated e Jayers layerld icon filename filename of the static picto that illustrates this Layer in the layer tree The path is relative to myMap ini See also Section 6 4 Layers Legends for a description of the automatic legending process e Jayers layerld link url provides a link for the layer e g to some metadata makes the caption in the tree clickable e layers layerld rendering treelblocklradioldropdown indicates how to display the LayerGroup children o tree default value children layers are rendered below the LayerGroup with an indentation If children are not declared as frozen or hidden they will be preceded by a checkbox input A node folding unfolding link is displayed before the L
25. chameleon ext e Uncompress the archive and follow steps described in chameleon ext README txt file to compile it e Copy chameleon ext php modules chameleon so extension to your php extensions directory and load it in your php ini Tip If using Debian or Ubuntu OS you may install our precompiled package apt get install php5 chameleon See Appendix A Mapserver Debian Installation for instructions about apt Warning If your PHP isn t running as CGI don t forget to restart your web server 20 3 Plugin Activation To activate the plugin load mapOverlay and wmsBrowser plugins from both CartoClient and CartoServer configuration files client_conf client ini and server conf mapId mapId ini For instance 127 WMS Browser loadPlugins mapOverlay wmsBrowser 20 4 Position to Which Insert WMS Layers To insert a WMS layer on the map you must specify after which mapfile layer you want to insert it The layer will be added after the last added WMS layer or after this mapfile layer if no WMS layer has ever been added To do so in server conf mapId wmsBrowser ini specify the mapfile layer name in the wnsInsertLayerAfter parameter 20 5 Perform Added WMS Layers Appearance in the Layers List If you want to perform added WMS layers appearance in the layers list you still have to affect them a parent LayerGroup Specify in client_conf layers ini the LayerGroup name in the userLayerGroup parame
26. comma separated coordinates eg 10 5 20 15 5 28 recenter x re centering new x coordinate recenter y re centering new y coordinate show crosshair 0 orl default O If 1 display a crosshair on recenter x recenter y recenter scale new scale id_recenter_layer re centering on objects layer to look for IDs id_recenter_ids re centering on objects list of IDs comma separated shortcut id ID of the selected map size see Section 7 2 Server side Configuration e Query plugin o o query layer layer to look for IDs query select IDs of objects to add to selection query unselect IDs of objects to remove from selection query policy selection policy POLICY XOR POLICY UNION or POLICY INTERSECTION default is POLICY XOR query maskmode 0 or l default is O If 1 will show selection as a mask query hilight 0 or l default is 1 If 0 won t shows selection hilighted query return attributes 0 or 1 default is 1 If 0 won t return attributes other than IDs query return table 0 or 1 default is 1 If O won t return any table results query clear U orl default is 0 If 1 previous query results are purged even if they were marked as persistent Note that for Query plugin display of extended selection must be disabled in client s query ini in order to use above parameters see Section 9 1 Client side Configuration 2 4 2 3 Example Th
27. etc Eventually push the Update button 106 Editing 14 Editing The eait plugin allows users to edit geographical data from their web browser 14 1 Client side Configuration 14 1 1 edit ini Here are the options that can be set on the client general allowedRoles comma separated list of the roles that are allowed to use the edit plugin insertedFeaturesMaxNumber integer number of new features that user is allowed to draw for insertion in the database Set it to O if user is only allowed to update or delete features editLayers comma separated list of layers that are editable editResultNbCol number of columns to use to display the attributes table editDisplayAction this string parameter is used to tell if the validate and cancel buttons have to be displayed also under the attributes table If empty or both buttons will be displayed both in the folder and under the attributes table If folder buttons will be displayed only in the folder 14 2 Related Elements in Mapfile 14 2 1 Metadatas Specific metadatas must be set in the mapfile for the editable layers METADATA END edit table edit poly 4 PostGIS table edit geometry column the geom PostGIS geometry column edit geometry type polygon PostGIS geometry type Ueyxoblis eseme HI edit attributes parc id name string culture string surf parc typelinteger list of the editable edit table string name of the postGIS table to ed
28. europe vertices geom n Now all is set up correctly for using the shortest path function on these data But to include the routing fonctionnalities in a custom project we also must respect some rules dictated by the routing plugin 1 2 5 1 3 Routing Plugin Database Configuration The two things to do are to create the routing results table In this example the table is routing results CREATE TABLE routing results results id integer timestamp bigint gid integer i SELECT AddGeometryColumn routing results the geom 1 MULTILINESTRING 2 30 Installation e create the routing results seg sequence CREATE SEQUENCE routing results seq INCREMENT 1 MINVALUE 1 MAXVALUE 9223372036854775807 START 1 CACHE 1 1 2 5 1 4 Mapfile Configuration In the mapfile you must include the routing layer its connection to the database a symbology for the route and a first route using a unique identifier The data parameter will be overwritten by the routing plugin to draw the route chosen by the end user Example LAYER NAME graph TIPE LINE TRANSPARENCY 80 CONNECTIONTYPE postgis CONNECTION user DB_USER password DB_PASSWD host DB_HOST dbname DB_NAME DATA the_geom from SELECT the_geom from routing_results as foo using unique qid using srid i TEMPLATE t CLASS NAME 0 STYLE SYMBOL Ecl SIZE COLOR OZ i gal END END END 1 2 5 1 5 General Configuration For the demo we s
29. method with the following signature static function myCallbackMethod table id column id cus eeler Ses rcu NT Icona e SAUL 22098 return cell value 2 4 3 2 7 Cell Filter Batch public function addCellFilterBatch groupId tableId columnId inputColumnIds callback Cell filter rules used in batch mode allow to modify content of all cells of a given column Values of columns given in parameter inputColumnIds will be transfered to the callback method for cells content calculation Values for all rows are transfered at the same time Parameter ca11back should contain a pointer to a callback method with the following signature 189 New Plugins static function myCallbackMethod table id column id array IO Ss ewexees fl teglan LU Vipera db row do Weouliniia ZY ME ONE WS NETS WIS PT LI ee enee A tentum i Ss sede il eem 2 5 cosa tyalie 2 aco 2 return array 0 gt cell_value_row_1 1 gt cell value row 2 2 4 3 2 8 Row Unselector public function addRowUnselector groupId tableId Scolu mnrd S rOwlds Row unselector rules allow to remove some rows from a table Parameter rowIds contain IDs of row that must be removed 2 4 3 2 9 ColumnAdder public function addColumnAdder groupId S tableId columnPosition newColumnIds inputColumnIds callback Column adder rules allow to add one or more columns to the table Parameter newColumnIds should
30. type xsd double gt lt element name miny type xsd double gt lt element name maxx type xsd double gt lt element name maxy type xsd double gt all complexType e minx minimum x coordinate e miny minimum y coordinate e maxx maximum x coordinate e maxy maximum y coordinate lt complexType name Point gt lt all gt lt element name x type xsd double gt lt element name y type xsd double all lt complexType gt e x x coordinate 141 Calling Plugins y y coordinate lt complexType name ArrayOfPoint gt lt complexContent gt restriction base encll Array attribute ref encll arrayType wsdl arrayType types Point restriction complexContent lt complexType gt array list of points lt complexType name Shape gt lt all gt lt element name className type xsd string gt lt element name x type xsd double minOccurs 0 gt lt element name y type xsd double minOccurs 0 gt lt element name minx type xsd double minOccurs 0 gt lt element name miny type xsd double minOccurs 0 gt lt element name maxx type xsd double minOccurs 0 gt lt element name maxy type xsd double minOccurs 0 gt lt element name points type types ArrayOfPoint minOccurs 0 gt eui complexType className shape class name Point Bbox Rectangle Line or Polygon e x x coordinate Poin
31. 11 2 3 Upgrade Configuration See Section 13 2 2 Mam Views Controller Only two of these parameters are related to views upgrading viewLogErrors enables to log outdated views loadings whereas viewUpgradeOutdated is useful to activate or not the upgrading device if 228 Upgrading Views Data deactivated outdated views parts are discarded 11 3 Customizing Views Processing Using Project Hooks CartoWeb offers the ability to add some project specific controls hooks within the views processing For now only one hook is available right before the data of the loaded view is merged with the current session data See method ViewManager handleView in client Views php To create hooks write a PHP class extending the basic viewHooks class defined in client Views php The extended class must be saved in a file with the same name located in your project plugins views client directory If the latter directory does not exist simply create it The standard views plugin is not required to have hooks working Finally set the viewHooksClassName with your extended class name in client ini configuration in client ini viewOn true viewStorage db viewablePlugins location layers query outline viewMetas author viewHooksClassName FoobarViewHooks php projects your project plugins views client FoobarViewHooks php SCH class FoobarViewHooks extends ViewHooks see ViewHooks
32. 127 20 3 Plugim Activation eege Eege 127 20 4 Position to Which Insert WMS Layers eese 128 CartoWeb Documentation 20 5 Perform Added WMS Layers Appearance in the Layers List 128 AEN Q 129 2T T Introduction xus ceo gtt ees ee eda i 129 21 1 1 Browser Compatibility eene 129 21 2 Make Your Project AJAX Enabled 129 21 2 1 Clientini Configuration eee 130 21 2 2 Templates Adaptation 2 4445 peret ete ser eoes eoe phe sewetoone 130 PANIS UP E Tm 131 22 T S THEEOGUCEIOD EE 131 22 2 General Behavior iiie EHE REIR EIER E ceases 131 22 3 Server side Configuration EE 131 22 3 1 Mapfile Configuration eere 131 22 3 2 geostat ini Configuration sse 131 22 4 Client side Configuration eene 132 pis TOOP Nen 133 23 1 ae Te WE 133 2352 Basie RE 133 23 2 1 Mouse Timeout Asynchronous sees 133 23 2 2 Area Asynchronous qe edi ege tope eee Pip estate Reed 134 23 2 3 Area DIrect isi e Haeduis 135 25 3 Custom Folter oce oio cu UNDA VI eege 136 23 3 LE Templates i e EH DIERUM UID UI 136 23 3 2 Extending CLASSES eoi obrero qut e traer te uh bine Soe 137 E 138 HI D seloperNlan dlu EE 139 I Calling PIU Guns 5 5 n HORE RD XR e e ICODE EN U ID RR EUM 140 IT Standard KEE 140 IT Simple Types is Er S DR
33. 4 5 Developer Specific Configuration Some configuration parameters can be activated to retrieve more display information targetted to the developers like special timing messages or setting the Php configuration to display notices on the page These configuration options are described below Warning These parameters will be overrided by the profile parameter See Section 4 1 Common client ini and server ini Options These parameters are available in client_conf client ini for client and server conf server ini for server e showDevelMessages truelfalse Shows developer messages e developerIniConfig truelfalse Sets ini parameters useful during development 45 Caches Configuration 5 Caches Configuration Several different caching mechanisms are available in CartoWeb for maximum performances The different types of caches are described in the next chapters 5 1 Smarty Cache The templating system used in CartoWeb is Smarty which offers two level of caching for templates One is compilation of templates into the templates c directory and the other is static caching of templates In CartoWeb because pages are very dynamic only the first level of caching is used The caching feature of Smarty is totally transparent to the user However an option can be set in the client conf client ini configuration file to enhance performances e smartyCompileCheck truelfalse Set this to false in production to impr
34. Cache This one is also a server side only cache caching requests at the lowlevel XML SOAP exchange This means this cache is only effective when direct mode is not used and can be used for any webservice for which the output only depends on the input arguments 5 6 Caches Configuration 5 6 1 Rationale All cache configuration name are in the form noxxxName where xxx is the name of the cache This is so so that if the parameter is not available its default value will be false meaning that all caches are active by default for maximum performance Warning These parameters will be overrided by the profile parameter See Section 4 1 Common client ini and server ini Options 5 6 2 Client and Server Cache Options These parameters are available in client_conf client ini for client and server conf server ini for server e noWsdlCache truelfalse disables the caching of wsdl ignored if useWsdl is false e noMapInfoCache truelfalse disables the caching of MapInfo requests 5 6 3 Server Cache Options 47 Caches Configuration These parameters are available in server conf server ini e noMapResultCache truelfalse disables the caching of getMap requests e noSoapXML Cache truelfalse disables the caching of SOAP XML requests 48 Layers 6 Layers 6 1 Introduction Geographical data are most often apprehended as thematic layers you may have a layer Rivers a layer Aerial view a la
35. CartoWeb Download 2 eret reed 17 1 1 3 Command Line Installation esses 18 1 1 4 Windows Installation sseeeeren 21 1 2 DOmOS EE 24 1 2 1 Introduction 2 2 6i o ee e D OD eive idus 24 1 2 2 Installation eic re nonet hi Sepe ed o v i ood oben utet 24 1 2 3 Routing specific installation eese 26 1 2 4 Locate Plugin specific installation 27 1 2 5 Plugins extensions further information 24 CartoWeb Documentation Eet 33 2 T Introduction eie quelle d quie een adds 33 2 2 Global Directory NL EE 33 PX durus qe aiaa 34 24 PIOJS US ede oi EE 35 5 Projects Handling i HE RIBERA nU UU NR 36 Hid age Mee EE 36 3 2 Using Projects auucsivogevvone s Orem a etae CAR TR MR US SERRE EE PURUS EEES 37 3 2 1 Apache Environment Variable sss 37 3 2 2 Using current_project txt 145 2 2 0 a 9 te ertet 37 352 3 Using a Gel E oos rta isetel 37 3 2 4 Using the Projects Drop down List eee eeeceeeteeeeeees 37 3 2 5 Using a Modified client php 38 4 Configuration Piles 3 535 5 I HERE etui e e oed t EEN 39 4 1 Common client ini and server ini Options esses 39 S PAIS e WEE 39 4 3 Server Configuration Files teet I tenete iere etn eu pon 42 4 3 1 Introduction 2 2 eei e teet Eddie 42 4 3 2 Main Server Config
36. CartoWeb client known as CartoClient on one machine and have it requesting a CartoWeb server known as CartoServer located on a separated server A CartoServer can be called by several CartoClient simultaneously On the other hand a CartoClient can query several CartoServer for instance in the frame of different projects Section 3 4 2 Projects 10 Architecture CartoWeb offers two access modes e asa wWeb service CartoClient and CartoServer then interact using remote procedures based upon SOAP http www w3 org TR soap12 asastandalone application Procedures are then performed directly between CartoWeb components bypassing the SOAP calls Direct mode SOAP mode 11 Architecture 1 aas a Multi client mode Of course it is possible to combine the above architectures as shown on the following figure 3 4 Modularity Projects and Plugins 3 4 1 Plugins 12 Architecture CartoWeb buzzword is modularity The application is built as a set of bricks that interact with each other Those bricks are called plugins Each plugin performs a special group of tasks such as map browsing layers management images properties users permissions data objects querying exportation and much more CartoWeb is shipped with a set of standard plugins that can be separately activated or not It is possible to write your own plugins or customize existing ones as well 5 H 1 1 H H H d SZ P
37. Hole Names The auth plugin configuration described in the previous section references the notion of users and roles Basically a role can be any string the application will only use them as a way to check if a feature is allowed or not However a set of role name have a special meaning They are described below Special Roles all This role belongs to any user It is useful in case a permission should not be restricted access loggedIn This role is given to all users who have logged in the application It means they are identified to the system with a username anonymous This role is given to all users not known to the application This role is attached to anyone who has not yet entered her username and password Example 15 1 Special Role Name Usage general allowedRoles loggedIn 15 3 Global CartoWeb Permissions The whole application can be denied access to anonymous users only authenticated or a set of users can access the application Anonymous users arriving on the main page will see a login dialog page if they have no rights to view the page if the auth plugin is not loaded they will simply see a denied page This feature can be parametrized on the CartoClient in the client ini configuration file e securityAllowedRoles list List of roles which are allowed to access the 112 Security Configuration cartoweb Set to all if no if no restriction is given see Section 15 2 2 Special Role Names for ty
38. MySuperClass 217 Code Documentation Kee KR imt SC public simpleVariable var MyVarClass A public simpleObjectVariable This variable needs a description Tovar String Sc public notSoSimpleVariable param int yf function __construct SinitialValue DAG ts CON Sie al E 8 this simpleVariable SinitialValue this simpleObjectVariable NULL this notSoSimpleVariable param int SE function setSimpleVariable newValue this simpleVariable newValue EE EE S function getSimpleVariable return this simpleVariable This is a short description for method This is a longer description Don t forget to have a look here link MyLinkClass myLinkMethod blah blah param string description of first parameter param MyParamClass description of second parameter return boolean true if everything s fine isee MyInterestingClass d function myMethod myFirstParameter SmySecondParameter blah blah return true see MyInterface myImplementingMethod SZ function myImplementingMethod myParameter blah blah return true function myOverridingMethod myParameter blah blah 218 Code Documentation return true 2 9 Logging and Debugging 9 Logging and Debugging 9 1 Introduction This chapter is about the logging framework used in CartoWeb and gives some tips for
39. Run Deployement It should be possible to extract the archive launch a script edit few options and be ready to use the application with the built in data set see test mapfile 6 2 3 Development Configuration Developers should absolutely set the following variables to true in their config on both client and server sides Warning These parameters will be overrided by the profile parameter See Section 4 1 Common client ini and server ini Options e showDevelMessages true e developerIniConfig true 6 2 4 Unit Tests Code should produce no notices before any CVS commit Code should pass all tests This also means that the developpers should add and run unit tests for every new 203 Code Convention feature they add See Chapter 7 Unit Tests 6 3 PHP 6 3 1 Coding Style Developers should use the PEAR coding standards as the coding style reference in CartoWeb with some exceptions Have a look at http pear php net manual en standards php Following are briefly described some guidelines to respect 6 3 1 1 Indent Developers should respect some indentation conventions when writing PHP code in CartoWeb e 4spaces indentations are recommended the use of tabs for indentation is prohibited use space instead select the appropriate preferences in your favorite code editor if needed 6 3 1 2 Control Structures Control statements should have one space between the control keyword a
40. STATUS ON TYPE POLYGON CONNECTIONTYPE POSTGIS CONNECTION dbname edit db user www data password www data host localhost DATA the geom from select the geom oid parc id name culture surf parc type from edit poly TEMPLATE ttt estes LABELITEM name CLASS NAME class SPELE 108 Editing COLOR 50 50 255 OUTLINECOLOR 255 50 50 END LABEL Kat END END METADATA id attribute string parc id query query returned attributes parc id name culture surf parc type edit table edit poly 4 PostGIS table edit geometry column the geom PostGIS geometry column edit geometry type polygon PostGIS geometry type eat uel 21 edit attributes parc id name string culture string surf parc typelinteger list of the edital edit filter mapserver filter END END Warning Make sure that your edit attributes list does not include spaces between attributes 109 Security Configuration 15 Security Configuration 15 1 Introduction Access to different parts of the CartoWeb can be allowed or denied according to who is currently using the application The following concepts are used in this chapter Security Mechanisms Concepts User Representation of a user accessing CartoWeb If the user is not logged in she is rerefenced as the anonymous user Role A user can have zero or more roles associated to her These roles are used to allow or deny a permission to a resource of feature Pe
41. They are saved in a vViewsUpgrade php file located in the same directory than the plugin client side class file for instance coreplugins location client Filters naming convention is lt UppercasedPluginName gt V lt initialVersion gt ToV lt initialVersion t1 gt Some basic methods rename remove add are available in every filters but you may 227 Upgrading Views Data define your own transformers methods Details about basic methods are given in ViewUpgrader class documentation CartoWeb API manual At least an upgrade filter class must redefine the ca11riiters method that indicates the sequence of transformations to apply An example of filters might be php coreplugins location client ViewsUpgrade php E Clase rese i var game arkanoid var Sl qx Upgrades from V1 to V2 SZ class LocationV1ToV2 extends ViewUpgrader protected function callFilters PENIS radad eener LOCOS Upgrades from V2 to V3 Sa class LocationV2ToV3 extends ViewUpgrader protected function callFilters this rename test foo this add bar new test this add someProperty 2 Stes gt cle t caranba eS oe this remove someProperty Warning It is the responsibility of each developer to provide adapted filters when he she updates plugin session containers Warning Upgrade filters do not support non object typed plugin session containers
42. aene paa 54 G3 WMS Dxtyers Legends teste Create 23 0 6 Auto Layers dci E RUE ONERE OSEE EA 55 6 6 1 Auto Layers in layers ini EEN 55 6 6 2 Mapfile Templates oerte en e ENee 56 6 0 3 Batch EH d re o Re tuts ad tetur vts 57 6 7 Layer Reorder Plugin sessesssesssesessseesseesseessersseresseeesseessresseessee 58 6 7 1 EK EE 58 0 7 2 Layer exclusion ueber ii 58 6 7 3 RENE EE 58 6 8 WMS Browser Plugin setis estere eh Reed edd eae pede 59 6 8 1 Install Chameleon XML parser php API 59 6 8 2 Plugin activation steterant rn theses Deet 59 6 8 3 Position to which insert WMS layers 60 6 8 4 Perform added WMS layers appearance in the layers list 60 Ta Navigatio EP H 61 7 1 Client side Configuration sese 61 7 2 Server side Configuration eiu ec eee tectae e ete dotes pocos n EUR 62 7 3 Related Elements Elsewhere 5 2 nete ettet 63 5 Image Format Options a otto degen ed anei ce uo bove etate 64 8 1 Client side Configuration essere 64 8 1 1 Main Map OpUDfIS EE 64 8 1 2 Keymap and Scalebar Options sssss 64 8 2 Server side Configuration RE 64 8 3 Related Elements in Mapfile AA 65 8 3 1 General Image KEE 65 8 3 2 Automatic Image Type Switch sesss 65 Or AT EEN 67 9 1 Client side Configuration sse 67 S ET gury NEE EE 67 9 1 2 Tables Configuration ai e
43. blocks description and positioning Description depends on the block type and is detailed in following sections Blocks are positioned one after the other beginning by the ones with the lowest z Index vertical position the low zIndex ed blocks are placed under the high zIndexed ones ie closer to the background When blocks have equal zIndexes those with lowest weight are processed first Eventually if blocks have identical zIndexes and weights the system will use general activatedBlocks order to make its choice Blocks with different zIndexes wil not interact except if one is marked has the other s parent in that situation the child block will be located inside the parent block 94 PDF Export instead of using the general referencial All following siblings will share the same parent block except if they have a inFlow false property Parent blocks must have lower zIndexes than their children For instance blocks mainmap zIndex blocks mainmap weight NT blocks overview parent mainmap 2 blocks overview zIndex Block margins are used to position a given block Horizontal positioning is achieved by specifying the horizontalBasis the side of the document leftlright used as a reference and the norizontalMargin the latter value tells how far in distUnit the block will be spaced from the reference line For instance to position a block at 10mm from the document right side use the following configuration
44. can find client php profile PROFILENAME The profile to use development production custom NOTE default is development clean views Clean views must be used with clean clean accounting Clean accounting must be used with clean 1 1 3 2 Examples of Use 1 1 3 2 1 Basic Setup To perform a basic setup of CartoWeb such as if you want to run the demo project type lt PHP INTERPRETER gt cw3setup php install base url http www example com cartoweb In this example http www example com cartoweb is the address which corresponds 19 Installation to the cartoweb3 htdocs directory You should find client php if you type this URL 1 1 3 2 2 Installing a Project from a Directory lt PHP INTERPRETER gt cw3setup php install fetch project dir home foo my project base url http www example com cartoweb 1 1 3 2 3 Updating CartoWeb after Modifications When you modify or add new content features to CartoWeb you need to update it This will set relative links or copy new modified resources files templates images new plugins lt PHP INTERPRETER gt cw3setup php install base url http www example com cartoweb Same as Section 1 1 3 2 1 Basic Setup Existing files are not overwritten 1 1 3 2 4 Cleaning Generated Files Map PDF Temporary Files and Smarty Cache lt PHP INTERPRETER gt cw3setup php clean 1 1 3 2 5 Fetching the Demo Data XPHP INTERPRETER cw3setup p
45. client or server e accountingoOn boolean true l false sets whether accounting is enable or not e accountingStorage string file l db controls how the accounting information is stored file means that accounting information will be stored in files named cartoweb3 www data accounting MAP ID client server accounting log where MAP ID is the mapld currently used db means that accounting information is stored inside a database table This table can be created using the following command CREATE TABLE cw accounting date timestamp info text The database to be used can be configured using the account ingDsn parameter See next item e account ingBasePath string Optional base path where to store the accounting log files This is only used when accountingStorage is set to file e accountingDsn string DSN Data Source Name used to specify which 123 Accounting database to use for storing accounting information This is only used when account ingStorage is Set to db Note Do not forget to enable the accounting plugin if you want to use this feature 18 2 Managing Accounting Information 18 2 1 Accounting Log Files Administration Accounting log file are used to store one line of accounting information each time a request is made on CartoWeb The log files will grow with time as more and more data are stored inside This means that special care has to be taken by the CartoWeb admin
46. commas delimit cells e fontFamily string name of font family to use Naming depends on used pdfEngine e fontSize float font size in points pt e fontItalic boolean if true text will be emphasized e fontBold boolean if true text will be bold weighted e fontUnderline boolean if true text will be underlined e color string color of text in hexadecimal code rrggbb A few color aliases white black are available as well e backgroundColor string background color in hexadecimal code or color aliases borderWidth float border line width in distUnit e borderColor string border line color in hexadecimal code or color aliases e borderStyle solidldashedldotted border line style Only available with PdfLibLite pdfEngine solid value is used for other pdfEngines e padding float vertical and horizontal distance between block content and its borders in distUnit e horizontalMargin float horizontal margin in distUnit around the block outside borders e verticalMargin float vertical margin in distUnit around the block outside borders e horizontalBasis leftlright indicates what document side must be used for horizontal positioning e verticalBasis toplbottom indicates what document side must be used for 87 PDF Export vertical positioning hCentered boolean if true block is horizontally centered overloads horizontalBasis property vCentered bo
47. created if it does not exist 16 1 6 Debuging translation problems There can be several reasons why the translation is not working First you need to check if gettext is correctly installed and configured For so run the following scripts cd cartoweb home scripts testgettext sh This will test if Gettext is correctly installed in your system Note Unix like system only this script is not intended for Windows users 118 Internationalization cd cartoweb home scripts php testgettext php This will test if Gettext works correctly with php Once you have verified Gettext is installed and run correctly check if there are no errors in your po files Verify you do no have duplicate msgid in your po files Each msgid must be unique in a po file A typical error message would be Error message Failure while launching msgcat to code iso 8859 1 use first output www cartowe www cartoweb3 projects demo po demo en po www cartoweb3 projects demo po client en po output is www cartoweb3 projects demo po client en po 392 duplicate message definition www cartoweb3 projects demo po client en po 390 this is the location of the first definition msgcat found 1 fatal error duplicate message definition on line 392 in client en po Check if you have several fuzzy entries in your merged po file the file that is automatically created by gettext merging the client and server po files This happens w
48. ee METADATA exported values security view some specific parameter security view admin on some specific parameter value idcartcibuteo string PIDUISLtrimHQS mask transparency 50 mask tcrolkoie Aig IESE 0 area_fixed_value 10 END EEN END The metadata key exported values is a bit special It gives the list of metadata keys coma separated which will be transmitted to the client This is required for the metadata keys describing layer security for instance as they are used on the CartoClient 6 3 2 Metadata in layers ini The configuration file layers ini may also contain metadata key value pairs This is needed for LayerGroup objects as these have no counterparts in the mapfile For simple layers the metadata specified in the 1ayers ini take precedence over the values from the mapfile For each layer object in the 1ayers ini file the following syntax is used to set metadata layers layerId metadata METADATA value For instance layers group_admin className LayerGroup layers group_admin children grid_defaulthilight layers group_admin metadata security_view admin Note It is possible to specify minScale and maxScale attributes as 1ayers ini metadata for layerGroups items The equivalent mapfile metadata is not available for layers In that case simply use mapfile MINSCALE and MAXSCALE attributes 6 3 3 Using the metadata fields in templates layers tpl 53 L
49. festes nut faut qoi eeu uoi tace 209 pM iMITI CN 211 JC Lo euer e 211 1 2 Writing 6818 2 7 ENDO I ads IAS IR ISI BUTS means 211 7 2 1 General Information About Writing Tests 211 7 2 2 Specific Information for Tests esses 213 7 3 Runntng KE EE E 215 8 Code Documientation 1 1 secet Rad URS I deed 216 8 1 Generating Documentation eese 216 8 2 DOCBIGCKS iere t ite eee Ee 216 5 2 15 OCB IOCKS TEE 216 8 2 2 DocBlocks Contents 551i eco i rn ette ad 216 D 2 5 E EE 217 9 Logging and Debugging eire ee gedet 220 9 TL InttOdUCHON eebe 220 9 2 Logging un tete t giis taut n Eug 220 9 2 1 Log4php e 220 9 2 2 Log4php Configuration Files esse 220 9 2 3 Default Log File LOCatl9Dl pco me patiente 221 9 2 4 Using Log4php in Source Files ssss 221 e EE 222 9 3 1 Understanding Exceptions and Stack Traces 222 9 3 2 Using Direct for More Verbosity suse 222 10 Performance Tests 1i re eR RS ISI E rau a UID EEN 224 ERT Maiti Prattietebs Saeul Bun eut Puvtodes 224 10 2 Ex cutimg Tests cererii a eus tee ant ven Tae ehh Ue sank e Pene a 224 10 2 1 APD Module Installation eese 224 10 2 2 Simple Execution Times 5 etre tte 225 10 CartoWeb Documentation 10 2 3 Graphical Interface Unix like
50. files to MO files gettext s binary format use the following commands on client side This should be done each time configuration client or server is updated and after each system update All languages are compiled at the same time cd cartoweb home scripts php po2mo php Warning When CartoWeb is installed in SOAP mode the script uses PHP curl functions to retrieve PO files from server to client PHP curl module must be installed 16 1 5 Example To translate texts in french for project test project and map file projectmap follow 117 Internationalization these steps Onserver cd cartoweb home scripts php server2pot php Copy cartoweb home projects test project po server po to cartoweb home projects test project po server fr po and cartoweb home projects test project po server projectmap po to cartoweb home projects test project po server projectmap fr po Edit french files with Poedit or any editor Onclient cd cartoweb home scripts php client2pot php Copy cartoweb home projects test project po server po to cartoweb home projects test project po server fr po Edit french file with Poedit or any editor Merge and compile files with the following commands cd cartoweb home scripts php po2mo php Now you should have the file test project projectmap mo in directory cartoweb home locale fr LC MESSAGES The directory x LC MESSAGES will be
51. for both server calls i e requests and server results 1 3 1 Global Structures Below is a description of general requests and results which include plugin specific ones 1 3 1 1 Global Request complexType name MapRequest elt element name mapId type xsd string gt elements specific to plugins all lt complexType gt e mapld map ID ie project name and mapfile name separated by a point 1 3 1 2 Global Result lt complexType name Message gt lt all gt lt element name channel type xsd integer gt lt element name message type xsd string gt all lt complexType gt channel type of message 1 end user 2 developer message text of the message lt complexType name ArrayOfMessage lt complexContent gt 151 Calling Plugins restriction base encll Array attribute ref encll arrayType wsdl arrayType types Message e restriction complexContent lt complexType gt array list of messages lt complexType name MapResult gt lt all gt lt element name timestamp type xsd integer gt lt element name serverMessages type types ArrayOfMessage minOccurs 0 gt elements specific to plugins all lt complexType gt timestamp timestamp which identifies the server configuration If this timestamp changes it means server configuration changed and a call to method getMapInfo is required to get latest vers
52. from geometric tables and for generating results as geometries Note For more information on these functions you can have a look to the routing module README file http www cartoweb org downloads pgdijkstra README txt This section explains the main steps to integrate the routing fonctionnalities in a custom application We describe the steps followed to install the routing demo To make short we used an Europe roads shapefile imported it in PostGIS generated the graph tables and configured files to suggest a search of the shortest path between two European towns 1 2 5 1 1 Europe Road Geodata Importation in PostGIS shp2pgsql I roadl shp roads europe gt tmp roadl sql psql d demo plugins f tmp roadl sql Only lauch the following commmands if you did not import the town table already shp2pgsql I mispopp shp town tmp town sql psql d demo plugins f tmp town sql SEEN SALES ee UTE CU 1 2 5 1 2 Graph Importation The first step is to add needed columns to the table roads europe To do so you can type ALTER TABLE roads europe ADD COLUMN source id int ALTER TABLE roads europe ADD COLUMN target id int ALTER TABLE roads europe ADD COLUMN edge id int next line is to work around a pgdijkstra bug in update cost from distance fixed in latest CVS ALTER TABLE roads europe RENAME id TO id old You can then fill the columns source id and target id with the assign vertex id function SELE
53. general distUnit mm 2 9 blocks myBlock horizontalBasis right blocks myBlock horizontalMargin 10 If you want to horizontally center a block it is simply done using blocks myBlock hCentered true Block centering overloads any other kind of positioning margin Vertical positioning is achieved in the same way substitute the dedicated keywords The inFlow parameter defaults to true except if set differently in the template block As a result blocks with the same zzndex will be positioned right below the first block preserving the left side alignment To cancel this behavior set inFlow to false In that case the given block will be positioned related to the previous block using margin or centering ways 12 3 4 3 Text Blocks Text blocks are boxes with a textual content The text is set in the content parameter in case of a static block content has to be left blank for visitor set blocks such as title or note Text formatting is achieved using usual CSS like parameter fontFamily fontSize expressed in points color Small exception fontItalic fontBold fontUnderline are booleans Box properties background color border size color and style padding are set in the 95 PDF Export same way whatever the block type is Width is generally detected automatically according to the text length On the other hand the system has poor means to evaluate its height so it is recommended to set it by hand Note t
54. his call this formRenderer showForm S this t t his call his saveSession this clientSession his callPluginsImplementing ServerCaller PluginsImplementing ServerCaller this mapResult PluginsImplementing ServerCalle this mapRe PluginsImplementing Sessionable buildRequest this gt getMapResultFromRequest SmapRequest initializeResult r handleResult SUELEN saveSession callPluginsImplementing interfaceName SmethodName Sargument is run at various points of the program and make plu gins implementing given lt interfaceName gt interface execute given lt methodName gt with given argument argument Of course interface defined methods must be implemented in the matching plugins Plugins can implements one or more CartoWeb interfaces Implementing interfaces is not mandatory when writing a plugin but not doing so will keep plugins from being implicitely called by the main program As a result methods from plugins with no interface implementation also called service plugins must be explicitely called by another piece of code class ClientYourPlugin extends ClientPlugin implements Sessionable here comes your plugin client class def generally an other plugin GuiProvider EE EE 5 For a comprehensive list of available client and server interfaces see client 176 New Plugins Client
55. horizontalMargin 15 h h h h h blocks north parent mainmap h h h h h blocks north verticalMargin 5 12 3 5 Holes Management CartoWeb enables to perform roles restrictions on most of the PDF document parts general access formats resolutions blocks All these elements can be restricted to some authorized users For a more detailed discussion of the concept of security restriction and roles see Chapter 15 Security Configuration To do so simply add to considered objects blocks an allowedRoles property set to the comma separated list of roles you want to restrict them to For instance e to enable PDF printing only for 10ggedzn users use general allowedRoles loggedIn e to reserve A3 format to editors or admins use formats A4 allowedRoles editor admin toseta resolution limit for anonymous users when printing in A3 you can define 2 similar formats with different maxResolution and allowedRoles properties general formats A4 A3 A3full e formats A4 label A4 formats A4 bigDimension 297 formats A4 smallDimension 210 101 PDF Export formats A3 label A3 formats A3 bigDimension 420 formats A3 smallDimension 297 formats A3 maxResolution 150 formats A3 allowedRoles anonymous formats A3full label A3full formats A3full bigDimension 420 formats A3full smallDimension 297 formats A3full allowedRoles loggedIn Note that all formats that may be used must any w
56. if several features are stacked on each other only the result of the uppermost feature is displayed the layout cannot be customized 23 2 3 3 Configuration Here are defined parameters available for area direct layers e label label fo the layer area_direct region label Regions area_direct users label Users The list of attributes names and values that are displayed in the tooltip is set with the query returned attributes metadata in the mapfile as used for the query tool 23 3 Custom Tooltips 23 3 1 Templates Tip Make sure that the custom templates are in the templates folder in the toolTips plugin directory in your project 23 3 1 1 Main Template As for the other plugins templates can be overriden in the projects Then user can define a new 1ayerResult tpl template for all timeout async or area async layers 23 3 1 2 Layer Specific Template One can also define a specific template for each layer of timeout async and area async ones It can be defined using the template parameter See Section 23 2 1 3 Configuration or Section 23 2 2 3 Configuration or in renderResult method in PHP code if QueryableLayer is extended see above 136 ToolTips 23 3 2 Extending classes For the timeout async layers if a class extending ByXyQueryableLayer with a name like LayerIdQueryableLayer exists it will be taken into account Similarly for the area async the classes extending By1dQu
57. integer element name mapLabel type xsd string element name keymapGeoDimension type types GeoDimension element name initialMapStates type types ArrayOfInitialMapState elements specific to plugins all complexType timestamp timestamp of last update This timestamp is transferred each time method getMap is called so client knows when configuration was modified see also Section 1 3 1 1 Global Request e mapLabel name of map as defined in mapfile e keymapGeoDimension pixel and geographical dimension information for key map e initialMapStates list of initial states 1 2 2 Layers This includes configuration specific to Layers plugin ie list of all available layers and their properties lt complexType name ArrayOfLayerId 146 Calling Plugins lt complexContent gt restriction base encll Array gt attribute ref encll arrayType wsdl arrayType xsd string restriction complexContent lt complexType gt array list of layer IDs lt complexType name ChildrenSwitch gt salla lt element name id type xsd string gt element name layers type types ArrayOfLayerId minOccurs 0 gt Set complexType e id switch ID e layers list of layers lt complexType name ArrayOfChildrenSwitch gt lt complexContent gt restriction base encll Array gt lt attribute ref encll arrayType wsdl arrayType ChildrenSwit
58. is my auto layer with index lt php printIndex gt 56 Layers LAYER NAME lt php printName gt TYPE POLYGON CLASS NAME MyClass STYLE COLOR lt php if getIndex index2 print 200 200 255 GIL josie WAss NIFI MID TUM ies END END END AUTOLAYER i 2 gt END 6 6 3 Batch Script Script makemaps php located in directory scripts generates mapfiles out of mapfile templates for all projects Mapfiles are generated in the same directory The script must be called once during installation and then each time a change is made to the mapfile templates It uses file1ayers ini to find out which auto layers are needed For instance with the following 1ayers ini myAutoLayer index3 won t be generated autoLayersIndexes indexl index2 index3 layers layerl className LayerGroup layers layerl children layer2 myAutoLayer index1 layers layer2 className LayerGroup layers layer2 children myAutoLayer index2 At least one file is generated Its name is auto mapId all map and it contains all auto layers used in file layers ini When children switching is used see Section 6 2 4 Children Switching one mapfile is generated per switch One more is generated for special switch default This way only auto layers used with the current switch are actually loaded at runtime Mapfile auto mapId all map is still generated In the following example 4 mapfiles are generated autoLayersIndexes indexl ind
59. is sent to the CartoClient using the geographical coordinates of the cursor If the webserver finds features corresponding to the defined timeout_async layers a response is sent back to the browser with some generated HTML code showing some attributive information 23 2 1 2 Pros Cons Pros fully customizable layout several results can be displayed even for stacked features e isn t dependant to the feature counts performances should not fail even for huge quantity of feature Cons e database postGIS required 23 2 1 3 Configuration Here are defined parameters available for timeout async layers e label optional label for the layer If not set layerId is diplayed 133 ToolTips e dsn connection string to database Data Source Name e dbTableName name of the table in database attributes comma separated list of attributes to be displayed e template optional custom template must be in overriden toolTips plugin templates directory If not set generic 1ayerResult tplis used The template to use can also be set in renderResult method in PHP code if QueryableLayer is extended See Section 23 3 2 Extending classes timeout async region label R gions timeout async region dsn pgsql www data www data8localhost 5432 france timeout async region dbTableName region timeout async region attributes nom code timeout async region template layerResult region tpl 23 2 2 Area Asyn
60. it allows you to view map data without copy data to your location or to access realtime map data constantly changing such as hurricane location It can be usefull to save WMS servers properties locally to preview its layers manage these servers upgrade delete refresh properties disconnect it if remote server isn t avaible add a choosen WMS layer to the map and delete all added WMS layers The WMS Browser plugin is designed to do so To use it you have to install Chameleon XML parser php API load plugin and set a few configuration files parameters 6 8 1 Install Chameleon XML parser php API o Download Chameleon php extension package from http cartoweb org downloads html o Uncompress the archive and follow steps described in chameleon ext README txt file to compile it o Copy chameleon ext php modules chameleon so extension to your php extensions directory and load it in your php ini Warning If your web browser isn t running as CGI don t forget to restart it 6 8 2 Plugin activation 59 Layers To activate the plugin load mapOverlay and wmsBrowser plugins from both CartoClient and CartoServer configuration files client_conf client ini and server conf mapId mapId ini For instance loadPlugins mapOverlay wmsBrowser 6 8 3 Position to which insert WMS layers To insert a WMS layer on the map you must specify after which mapfile layer you want insert it The layer wi
61. name starting with test will be considered as a test case by the automated test runner You may also want to use functions setUp and tearDown to initialize and clean a test environment Method assertEquals tests if two values have the same values If not the test will be added to the final report as failure As stated previously all test classes have to belong to a test suite The next example shows how such a test suite is built by grouping all tests together in the suite method 212 Unit Tests Example 7 2 Test suite AllTests php php require once PHPUnit2 Framework TestSuite php require once CartoclientTest php require once CartoserverServiceTest php class client AllTests puplutc static function surtet t Ssuite new PHPUnit2 Framework TestSuite suite addTestSuite client CartoclientTest suite addTestSuite client CartoserverServiceTest return suite All test suites are then grouped together into the root test suite It is shown there for information Example 7 3 Root directory s AllTests php php require once PHPUnit2 Framework TestSuite php require once client AllTests php require once common AllTests php class AllTests public static function suite i suite new PHPUnit2 Framework TestSuite suite addTest client AllTests suite suite addTest common AllTests suite return suite 7 2 2 Specific Information for Tests This
62. s 226 11 Upgrading Views Data 5 eire n e reet rne tine reni A 227 IT 15 auer e EE 227 11 2 Upgrade Tools iet nt et e seem e dpa 227 11 21 Views VET SIONS dti dicet ete uie aig 227 11 2 2 Upgrade Filters 2 nbi Su aeter Red 221 11 2 3 Upgrade Configuration autero e teret te 228 11 3 Customizing Views Processing Using Project Hooks 229 12 AJAX Implementation EE 230 12 1 Introduction 2 1 2 peti dedii ed 230 12 2 AJAX Implementation Outline een 230 12 2 1 Synchronous And Asynchronous Modes 230 12 2 2 Ajaxable DIeERICB oo o rito eterne rots oc ree ise da 231 12 2 3 Plugins Javascript Side isse etes 231 12 24 TEE EE 231 12 2 5 Plugins Enablement Level sss 231 12 3 Making Your Plugin Ajaxable eese 232 A Mapserver Debian Installation eese 233 A 1 Setting Up Your Repository and Preferences File 233 A 2 Installing the Packages o iet tae eee Eddie deer 233 B Apache amp Mapserver Windows Manual Installation 234 BT Apache PHPS Install 4 oi ettet nas 234 B 2 Mapserver Mapscript Install eeeeeeeeeeeeenneeen 235 C Create a New Projetos ee ree ANUS ERU tp EUER PLUR Ta US HE TS a MAS ra E Un Peau eR Ue 237 CST Project Directory seccarsi lot pede tut ad tud ef 237 C2 Setup Your Praje
63. scale is above or below this layer maximum minimum scale e notAvailablePlusIcon filename of icon for not available layer current scale is above this layer maximum scale e notAvailableMinuslcon filename of icon for not available layer current scale is below this layer minimum scale e layers list of layers e switches list of switches 1 2 3 Location This includes configuration specific to Location plugin ie fixed scales scales limits and shortcuts complexType name LocationScale all element name label type xsd string gt lt element name value type xsd double gt lt all gt lt complexType gt e Jabel scale caption e value scale value to be set when scale is selected lt complexType name ArrayOfLocationScale gt lt complexContent gt restriction base encll Array attribute ref encll arrayType wsdl arrayType types LocationScale restriction complexContent lt complexType gt array list of scales lt complexType name LocationShortcut gt lt all gt lt element name label type xsd string gt lt element name bbox type types Bbox gt lt all gt lt complexType gt 149 Calling Plugins e Jabel shortcut caption e bbox bounding box to recenter on when shortcut is selected lt complexType name ArrayOfLocationShortcut gt lt complexContent gt restriction base encll Array attribute ref encll arrayType
64. server_conf lt mapId gt lt mapId gt ini mapInfo loadPlugins hilight outline exportPdf 12 3 2 Overall Configuration Two objects are available for overall configuration 12 3 2 1 general This is where you can set the list of available resolutions and formats made available to the user through dropdown menus Use commas to separate the available values defaultResolution and defaultFormat are used to preselect options in the matching dropdowns If for some reason the system failed to determine what resolution and format the user desires it will use those default values Specify the default orientation to select in user interface as well You don t need to set a list of available orientations since it is already fixed to portrait landscape The activatedBlocks parameter lists the blocks that may be drawn in the document It does not mean that they will For instance the title block will not appear if no title input has been submitted by the user Choose the PDF generator you want to use For now only FPDF is fully available PDFLib is only partially implemented and should not be used Set the output parameter in order to choose how the generated file will be served download box link inline The distUnit parameter is very important since it sets the unit used to measure the length specified in every blocks However it does not affect font sizes that are always indicated in points pt horizontalMargin and verticalMa
65. set e zoomFactor the zoom factor to use whan scaleModeDiscrete is set to false e noBboxAdjusting If set to true all data contained in the initial extent mapfile is visible on the full extent first map This case is the default mapserver behavior If set to false default the user won t be able to see anything outside the initial extent even on full extent map e scales value 0 1 2 available value of the scale in discrete mode e scales label 0 1 2 label of the scale to be displayed in the dropdown list on the client e scales visible 0 1 2 boolean if true the scale is displayed in the dropdown list If false this scale can only be selected by zoom in zoom out Default is true e shortcuts label 0 1 2 label of the shortcut appears in the direct access dropdown list on the client e shortcuts bbox 0 1 2 geographic bbox of the shortcut e recenterMargin margin to add around the centered on object valid for lines and polygons Expressed in percent of the width height of the object If not set recenterDefaultScale is used e recenterDefaultScale fixed scale to use when recentering Mandatory when centered on object is a point e refMarksSymbol symbol used to draw lines for reference marks typically an ellipse e refMarksSymbolSize size in pixel of symbol used to draw lines for reference marks typically 1 or 2 e refMarksSize
66. size of reference marks Size is fixed and won t change with scale e refMarksColor color of reference marks comma separated R G and B values e refMarksTransparency transparency of reference marks e refMarksOrigin origin for reference marks comma separated X and Y values 62 Navigation typically 0 0 e refMarksInterval maxScale maximum scale for corresponding interval e refMarksInterval interval real interval between two reference marks comma separated X and Y values refLinesActive if true will display reference marks on page borders e refLinesSize size in pixel of reference marks on page borders refLinesFontSize size of font for reference marks on page borders 7 3 Related Elements Elsewhere The maximal extent of the geographical zone is set by the EXTENT command in the mapfile The initial bbox is set by the active initialMapState It is to be configured in the myMap ini file using the following syntax maplInfo initialMapStates initialMapStateId location bbox xmin ymin xmax ymax 63 Image Format Options 8 Image Format Options The plugin images is the core plugin that deals with the formatting options for the main map It handles the size of the image and its filetype 8 1 Client side Configuration 8 1 1 Main Map Options Here are the options that can be set e mapsSizesActive boolean if true displays a drop down list of available mapsizes if false a fixed s
67. tenetis edaN 68 9 2 Server side EE e NEE 68 9 2 1 QUERY AMD EE 68 9 2 2 MapServer Query Configuration sees 68 9 3 Related Elements in Mapfile ecce 69 9 3 1 Making a Layer Quenable 5 eint eoe oete teres Den Ed 69 9 3 2 Meta Data geegent Eege 69 9 3 3 Hilight Configuration o rice ecintl i Ee PUE DUCES tut 69 10 Annotation and Redlining 73 CartoWeb Documentation 10 1 Client side Cobfrguratiohis decur tod o Medal ted ode no ee VERS 73 TO 1L L outline dfi srs He one tonio e ate to eese estan 13 10 2 Server side Configuration juae eiecti sor uen etri tov ined 13 10 2 outen uie ond eee tarn pa i neis ene gege peas 13 10 3 Related Elements in Mapfile eeeeeeee 74 LOS Layers i touto ROI D RO ed udine be e 74 10 3 2 Labels EE 74 10 4 The TOO UPICK o dE n 75 10 4 1 What is the ToolPicker odere toss ttg Eeer 75 10 4 2 Installauion EE 75 10 4 3 Tool Picker Usage seo aee tert bei OR neei 76 10 4 4 ToolPicker Default Values 20 0 0 eeeseeeeceeceseeeeteeeeees 78 10 4 5 Examples of Usage ucsosc sacco e I RP rnt Renan titi eius 78 10 4 6 Creating New Tools 4 ettet trenes 79 IT Export PLUGINS sept edle eret adeavuntes a e 80 IH T Introd clOn oae sts braun Rx IAEA IB Ue SEXE ES PERSE EAT RIS 80 112 HTME EDO GE 80 MTS CSV EXOT t n a an aaa ER E ARR 80 LI b DXF ERD OLE ins ET 8l 11 5 Image Output 2 4 Masa de INS e Se ue eng 82
68. the following figure Background Human activitiez El O T owns O Town Agglomeration El E Transports E iV Roads Oa Category Relief H Iv A Mountains A gt 3500m 2500m M loelands The icons for the classes are automatically drawn and the out of scale layers are grayed out 2 5 Map Queries Using the query tool you can geographically search for objects Found objects are hilighted and their attributes are displayed CartoWeb adds many functionalities to the raw queries supported by Mapserver In particular the queries may be persistent 1 e you can add new objects to already selected objects and the hilighting can be defined on a layer by layer basis Cartographic Functionalities P7 dn SS ANE Query Results Towns I d Name 1045 AIGLE 996 BULLE Download CSV 2 6 Annotation and Redlining It is possible to freely draw points lines rectangles and polygons on the map ant to attach labels to them These features are persistent they survive panning or zooming A mask mode in which everything but the outlined polygon is masked is provided too Cartographic Functionalities ANAS NIS M f EE 7 AVL ELMS f Ne EE v A K J d a Myo Lf X Y 4 y JA e LAT Ss We A Me my A Cr XX as E Lic et p 2 7 Measuring Tools Distances and surfaces can be measured on the main map with the following tools 2 8 Int
69. truelfalse if true WSDL will be used for sending SOAP requests This will add some processing time but ensures that SOAP requests are well structured In addition WSDL is necessary when interfacing the Web Service with a strong typed language built application Cache options See Section 5 6 Caches Configuration Developer options See Section 4 5 Developer Specific Configuration 4 2 client ini CartoServer access configuration e cartoserverDirectAccess truelfalse toggles between SOAP and direct modes Direct access gives enhanced performances but is only available if CartoServer runs on the same server as CartoClient e cartoclientBaseUrl base URL of the CartoClient e cartoserverBaseUrl base URL of the CartoServer i e path containing the cartoserver wsdl php file 39 Configuration Files Mapfile configuration e mapld string e initialMapStateld string Tells what initialMapState to use when creating a new CartoWeb session see also Section 4 3 3 3 Initial Mapstates Tip initialMapStaterd may be determined using several means By order of priority 1 URLs using GET parameter initialState 2 PHP environment variables Place ENV CW3 INITIAL MAP STATE ID foobar in your PHP code before calling CartoWeb client ini 4 Ifno initialMapstaterid can be determined CartoWeb use first initialMapState available Session handling e sessionNameSuffix string Optiona
70. type text javascript src r type js prototype js r gt lt script gt And in the lt body gt of the document for example in the navigation folder if Slocate_active default S1ocate form if Tip Warning make sure that id recenter is active 19 3 Configuration e locate id 0 1 2 id of the layer in layers ini to recenter on e locate label 0 1 2 label of the locate input Note that if you use 125 Locate Plugin the same label as in the layers ini translations will operate locate sql 0 1 2 SQL statement for the AJAX request to the database It must return two fields o an identifier the value of the id_attribute_string field of the layer in order to be able to recenter on the feature o alabel a name for the feature to recenter on 126 WMS Browser 20 WMS Browser 20 1 Introduction wmsBrowser plugin allows you to save WMS servers properties locally to preview their layers manage these servers upgrade delete refresh properties disconnect a remote server that is no more avaible add a chosen WMS layer to the map and delete all added WMS layers To have the plugin working you must install Chameleon http chameleon maptools org XML parser first load plugin and set a few configuration files parameters 20 2 Installing Chameleon XML Parser Download Chameleon extension package from http cartoweb org downloads html
71. used to define which test to launch Under a Unix like shell enviroment the command line to use is CARTOWEB TEST PROJECT myproject lt php bin gt phpunit php projects AllTests projects AllTests php 7 3 Running Tests Unit tests are runned using the command line interface CLI To run a test case or a test suite type the following command in directory cartoweb3 root tests lt php bin gt phpunit php test class php file Where lt php bin gt is the PHP binary lt test class gt is the name of the test class AllTests client AllTests client CartoclientTest etc and php file is the name of the PHP file containing the test case c1ient CartoclientTest php Result should look like this PHPUnit 2 0 3 by Sebastian Bergmann Time 0 0410950183868 There was 1 failure 1 testpointtobbox expected same 113 was not 123 home yves cartoweb3 proto2 tests common BasicTypesTest php 59 home yves cartoweb3 proto2 tests phpunit php 24 FAILURES Tests run 12 Failures 1 Errors 0 Incomplete Tests O0 Content type text html X Powered By PHP 5 0 1 In this case 12 tests were run with one failure 215 Code Documentation 8 Code Documentation CartoWeb code documentation is generated using PhpDocumentor http www phpdoc org a JavaDoc style doc generator CartoWeb already includes version 1 3 0rc3 of PhpDocumentor 8 1 Generating Documentation Documentation is generated usi
72. well This approach is generally sufficient when you only need to 178 New Plugins adapt the layout extend the main PHP classes to add your own methods or overload existing ones This approach is required when you need to add some PHP code to the plugin Both approaches are not incompatible and may be combined to obtain desired result See Section 2 3 4 Combining Both Approaches for more explanations 2 3 2 Overriding a Plugin Overriding a plugin is the simplest way to adapt it to your needs It is done by duplicating the plugin files at least the ones you want to adapt in your project frame For more information about projects handling see Section 2 4 Projects This approach is recommended when you want to use your own versions of the plugin templates or resources Moreover you can add any new resources files that will be called in your customized templates However you will not be able to replace or add PHP files except PHP pages in the plugin htdocs To adapt a plugin server side behavior PHP classes you have to extend the plugin which is explained in Section 2 3 3 Extending a Plugin Say for instance you want customize the layers coreplugin by modifying its template 1ayers tpl and rewriting some of its JS tools stored in layers js Than your project adapted coreplugin will look like projects lt yourProjectName gt coreplugins layers projects lt yourProjectName gt coreplugins layers templates
73. wsdl arrayType types LocationShortcut restriction complexContent lt complexType gt e array list of shortcuts lt complexType name LocationInit gt SNP lt element name className type xsd string element name scales type types ArrayOfLocationScale element name minScale type xsd double element name maxScale type xsd double lt element name shortcuts type types ArrayOfLocationShortcut all lt complexType gt e className LocationInit or extended class name if project implements an extension scales list of fixed scales e minScale global minimum scale e maxScale global maximum scale shortcuts list of bounding box shortcuts 1 2 4 Layer Reorder This includes configuration specific to LayerReorder plugin lt complexType name LayerReorderInit all element name layers type types ArrayOfLayerInit all lt complexType gt array layers are ordered from top to bottom of the displayed stack see below to LayerlInit structure overview lt complexType name LayerInit gt 150 Calling Plugins all element name layerId type xsd string element name layerLabel type xsd string all lt complexType gt e layerld Layer Id e layerLabel label to be displayed This label is not yet translated using internationalization 1 3 Call to getMap For each plugin SOAP XML format are described
74. 000 request locationRequest bboxLocationRequest bbox miny 100000 request locationRequest bboxLocationRequest bbox maxx 600000 request locationRequest bboxLocationRequest bbox maxy 150000 The query will be performed on a rectangle on all selected layers ie layers defined in layers request object IDs and attributes will be returned request queryRequest className QueryRequest request queryRequest shape className Bbox request queryRequest shape minx 570000 request queryRequest shape miny 120000 request queryRequest shape maxx 580000 request queryRequest shape maxy 130000 request queryRequest queryAllLayers true request queryRequest defaultMaskMode false request queryRequest defaultTableFlags returnAttributes true request queryRequest defaultTableFlags returnTable true request queryRequest querySelections array Now request object is ready SOAP method is called try result client getMap request print r result L Cater SeapRault Shanty odit Sault EE string B Result is shown below It includes relative paths to generated images and new scale computed from requested bounding box Query results include one table per layer No results were found in layer swiss layer 1 and two results in swiss layer 2 As requested attributes here attribute 3 and attribute 4 are
75. 1 6 16 tar bz2 http www cartoweb org downloads docbook tiny docbook 1 6 16 tar bz2 archive somewhere in your filesystem Execute configure enable install make install to install and configure Tiny DocBook environment D 1 2 JAI Install For PNG support with PDF generation you will also need to install JAI If you don t plan to produce PDF you could jump to next step otherwise process as following 1 Retrieve JAI archive from Sun site http java sun com products java media ja downloads download 1 1 2 Ol html took the classpath one for your platform 2 Uncompress it in your Tiny DocBook install dir S wean syari Jei Jb 2 0L do306 enee SEI zie eue c epa 3 Move jai 1 1 2 01 1ib jai codec jar and jai 1 1 2 01 1ib jai core jartO fop lib Saw jail 2701 115 ais60dsc jat top luib7 S mr ai ei jae core arian lay 4 Remove the becoming useless JAI archive like that S mm ee Tar ale SUM 242 DocBook Documentation Generation D 1 3 Create a Symbolic Link to Documentation Source Create a symbolic link in the Tiny DocBook install directory pointing to the CartoWeb documentation sources cartoweb home documentation user manual source like that ln s CARTOWEB HOME documentation user manual source D 1 4 XHTML Generation Then to generate an XHTML version of the documentation execute as follow configure make xhtml Output result will be generated in xntm1 d
76. 30 formats A3 verticalMargin 30 formats A3 maxResolution 150 12 3 3 Form Settings The HTML interface of the PDF tool is fully customisable by e editing the general attributes for formats resolutions and orientation lists see Section 12 3 2 1 general above e adding or editing blocks content parameters to specify default values for text inputs such as title or note and other options legend scalebar overview query results See Section 12 3 4 Blocks Configuration For instance blocks title content My default title blocks scalebar content 1 scalebar is checked by default blocks legend content in legend is checked as included in map by default 12 3 4 Blocks Configuration Whatever their types image text table legend north blocks use the same PHP object model and as a result the same object properties Some parameters can be used in several ways depending on the block type Some others are simply ignored Blocks naming is quite free but some names are reserved to system defined blocks such as title mainmap overview scalebar note copyright queryResult legend page scaleval tlcoords brcoords north System blocks should not be renamed Note that blocks that are not mentioned in general activatedBlocks won t be displayed in any case general activatedBlocks mainmap title note scalebar overview copyright queryResult page legend logo scaleval tlcoords brcoords nort
77. 67 defaultTable 68 displayExtendedSelection 67 drawQueryUsingHilight 68 dsn 134 135 DXF export 81 E editDisplayAction 107 editLayers 107 editResultNbCol 107 edit_attributes 108 edit_geometry_column 107 edit_geometry_type 107 edit_srid 108 edit_table 107 enableTransparency 59 Export plugins 80 183 extent 63 F filename CSV 81 fileName DXF 82 Filters 185 force_imagetype 66 Formats configuration PDF 86 formats object PDF 92 G General configuration PDF 83 general object PDF 91 Geostatistics 131 H Hilight 69 hilight_color 70 hilight_createlayer 70 hilight_transparency 70 HTML export plugin 80 idAttributeString 135 idRecenterActive 61 idRecenterLayers 61 244 Index id attribute string 69 ignoreQueryThreshold 69 Image blocks PDF 98 image mode 82 imagetype 65 initial mapstate 43 insertedFeaturesMaxNumber 107 Internationalization I18n 121 L label 133 135 136 Jabel Mode 73 layergroups 51 layerReorder 58 layers 50 Legend 54 Legend blocks PDF 100 lineLayer 74 locate 125 loggedIn 112 M mapHeight 64 mapld 36 mapOverlay 194 mapSizes height 64 mapSizes label 64 mapSizes width 64 mapSizesActive 64 mapSizesDefault 64 map Width 64 maskColor 74 mask_color 71 mask_transparency 71 maxMapHeight 65 maxMapWidth 64 maxResults 68 maxScale 62 minScale 62 multipleShapes 73 N noBboxAdjusting 62 n
78. CT assign vertex id roads europe 1 Here is the content of the roads europe table SELECT gid source id target id edge id AStext the geom FROM roads europe limit 3 gid source id target id edge id AStext q p 4 4 2 2 2 2 2 2 2 2 2 2 2 2 28 Installation Isis LLOSS LLOSS 14 MULTILINESTRING 1062096 06 4861316 234 12869 10918 LOSES 2OI FREE EE Ee 12868 10918 dios 260 MULTPLINBESIRING Q 250681 597 47179595 532445 9 3 lignes But if the data quality is poor you need to delete the duplicates edges they have the same source target pairs of vertices For example to check that you have duplicated edges you can type SELECT FROM SELECT source id target id count AS c FROM roads europe group by Source id target id order by c AS foo where foo c 2 If there is duplicated edges to delete one of two rows you can type CREATE TABLE doublons AS SELECT FROM roads europe WHERE gid in SELECT gid FROM SELECT DISTINCT on source id target id source id gid FROM roads europe AS doublon DELETE FROM roads europe INSERT INTO roads europe SELECT FROM doublons DROP TABLE doublons The following step is to create and fill the edges and vertices tables of the resulting graph To do so you can use create graph tables function SELECT create graph tables roads europe int4 SELECT
79. CartoWeb Documentation 3 3 0 Edition to Published 2006 08 30 CartoWeb Documentation ii CartoWeb Documentation Table of Contents I Presentation and WEE 1 Le Project Presentation 5uustetr e IO a IER UR DERI dO 2 I LZAbOUL C dro WED ER 2 1 2 EEN 2 2 Cartographic Me 3 2 eet E TEEN 2 2 2 OVeFVIQW Ae een te iiti o itai debi lese Fabed lebe fo dd ter atlas feed 3 2 3 Navigation Interface i4 ise i enixe INNER e ONSE EROR dE Age 4 2 4 Arbitrarily Complex Hierarchy of Layers eessss 4 2 5 Map Queries iso RI RERO OA RR be hs 5 2 6 Annotation and Redlining esee 6 2 7 Measurimg Ke EE 7 2 5 EE er ZAU OM EE 7 2 9 Access RAG EE 7 2 10 PDF Output and Other Export Formats esee 8 3 Architecte ERE 10 SM ly Introd cti i te c EC 10 3 2 MapServer MapScript 2 einer eda teet reap eds 10 3 3 Web Service Architecture SOAP sseessseeee 10 3 4 Modularity Projects and Plugins eese 12 SUET E KEE 12 3 4 2 Projects vue Neh esed osito i M S UT 13 3 9 Kn 14 3 6 Users and Roles sioe tide ess eal ada ese de pegada 14 3 7 Performance Enbanceftient 22 52 52 x M ecran e eaciaceaatoniads 14 IE User Manual 2 51 53 Eed El Eege 15 T I stallattOn EE 16 1 1 CartoWeb Installation 11 236 eet ott sta cta Eege Ee 16 1 1 1 Prerequisite for Installing CartoWeb 16 1 1 2
80. CartoclientTest php CartoserverServiceTest php AllTests php common BasicTypesTest php AllTests php coreplugins AllTests php plugins AllTests php For the test main project the hierarchy is the following coreplugins AllTests php plugins AllTests php misc AllTests php misc tests gt 211 Unit Tests Each directory including tests root directory has a file named A11Tests php This is called a test suite It is used to run all tests of a specific directory ie package Warning All test case and test suite classes must have the name of their file relative path without extension with replaced by For instance class client CartoclientTest file name must be cartoweb3 root tests client CartoclientTest php The following example shows a test in common BasicTypeTest php file Example 7 1 Simple test case BasicTypesTests php php require once PHPUnit2 Framework TestCase php require once CARTOWEB HOME common basic types php class common BasicTypesTest extends PHPUnit2 Framework TestCase public function testBboxFrom2Points Sbbox new Bbox Spointl new Point 12 34 point2 new Point 56 78 Sbbox 2oSetRFrom2PointsiSpointi pornt2 this gt assertEquals 12 Sbbox cminx this gt assertEquals 34 bbox gt miny this gt assertEquals 56 bbox gt maxx this gt assertEquals 78 bbox gt maxy Each function with
81. Create a lt yourPlugin gt directory in projects lt yourProject gt plugins if you need a simple plugin Directory name will be the plugin name You can use whatever name you want except of course names of already existing plugins or coreplugins Yet it is recommended to use lowercase letters capitalizing only the first letter of each word that composes the name eg yourPluginName In case of a coreplugin there is no way to create a coreplugin in a project context Coreplugins can only be integrated in the upstream application It is not recommended to do so without CartoWeb developers agreement because of compatibility troubles that may occur when upgrading etc Create subdirectories to store all plugin related resources files and templates Create client server common if your plugin as CartoClient CartoServer and respectively common parts Create your main PHP classes files Those files must be named using the first letter capitalized name of your plugin prefixing it with Client or Server for client or server components eg Client YourPlugin php 177 New Plugins ServerYourPlugin php YourPlugin php 6 Extend ciientPlugin and or ServerPlugin CartoWeb classes in the matching above files and name the result classes using their files names with no php For instance php iversion Id ServerYourPlugin php v 1 8 2005 02 23 11 52 43 johndoe Exp S class ServerYourPlugin exten
82. DME txt included in the archive tells you where you must place the various files o Unzip gdal 1 2 5 zip libcurl 7 10 7 dll zip xerces dll zip ECW DLL zip pdfdll zip libpq zip in C WINNT System32 if you are using Windows 2000 NT C Windows System32 for XP and C Windows NSystem for 95 98 Me o Move php mapscript 45 d11 in the extensions folder of PHP see PHPINFO default is c wamp php ext The file php_proj d11 is outdated you can ignore it o Open php ini and add a call to this extension 235 Apache amp Mapserver Windows Manual Installation extension php mapscript 45 dll Restart Apache and check that the mapscript module is loaded correctly look in PHPINFO e Install Proj4 by following the instructions in URL indicated in the README txt http mapserver gis umn edu cgi bin wiki pl WindowProjHowTo gt Using Prebuilt Binaries o Download the archive Proj4 here ftp ftp remotesensing org proj proj446 win32 bin zip o Uncompress it in CX If you want to install it elsewhere look at point 2 of Using Prebuilt Binaries o Point 3 in the README is irrelevant in our case e CartoWeb setup script cw3setup php requires an unzip program to uncompress libraries and demo data archives If you don t have one installed download one on the Web type unzip exe in your favorite search engine and put it for instance in your C Windows directory Note The exe in the Mapserver archive are not needed Not
83. I Developer Manual Note that you don t need to duplicate the whole CartoWeb structure in your projects Only directories that contain overriding files have to be created In ini files only variables set in projects are overridden Other variables keep the values set in upstream ini files Following files can be overridden client conf ini client ini and plugins configuration files core plugins client php core plugins common php core plugins server php core plugins htdocs php core plugins templates tpl htdocs css css htdocs js js e htdocs gfx layout gif server conf server ini e server conf maplId ini mapld ini and plugins configuration files e templates tpl 36 Projects Handling You can add project specific mapfiles in directory projects my project server conf my mapfile To point to the new mapfile change the mapld value in projects my project client conf client ini You can add project specific plugins in directory projects my project plugins To load the new plugin add its name in c1ient ini and or my mapfile ini loadPlugins variable 3 2 Using Projects There are several ways to tell CartoWeb what project to use 3 2 1 Apache Environment Variable Set environment variable CW3 PROJECT in Apache configuration Directory your cartoclient path Options FollowSymLinks Action php script o6gi bin phps AddHa
84. I2 PDE TSS OTE cid oet eviter USD uto ehe adc eden eoe ut apii fulvo De use ode 83 2 1 Introduction uuo nan nn n EA 83 12 2 Configuration Reference getest ee fete Donneen goen 83 12 2 1 General Configuration neenon een e enteras 83 12 2 2 Formats Configuration EE 86 12 2 3 Blocks Configuration 5 3 e ertt ternis 86 122 4 Colors de finition ageet Stagiaire Ebene On Page potett 90 PD De Ken EE 90 12 3 D General Principle eee e RD ut ht oe etre est 90 12 3 2 Overall Configuration eese 91 12 3 3 Form E TEE 93 12 3 4 Blocks Configuration eene 93 12 3 5 Roles Management 4 55 ctetu metet HD eec en 101 E s sauteed celeste ciel Geel ieee eed eee 103 13 1 bie eet el RE 103 13 2 Views Configuration eren eee tette hne regn e pass 103 13 2 5 Views TEEN 103 13 2 2 Main Views Controller 4 2 ne eene 103 33 VIEWS BEE 105 13 5 L Loading E 105 13 3 2 Editing EE 106 E BOUE o eo aU M RO ied T AR 107 CartoWeb Documentation 14 1 Client side Configuration ET 107 PAA Le COMIN Joy nn nna n a 107 14 2 Related Elements in Mapfile eere 107 14 2 1 Metadatas ee paie e e E aea de 107 4 3 HOW EO EE o Rho eiie ias uut deel oot diu t 108 15 Security Configuration oie i eite e rat e e eir ge Ud 110 15 1 Lor or Ure dT TOP MENO Rc 110 15 2 Auth TE EE 110 15 2 1 auth ini Client side ssssseeeeeneee 111 15 2 2 Specia
85. MapHeight takes precedence over it 8 3 Related Elements in Mapfile 8 3 1 General Image Type The general output fileformat is handled by Mapserver The basic command in the mapfile is IMAGETYPE pngljpeglgif Then the OUTPUTFORMAT objects may set properties for each possible fileformat Example for jpeg OUTPUTFORMAT NAME jpeg DRIVER GD JPEG MIMETYPE image jpeg IMAGEMODE RGB FORMATOPTION QUALITY 85 EXTENSION jpg END See the available options for each format in the Mapserver doc Important note if you intend to use pdf printing interlaced png images are not supported by the fpdf library that is used in this module Consequently you must have the option FORMATOPTION INTERLACE OFFE in the definition of the png OUTPUTFORMAT Here is the complete object OUTPUTFORMAT NAME png DRIVER GD PNG MIMETYPE image png IMAGEMODE PC256 EXTENSION png FORMATOPTION INTERLACE OFF END 8 3 2 Automatic Image Type Switch 65 Image Format Options It is often desirable to adapt the imagetype of the map to the represented data Typically vector data is well rendered in png while the colors of a raster background require either jpeg or png24 format CartoWeb includes a mechanism that automatically switches the format when specific layers are selected A special metadata of the layers triggers this behavior METADATA force imagetype jpeglpng END This metadata overrides the general fileform
86. OR lt html gt 6 4 2 Lower Case This is because XHTML documents are XML applications XML is case sensitive Tags like lt br gt and lt BR gt are interpreted as different tags This is wrong BODY lt P gt This is a paragraph lt P gt BODY This is correct 207 Code Convention body lt p gt This is a paragraph lt p gt lt body gt This is wrong lt table WIDTH 100 gt This is correct lt table width 100 gt 6 4 3 Closing 6 4 3 1 All Elements Non empty elements must have an end tag This is wrong lt p gt This is a paragraph lt p gt This is another paragraph This is correct lt p gt This is a paragraph lt p gt lt p gt This is another paragraph lt p gt 6 4 3 2 Empty Elements Empty elements must either have an end tag or the start tag must end with gt This is wrong This is a break lt br gt Here comes a horizontal rule lt hr gt Here s an image img src happy gif alt Happy face gt This is correct This is a break lt br gt Here comes a horizontal rule hr Here s an image img src happy gif alt Happy face IMPORTANT Compatibility Note To make your XHTML compatible with older browsers you should add an extra space before the symbol like this br gt and this hr gt 6 4 4 Minimization 208 Code Convention This is wrong dl compact input checked input readonly input disabled
87. Plugin php and server ServerPlugin php files or take a look at the CartoWeb PHP API documentation 2 2 4 Plugin Creation Check List CartoWeb3 Plugins Board Plugins interfaces summary and entry points amp melne for CartoChent and CartoServer handieMmn ma pT o handieKe ymanToo get tools ntUser handieint Sessionabie loadSession Session able create Session nerProvider SiterPostRequest rovider SiterGe fe que st GuiProvider han dicH tp PostRe quest GuiProvider handieH tp GetReque z ServerCaller ulidRequest ServerCaller overtdeRequest handieHttpPo stRequest handieHttpGetfe quest renderFo em bulldReque st nitla eR es uit handieRes ut ServerCaller 3nitializeRes uit ServerCaller fhiandie Result TooiProvider get To ois GuiProvider renderFarm Exportable addjustExportia pReque st Session able save Session See chent ChentPlugin php and clent Cartociient php CartoServer nitializeRequest handiePreDrawing handieDrawing handiePostDrawing InitProvider nitiskze Chen Responder initialize Request Chen Responder override Request Care rm vider fhandleCorePlugin location layers Chentfesponder handieP reDrawing Chentfesponder handieDrawing Core mo vider fandieCorePlugin images ChentResponder handieP os Drawing See server Se rverPlugin nhn and serverfCartoserver nho Determine if you will write a plugin or a coreplugin
88. STYLE END LABEL FONT Vera TYPE truetype Cono 5L 51 SI SIBI END END END You will find more examples looking in the test map file in server conf directory 10 4 The ToolPicker 10 4 1 What is the ToolPicker The ToolPicker is a mini javascript framework used to display dynamically on screen several DHTML tools Some tools come pre included e ColorPicker The ColorPicker allows the user to pick a color He she can either pick it from a gradient map use RGB or HSL slider input RGB or HSL values input an hexadecial value or pick it from a preselected list of colors The color value is then returned to the main page e SymbolPicker The SymbolPicker allows the user to pick a symbol in a predefined list of symbols The symbols are generated off the sym file on the serverside of CartoWeb The symbol is then returned to the main page 10 4 2 Installation To use the ToolPicker in a project simply enable it in your client ini configuration file by setting toolPickerOn true The ToolPicker requires the corresponding script css and template in the cartoclient tpl file In the header lt link rel stylesheet type text css href css toolPicker css 75 Annotation and Redlining In the body preferably at the end include file toolPicker tpl 10 4 3 ToolPicker Usage The main ToolPicker function accepts 3 parameters 2 are mandatory the last is optional iccexodkmaLelsewe Sica oo
89. Server installation are given in Appendix B Apache amp Mapserver Windows Manual Installation Then download CartoWeb as described above Section 1 1 2 CartoWeb Download Eventually set CartoWeb up with the command line script cw3setup php Section 1 1 3 Command Line Installation from either a DOS or a Cygwin prompt See Section 1 1 4 3 CartoWeb Setup for more info about how to use those interfaces 1 1 4 3 CartoWeb Setup 1 1 4 3 1 CartoWeb Setup with DOS Open a command prompt Start menu gt Run gt cmd and go to the CartoWeb root cd C wamp www cartoweb3 Then see Section 1 1 3 2 1 Basic Setup Note To enable you to execute PHP scripts easily like php cw3setup php someparameters instead of C wamp php exe cw3setup php someparameters set the path to the PHP binary in your PATH environment variable control panel system Advanced Environment Variables If there is no PATH variable add a new one If a PATH variable is already present you can add the path to php exe at the end of the existing path values but add a inbetween path1 path2 path3 C NwampNphp The example above is true if the PHP binary are installed in C wamp php 22 Installation Note If you are using the demo you need to have Gettext support installed as it uses Gettext by default If you used the win32 installer Gettext is already installed otherwise you must install it manually You
90. This kind of tests are related to the server plugins that s why we chose to put them in the server folder of plugins For the first point mentionned above general Unit tests rules apply as described in Section 7 2 1 General Information About Writing Tests For the second point stated a help class named client_CartoserverServiceTest can be extended by the testing classes In turn client CartoserverServiceTest extends other classes which offer additional helpful methods For the complete list of available methods please have a look at the generate API docs as more may be added in future The main useful methods are createRequest for initializing a new request getMap for lanching the request Tip 214 Unit Tests Having a look at an existing plugin test case is the best starting point for writing new tests 7 2 2 3 Tests for projects Each CartoWeb project can have its set of tests directly inside the project in a directory tests Inside this directory you have to use the same hierarchy as in the main tests directory Inside these tests directories the same mechanism is used for testing as the main tests directory The best way to get started is to have a look at the test main project for a starting point 7 2 2 3 1 Invoking tests for a specific project For now only the command line can be used for invoking tests for a specific project An environment variable CARTOWEB TEST PROJECT can be
91. ZoomType gt element name zoomFactor type xsd float minOccurs 0 gt 157 Calling Plugins lt element name scale type xsd integer minOccurs 0 gt all lt complexType gt e bbox bounding box unused when zoom type ZOOM SCALE e point point to recenter on e zoomType type of zoom e zoomFactor zoom factor unused when zoom type ZOOM FACTOR e scale fixed scale unused when zoom type ZOOM SCALE 1 3 5 1 4 Recenter Request lt complexType name IdSelection gt ell ks lt element name layerId type xsd string element name idAttribute type xsd string element name idType type xsd string element name selectedIds type types ArrayOfString all lt complexType gt e layerld ID of layer on which query will be executed e idAttribute name of ID attribute e idType type of ID attribute string or int e selectedIds list of IDs lt complexType name ArrayOfIdSelection lt complexContent gt restriction base encll Array attribute ref encll arrayType wsdl arrayType types IdSelection restriction complexContent lt complexType gt array list of ID selections lt complexType name RecenterLocationRequest gt lt all gt element name idSelections type types ArrayOfIdSelection gt all lt complexType gt e idSelections list of ID selections 158 Calling Plugins 1 3 5 2 Location Re
92. _conf folder Then all specific configurations are stored in individual folders Each configuration contains e a Mapserver mapfile myMap map e its annexes symbols fonts images data e amain configuration file nyMap ini that must have the same name as the map e smaller configuration files for the plugins By default CartoWeb comes with a fully functional cest folder that includes the necessary geometrical datas and allows one to run an out of the box demo 4 3 2 Main Server Configuration File server ini e imageUrl string Path where cartoserver generated images can be accessed e reverseProxyUrl string The url of the reverse proxy if used 4 3 3 Map Configuration Files 4 3 3 1 Introduction The CartoServer has the ability to contains several different maps These maps are represented by the mapserver mapfile the CartoWeb configuration file for the map and each plugins configuration The file that contain the configuration information related to a map is located in the same directory as the mapfile but has a ini extension These files are in the directory server conf myMap 4 3 3 2 lt myMap gt ini e maplnfo loadPlugins list list of server plugins to load in addition to the core plugins Note that most server plugins also have a corresponding client plugin that must be loaded on the client side See Section 4 2 client ini 42 Configuration Files e maplnfo initialMapStates
93. a layer if meta data hilight createlayer is set to true 4 if meta data hilight createlayer is not set or set to false dynamically creates a class Here are the meta data that can be set to mapfile s layers hilight color 0 255 0 255 0 255 the hilight color of a dynamically generated class ow hilight createlayer the hilight hilight transparency 1 100 the transparency for dynamically generated true if true a new layer will be dynamically generated for layers Examples Hilight using layer name hilight layer LAYER NAME foo END LAYER NAME foo_hilight END Hilight using class hilight LAYER NAME foo CLASS NAME hilight STYLE END END END Hilight using dynamically generated layer 70 Queries LAYER NAME foo METADATA hilight createlayer true The lag calor 2905 2595708 Unto Menera NS parene ANSON END END 9 3 3 2 Mask Mode When mask mode is requested decision is made in the following order 1 looks for a layer named lt layer_name gt _mask 2 if not found dynamically creates a mask layer by copying current layer Masking process also tries to find a layer which would hide the area outside all possible selections 1 tries to activate a layer with name set in meta data outside mask 2 if meta data outside mask is not set looks for a layer named default outside mask 3 if not found no outside mask will be displayed Her
94. a time A few configuration parameters are available in c1ient conf exportCsv ini e separator indicates what character should be used to distinguish each tabular n cell value Default is semi colon e textDelimiter tells what character should be used to delimit the text in each cell It is specially useful when the character used as the separator may be found within the cell content Default parameter value is doub1e quote ie The alias is defined to overcome INI syntax issues filename specifies the filename naming convention to use It can include the table name using the ab1e7 keyword and the generation date under various formats Date formating is performed by indicating between a couple of brackets the keyword date followed by a comma and PHP date like date format see http php net date Default filename convention is date Ymd Hi table csv Which gives for instance 20050220 2021_myLayer csv e Ifthe charsetut fs boolean is set to true the result file will be UTF 8 encoded Else ISO 8859 1 encoding is used which is the default behavior After initial CartoWeb installation client_conf exportCsv ini is set as follows separator between each value default is separator delimiter before and after each value default is double quote Special characters double quote textDelimiter double quote file name format for exported CSV file default is table date dMY csv fileName
95. able layers initial state etc It shouldn t be called each time a map is requested A mechanism based on a timestamp is available to be sure configuration is up to date see Section 1 2 Call to getMapInfo SOAP method getMap is used each time a new map or related information are needed 1 1 Standard Structures 1 1 1 Simple Types These types are used in different other structures lt complexType name ArrayOfString gt lt complexContent gt restriction base encll Array gt lt attribute ref encll arrayType wsdl arrayType xsd string gt restriction complexContent lt complexType gt array list of character strings lt complexType name Dimension gt 140 Calling Plugins all element name width type xsd int gt lt element name height type xsd int gt Set lt complexType gt e width width in pixels height height in pixels lt complexType name GeoDimension gt lt all gt lt element name dimension type types Dimension gt lt element name bbox type types Bbox gt all lt complexType gt dimension dimensions in pixels e bbox bounding box see Section 1 1 2 Shapes for a description of type Bbox 1 1 2 Shapes These types define a hierarchy of shapes As heritage and polymorphism cannot be used type Shape includes all attibutes of its children types lt complexType name Bbox gt lt all gt lt element name minx
96. aces they will have access to complementary interactions as well In that case don t forget to overload the matching interface defined methods in your extended class For instance ClientMyProjectLayers extends ClientLayers implements ToolProvider ES weap Uf 180 New Plugins Tip To use new config parameters in your extended plugin add them in the ini file of your project original plugin eg projects your project client conf original plugin ini 2 3 4 Combining Both Approaches If you need to modify add templates or resources overrriding AND PHP classes extension you can combine both approaches by following the instructions of the two last sections Say you would like to customize the images coreplugin mainmap size and formats management to update the layout new pictos new texts new CSS e add some JS processing e adda new form field in a separated area of the CartoWeb interface First point is achieved by creating a images directory in projects yourProject coreplugins and filling it with an overriden template mapsizes tpl anew images css and some pictos projects yourProject coreplugins images projects yourProject coreplugins images templates mapsizes tpl projects yourProject coreplugins images htdocs css images css projects yourProject coreplugins images htdocs gfx button png ll MEET iol gt lt p gt t Mapsize t lt select name mapsize id mapsize on
97. ages request images request images request images request images request images request images request images request images request images request images request images request images request images Request className Request mainmap path Request mainmap width Request mainmap format Request gt keymap gt isDrawn Request gt keymap gt path Request keymap width Request keymap format Roguest scalebar opath Request scalebar width Request mainmap isDrawn Request scalebar format Request mainmap height ImagesRequest true 1 SOO SOO Db true TOO Request gt scalebar gt isDrawn Request gt keymap gt height 100 tr false 0 Request scalebar height 0 rr 169 Calling Plugins Two layers are displayed Resolution attribute is set to null to keep standard Mapserver resolution request layersRequest className LayersRequest request layersRequest layerlIds array swiss layer 1 swiss layer 2 request layersRequest resolution null In this case the location request object is of type bbox Only new bounding box is required request locationRequest className LocationRequest request locationRequest locationType bboxLocationRequest request locationRequest bboxLocationRequest bbox minx 550
98. akes benefits of several caching systems to speed up its execution All the possibilities are detailed in Chapter 5 Caches Configuration 14 User Manual Part Il User Manual This user manual second part of the CartoWeb documentation is aimed at administrators who have to setup configure and maintain a CartoWeb environment It is not an end user documentation so you won t find here instructions on how to navigate select layers or do whatever operations the distant users are allowed to do through their browser On the other side if you want to go beyond the standard out of the box possibilities of CartoWeb you ll definitely have to look at the third part of this documentation intended for developers 15 Installation 1 Installation 1 1 CartoWeb Installation 1 1 1 Prerequisite for Installing CartoWeb CartoWeb depends on several software components for its proper working Some are required and others are optional depending on what you intend to do Note Windows users can ignore this chapter and go directly to Section 1 1 2 CartoWeb Download The required software are A Web Server such as Apache http httpd apache org PHP gt 5 0 3 See http www php net for more informations You will need to have some features available in PHP e Gettext optional You need the Gettext module if you want to enable the Internationalization in CartoWeb See Chapter 16 Internationalization for config
99. alse e querySelections list if query selections It contains all objects that must be hilighted and can be used to maintain persistence of a selection 1 3 6 2 Query Result lt complexType name QueryResult gt lt all gt lt element name className type xsd string gt lt element name tableGroup type types TableGroup gt calle lt complexType gt e className QueryResult or extended class name if project implements an extension e tableGroup group of tables which contains query results one table per layer 1 3 7 Outline The Outline plugin allows to draw shapes on the main map Shapes can also be drawn as a mask ie as holes in a rectangle covering map It returns total area covered by shapes Outline request is not mandatory As Outline plugin is not a core plugin it must be activated in order to use the following request result objects 1 3 7 1 Outline Request complexType name Color all element name r type xsd int element name g type xsd int 161 Calling Plugins element name b type xsd int all lt complexType gt e r e g e b red green blue complexType name ShapeStyle SI element name symbol type xsd int element name size type xsd int element name color type types Color gt lt element name outlineColor type types Color element name backgroundColor type types Color element name t
100. ame than their parent class you will have to rename your plugin Any plugin name is OK as long as it is not already used but it is recommended to use a lt projectName gt lt initialPluginName gt separating words with caps Extended coreplugins directories and files must be saved in projects projectName coreplugins extendedPluginName whereas extended simple plugins ones will be located in projects lt projectName gt plugins extendedPluginName When writing your extended class the first thing to do is to specify what plugin is replaced by the new one This is done by overloading the replacePlugin method It should return the replaced plugin name For instance to extend the layers coreplugin CartoClient part in your myProject project create a ClientMyProjectLayers php as follows lt php ipackage CorePlugins version Id ClientMyProjectLayers php v 1 8 2005 02 23 11 52 43 johndoe Exp S class ClientMyProjectLayers extends ClientLayers public function replacePlugin return layers Add or overload methods here To be activated extended plugins AND coreplugins must be explicitely be declared in the loadPlugins parameter of your project general configuration files loadPlugins exportPdf auth myProjectLayers With no surprise extended classes can take advantage of the tools provided by the interfaces their parent classes implement By implementing additional interf
101. at PHP built in default values all format parameters have NULL default values except allowedRoles all 12 2 3 Blocks Configuration All blocks parameters are optional since default values are hard coded in the PDF export plugin PHP code see code documentation for PdfBlock class Those default properties can be partially or totally overriden using a template object whose syntax is similar to this template type text template fontFamily times template fontSize 12 template fontItalic false 86 PDF Export whereas real blocks are described this way blocks title weight 10 blocks title verticalBasis top blocks title verticalMargin 15 Template described properties have a global scope whereas blocks ones are specific to the given block Properties names are identical for both template and blocks objects Properties not related with the given block type are generally ignored for instance fontSize is not taken into account if block is an image A lots of properties use CSS like denominations and effects All following parameters names must be precede by either template or blocks lt block_name gt prefixes type textlimageltablellegend block type indicates what kind of processing must be applied content string optional for text blocks the textual content for image blocks the image filename for table blocks a comma separated list of textual content limited to one row
102. at of the mainmap but not of the legend icons these stay in the initial fileformat 66 Queries 9 Queries Core plugin Query allows to search for geographical objects Found objects are hilighted and if requested related data are returned to client Depending on configuration and user choices queries are executed on one layer several layers or all layers currently displayed on map Queries can be executed on a geographic selection or using a list of object IDs Geographic selection can be a point a rectangle a polygon or a circle but is a rectangle by default The second way to execute a query is used in particular to maintain selection persistence object IDs are stored client side and sent to server each time the page is reloaded Hilighting objects can be done using standard Mapserver queries or using special Hilight plugin See Section 9 3 3 Hilight Configuration for more information Results are returned and displayed using Tables plugin See Section 9 1 2 Tables Configuration for more information 9 1 Client side Configuration 9 1 1 query ini Here are the options that can be set in client s query ini e persistentQueries if true queries will be persistent If false selection is lost after next page reload Note that persistency will work only with layers with id attribute string set see Section 9 3 Related Elements in Mapfile e displayExtendedSelection if true shows form for selection ex
103. ate the blocks in the general activatedBlocks list That way it is possible to set the caption and headers layouts separately from the general table one which is their default layout Note that these subblocks are optional and will not be displayed if no content can be determined for them The same headers and caption subblocks can be shared amongst several table blocks CartoWeb output table content and its caption and headers subblocks is automatically determined But it is also possible to user define independent tables by filling the table and its caption headers content cells content are represented as comma separated string lists only one row available for table data For instance blocks queryResult type table blocks queryResult inNewPage true blocks queryResult caption tableCaption blocks queryResult headers tableHeaders blocks queryResult height 10 blocks queryResult verticalMargin 10 blocks queryResult hCentered true blocks tableCaption backgroundColor ff0000 blocks tableCaption color white blocks ta b b bleCaption content Table test b blocks tableCaption height 15 blocks tableHeaders backgroundColor ffaaaa blocks tableHeaders fontBold true blocks tableHeaders color eeeeff Tip A special table block exists to specify which TableGroup see Section 2 4 3 1 Tables Structures you want to display in the PDF blocks queryResult content query In that case
104. ay are created Create a LabelOverlay and set the text color Note that those three instances color style and label have only a subset of theirs variable who are set Slayerl new LayerOverlay Slayerl gt name cartoweb point outline Slayerl gt classes array class Put the class in the layer The behavior of layer1 can be resumed as Update or create a layer named cartoweb point outline In this layer insert a new class an call it foobar the first style of this class render as red 195 Dynamic mapfile modifications Slayer2 new LayerOverlay Slayer2 gt action BasicOverlay ACTION SEARCH Slayer2 gt name cartoweb point outline Slayer2 gt transparency 30 Search a layer named point point outline with a 30 transparency If this layer don t exist in the mapfile it will be created map new MapOverlay map layers array S layerl S layer2 Splugins this serverContext getPluginManager result plugins mapOverlay updateMap map The two layers are inserted in a Mapover1ay and the mapfile is updated 3 2 2 Add a feature The goal of this example is to add a feature with a specific style and transparency The layer name and transparency are given Tool and 40 Slayer new LayerOverlay Slayer gt name foo Slayer gt action BasicOverlay ACTION SEARCH Slayer gt transparency 40 SmapOverlay this serverContext getPluginManager
105. ay be specified in general formats to hide a block for non admin users use blocks overview allowedRoles admin 102 Views 13 Views 13 1 Introduction Views are recordings of CartoWeb maps states at a given moment One may see them as a kind of bookmarks while browsing maps in CartoWeb interface users can save the current state map extent selected layers queries annotations etc under a label of their choice It is then possible to access later those saved states Views are shared among users and are in the current version available to every user Access to views edition functionalities creation modification deletion can be restricted to some categories of users The default configuration only allows admin roled users to perform view edition 13 2 Views Configuration The views device consists of two parts e amain controlling system that handles views detection loading recording and storage e a views plugin that provides a graphical interface for performing views loading and edition This plugin is not mandatory to have views working but greatly enhances the device usability 13 2 1 Views Plugin No configuration is required for that plugin However it still needs to be activated using the client conf client ini loadPlugins parameter For instance loadPlugins auth exportPdf views 13 2 2 Main Views Controller Main views controller configuration is done in the client_conf client i
106. ayer will be displayed tree block radio or dropdown See Chapter 6 Layers for more details on this option metadata list of meta data defined in server configuration file Format of each string in list is variable name value complexType name ArrayOfLayer lt complexContent gt restriction base encll Array attribute ref encll arrayType wsdl arrayType types Layer restriction complexContent lt complexType gt array list of layers lt complexType name SwitchInit gt lt all gt lt element name id type xsd string gt lt element name label type xsd string gt gib lt complexType gt e id switch ID e label switch label lt complexType name ArrayOfSwitchInit lt complexContent gt restriction base encll Array attribute ref encll arrayType wsdl arrayType types SwitchInit restriction complexContent lt complexType gt array list of switches lt complexType name LayersInit gt lt all gt element name notAvailableIcon type xsd string gt lt element name notAvailablePlusIcon type xsd string gt 148 Calling Plugins element name notAvailableMinusIcon type xsd string element name layers type types ArrayOfLayer element name switches type types ArrayOfSwitchInit minOccurs 0 gt all lt complexType gt e notAvailablelcon filename of icon for not available layer current
107. ayerGroup o radio quite similar to the tree rendering with radio buttons replacing checkboxes Only one child layer can be selected at a time o block children layers are separated as blocks separation medium depends on the template layout Note that the rendering will be applied to the children not to the LayerGroup itself which is not displayed at all o dropdown as for block rendering the LayerGroup is not displayed Its children are simply rendered as an HTML simple select options list If the selected child layer cannot be determined using posted or session saved data first child according to the layers layerld children list order is selected If any only the selected child layer s own children are displayed under the dropdown list 51 Layers e layers layerId metadata minScale resp maxScale one may specify a numerical minimal resp maximal scale for the given LayerGroup This parameter has absolutely no effect on Mapserver behavior and is only used to display out of scale icons and links in the layers tree For more info about 1ayers ini metadata parameters see Section 6 3 2 Metadata in layers ini 6 2 4 Children Switching Children switching is useful to define several lists of children for one layer group The children that will be displayed is choosen by a special parameter the switch ID Switch IDs and labels are listed in file 1ayers ini In default test environment a dropdown is constructed u
108. ayers Metadata declared in mapfiles or 1ayers ini can be used in the 1ayers tp1 Smarty templates using the following notation capture name caption Selement layerLabel lt a href lang element layerMeta lang amp client id element layerMeta client id element layerMeta complex label a capture As we can see in the previous example metadata values can be used through the layerMeta property of the element Smarty variable Typical usage of this feature is to render for instance several HTML links for each layers 6 4 Layers Legends CartoWeb includes a mechanism for the automatic generation of legends If desired an icon is drawn for each class of the layers There are two conditions that must be fulfilled to make it work 1 The mechanism must be enabled by setting autoClassLegend true in layers ini 2 Each class or more precisely each class that should appear in the legend must have a name Here an example LAYER NAME spur_spurweite METADATA END TYPE line CLASS NAME Normalspur 1435 mm EXPRESSION MM 1435 STYLE COLOR 0 0 255 blue END END CLASS NAME Meterspur 1000 mm EXPRESSION MM 1000 STYLE COLOR 255 0 0 red END END CLASS NAME Schmalspur lt 900 mm EXPRESSION MM lt 900 54 Layers STYLE COLOR 128 0 128 lila END END END In this case the second class would not appear in the legend because the NAME is commented out
109. both CartoClient and CartoServer sides or at least files that are not specific to one side or the other e templates contains all the plugin specific Smarty templates Since HTML templates are only used in CartoClient files from templates are only called by client code e htdocs contains all files PHP pages images JavaScript or CSS files etc that may be web accessed when running the plugin Those files are dispatched in various directories depending on their nature If necessary you can create additional subdirectories For instance java if your plugin uses a Java applet To preserve the plugin independence it is strongly recommended not to add your CSS styles in the general CartoClient style sheet but to create a specific file here that will be called separately Note that it is not required to actually create the whole structure described above Only directories that contain files are necessairy For instance if a plugin only perform CartoServer actions it is no use to create c1ient templates and htdocs directories common may be usefull if not CartoServer specific classes have to be defined There are two ways to add a plugin coreplugin to CartoWeb writing a brand new one or overriding extending an existing one 2 2 Writing a Plugin 2 2 1 Introduction If no existing plugin or coreplugin fulfils your requirements and if none offers close enough functionalities to justify an adaptation you can write a new plugin
110. can get a version of Gettext for Windows there http gnuwin32 sourceforge net packages gettext htm Also set the path to the Gettext binary in your PATH environment variable C Program Files GnuWin32 bin The example above is true if the Gettext binaries are installed in c Program Files GnuWin32 bin This is needed by the po2mo php script to merge and compile the languages translation files Note If you intend to use CVS in command line you need to install a CVS client Use WinCVS http www wincvs org or TortoiseCVS http www tortoisecvs org download shtml both are free Open Source clients You must add the path to the CNS binary in your PATH environment variable C Program FilesNTortoiseCVS The example above is true if you installed TortoiseCVS in c Program FilesNTortoiseCVS 1 1 4 3 2 CartoWeb Setup with Cygwin Open a Cygwin window and go to the CartoWeb root ool Es cd wamp www cartoweb3 Then see Section 1 1 3 2 1 Basic Setup Note You can download Cygwin here Cygwin http www cygwin com When you install Cygwin be sure to select the packages tar or unzip and cvs You can also install the gettext devel package so you wont need to get an external gettext installation later If you have already installed Cygwin type the following command to see what package are currently installed cygcheck c If the packages mentioned above are not present run Cygwin setup again and add the missi
111. ces such an indentation might be used for javascript coding as well Generated HTML pages should be XHTML 1 0 say Transitional for now valid and pass matching W3C validation http validator w3 org http validator w3 org 206 Code Convention XHTML standing for eXtensible Hypertext Markup Language was chosen vs simple HTML for following reasons XHTML is aimed to replace HTML XHTML is a stricter and cleaner version of HTML XHTML is HTML defined as an XML application For more information on XHTML reference and tutorial are available here http www w3schools com xhtml Specially useful pages are e Differences between HTML and XHTML http www w3schools com xhtml xhtml html asp XHTML syntax http www w3schools com xhtml xhtml syntax asp But here are some things people must know to get XHTML valid generated pages 6 4 1 Nesting In HTML some elements can be improperly nested within each other like this lt b gt lt i gt This text is bold and italic lt b gt lt i gt In XHTML all elements must be properly nested within each other like this lt b gt lt i gt This text is bold and italic lt i gt lt b gt All XHTML elements must be nested within the lt html gt root element All other elements can have sub children elements Sub elements must be in pairs and correctly nested within their parent element The basic document structure is lt html gt lt head gt lt head gt Socr ana SI
112. ch gt lt restriction gt lt complexContent gt lt complexType gt array list of children switches complexType name Layer SET lt element name className type xsd string lt element name id type xsd string gt lt element name label type xsd string gt lt element name children type types ArrayOfChildrenSwitch minOccurs 0 gt lt element name minScale type xsd double gt lt element name maxScale type xsd double gt lt element name icon type xsd string gt lt element name link type xsd string gt lt element name aggregate type xsd boolean minOccurs 0 gt lt element name rendering type xsd string minOccurs 0 gt lt element name metadata type types ArrayOfString minOccurs 0 gt lt all gt lt complexType gt className layer class name LayerGroup Layer or LayerClass e id layer ID e Jabel label to be displayed This label is not yet translated using internationalization e children list of children Calling Plugins minScale minimum scale at which layer will be displayed e maxScale maximum scale at which layer will be displayed icon filename of the static icon for the layer Dynamic legends are described in Section 6 4 Layers Legends e link if set layer name is clickable e msLayer MapServer layer id aggregate if true children are not displayed and cannot be selected individually e rendering how l
113. change javascript checkMapsize html options options mapsizes options selected Smapsize_selected select input type image src r type gfx plugin images button png r alt t Ok button t id imagesButton gt lt p gt For details about template r resource and t translation tags see Section 17 2 nternationalization and Section 17 3 Resources checkMapsize JavaScript function is not defined in the upstream coreplugin So we have to add a JS file in our overriden plugin projects yourProject coreplugins images htdocs js projects yourProject coreplugins images htdocs js images js 181 New Plugins images js function checkMapsize alert foobar To add a new form field in a separated area and consequently in a separated template there is no other way than to modify the client Images PHP class in order to call the additional template in a special method The extension approach is thus required Then create a yourProjectImages directory in projects yourProject coreplugins as follows projects yourProject coreplugins yourProjectImages projects yourProject coreplugins yourProjectImages client projects yourProject coreplugins yourProjectImages client ClientYourProjectImages php It can seem a little tricky but the new template file say yourImages tp1 will not be stored in projects yourProject coreplugins yourProjectImages templates as one can expect it but in p
114. chronous 23 2 2 1 Introduction For the area async defined layers area tags are sent within the HTML source of the page So interactive areas are available on the map on top of corresponding features When the user moves the mouse over each area and stopping during several milliseconds an AJAX request is sent to CartoWeb using the id of the given feature A response is sent back to the browser within the HTML code in regard to the selected feature 23 2 2 2 Pros Cons Pros e semi live result the layout for the result can be customized Cons e does not work for line type features may be ressource consuming and performances may fail for large amount of features but less than with the area direct method e database postgresql required only one result at a time if several features are stacked on each other only the result of the uppermost feature is displayed 23 2 2 3 Configuration 134 ToolTips Here are defined parameters available for area async layers e label optional label fo the layer If not set layerId is diplayed e dsn connection string to database Data Source Name dbTableName name of the table in database attributes comma separated list of attributes to be displayed e idAttributeString name of the field in the database matching to the id attribute string metadata in mapfile template optional custom template must be in overriden toolTips plugin templates di
115. color codes or a few textual aliases such as white black red green blue For instance general overviewOutlineColor red template backgroundColor white template borderColor 000000 hexadecimal code for black Broek gabe IS eto ose 0000ff hexadecimal code for blue 12 3 Tutorial 12 3 1 General Principle The PDF document to generate is described using elementary objects blocks texts titles copyrights dates images maps logos tables queries results e legend list of icons labels for each printed layers Those blocks are drawn and positioned on the document pages according to properties detailed in each block In addition some data must be specified to describe the general document characteristics such as formats pages size orientation available resolutions PDF engine and more Parameters containing several values are represented using comma separated lists of strings integers If some values contain special characters such as accentuated letters quotes or other exclamation marks it may be wiser to encapsulate the whole parameter value between double quotes Warning Note3 don t forget to activate the plugin by adding it in the loadPlugins from BOTH CartoClient and CartoServer configuration files client conf client ini and server conf mapId mapId ini For instance 90 PDF Export pin eleme cont ei eat ini loadPlugins hilight outline exportPdf in
116. contain the list of new column IDs Values of columns given in parameter inputColumnIds Will be transfered to the callback method for cell content calculation Parameter ca11back should contain a pointer to a callback method with the following signature static function myCallbackMethod table id array Column ILU Ss Vyeloe EN 5 column 2 gt value 2 return array new column 1 gt cell value 1 new column 2 gt cell value 2 Parameter columnPosition indicates where the new columns must be inserted It should be an instance of class ColumnPosition Positions can be absolute or relative with a positive or negative offset Sposition new ColumnPosition ColumnPosition TYPE ABSOLUTE 1 The new columns will be added after the first column Sposition new ColumnPosition ColumnPosition TYPE ABSOLUTE 2 190 New Plugins The new columns will be added just before the last column Sposition new ColumnPosition ColumnPosition TYPE RELATIVE Qo ees i9 The new columns will be added just before column column 1 Sposition new ColumnPosition ColumnPosition TYPE RELATIVE db Aerer dE V Jp The new columns will be added just after column column 1 2 4 3 2 10 Column Adder Batch public function addColumnAdderBatch groupId tableId columnPosition newColumnIds Sinputcolumnlds Scallback Column adder rules used in batch mode allow to add one or more columns to the table while calculating
117. ct deett ee nor OX R di ase 237 CX Project Shortt erstes e S E er aE 237 CA Loading RE 238 C5 Location Parameters ieu ciere dort ue Pi EEN 239 C6 Your e 239 C7 OUDE Men T 239 CB Pdf Prin mng visco orenera ete E T A E 241 C9 Templating and Layout EE 241 D DocBook Documentation Generation esee 242 D 1 Documentation Generation on UNIX like System 242 D 1 1 Tiny DocBook Install eene 242 D EI EE 242 D 1 3 Create a Symbolic Link to Documentation Source 243 D 1 4 XHTML Generation eoo pn tec He ebore troi but ane 243 DL PDF Generation eegene 243 D 2 Documentation Generation on Windows using Cygwin 243 lo e 244 11 Presentation and Architecture Part I Presentation and Architecture This first part of the documentation is an overall presentation of both the visible and the hidden features of CartoWeb The goals are first to give an idea of what CartoWeb can readily do if used as it is shipped and second to explain why it is a powerful framework to build more advanced applications Project Presentation 1 Project Presentation 1 1 About CartoWeb CartoWeb3 is a comprehensive and ready to use Web GIS Geographical Information System including many powerful features As a modular and extensible solution it is also a convenient framework for building advanced and cust
118. ct coreplugins layers htdocs css toto css o Smarty r type css plugin layers toto css r o generated URL myproject layers css toto css e Projects Plugins override o path projects myproject plugins hello htdocs css toto css o Smarty r type css plugin hello toto css r o generated URL myproject hello css toto css Projects specific plugins o path projects myproject plugins myplugin htdocs css toto css o Smarty r type css plugin myplugin toto css r o generated URL myproject myplugin css toto css 122 Accounting 18 Accounting CartoWeb provides a mechanism to store accounting informations These informations can be used to generate statistics of the application usage 18 1 Accounting Configuration 18 1 1 Introduction Accounting configuration specifies if the accounting is enabled or not and how to store the accounting information The configuration is the same for the client or server Notice however that if you are using CartoWeb in direct mode the server accounting configuration is not taken into account See Section 4 2 client ini for more information about direct mode When you enable accounting you also need to activate the accounting plugin in your configuration This is done through the 10adP1uginsparameter parameter of client ini and mapInfo loadPlugins of your server conf cmapId mapId ini file 18 1 2 client ini or server ini Here are the options that can be set on the
119. d There are two ways to get CartoWeb 1 Complete package from the official website o Download CartoWeb package from http cartoweb org downloads html It is recommended that you download the version with demo for a better user experience Uncompress the archive somewhere in your path accessible by your web server 17 Installation 2 From CVS Get the current development version via CVS using the following command cvs d pserver anonymous dev camptocamp com var lib cvs public co cartoweb3 From CVS with cw3setup php If you already have the cw3setup php file which comes along the CartoWeb package or CVS source you can fetch CartoWeb from CVS and set up it at once See Section 1 1 3 2 6 Install or Reinstall CartoWeb from CVS and Set Up It at Once for more details Once you have CartoWeb point your web browser to the file located in htdocs info php and check that the PHP information page displays correctly meaning PHP is correctly setup and that you have do not have a WARNING message at the top of the page about MapScript failing to load If it is not the case CartoWeb will not run correctly You should install and set up PHP and PHP MapScript correctly See Section 1 1 1 Prerequisite for Installing CartoWeb Having Gettext installed is recommended if you wish to use the multilingual features of CartoWeb 1 1 3 Command Line Installation CartoWeb installer is cw3setup php located in the root directory of t
120. d be avoided in production but may be useful in development if you have to frequently switch the working project add a new file c1ient myproject php in the root htdocs directory This file only sets the environment variable and then calls the normal client php Each project has so its own URL lt php S_ENV CW3_PROJECT myproject require_once client php pr 38 Configuration Files 4 Configuration Files When installing CartoWeb the administrator of the application may want to adapt it to the environnement use This can be easily done using configuration parameters Some are required and CartoWeb won t correctly work if they re not set Others are optional but could hardly change the application behavior You will also find specific config parameters in the plugins related chapters of this documentation 4 1 Common client ini and server ini Options Common options for both client and server These parameters are available in client conf client ini for client and server conf server ini for server e profile developmentlproductionlcustom current settings profile The development profile has no cache activated and makes SOAP work in WSDL mode The production profile has all caches activated for best performances Setting this parameter to development or production will override some parameters in the configuration The custom profile means the parameters about caching and other are not overrided e useWsdl
121. d in detail in Chapter 12 PDF Export In particular see Section 12 3 5 Roles Management 114 Internationalization 16 Internationalization 16 1 Translations Translation handling in CartoWeb was designed to use gettext http www gnu org software gettext manual However internationalization architecture is ready for other translation systems Note Scripts detailed below are only available in command line prompts DOS shell They cannot be launched using a web browser 16 1 1 Configuration For now only gettext translation system is implemented If gettext is not installed you can use a dummy translation system which translates nothing To use gettext you will need to have PHP gettext module installed Translation system is now automatically set to gettext if gettext is installed otherwise it s disabled Parameter 76nClass is now deprecated 16 1 1 1 Unix like In Unix like environments file etc locale alias contains aliases to installed locales For each language used a line must be present in this file The alias fr in the example below must point to a locale installed on the system Pie ier Cit WSO IO DIO MI You will need to run locale gen after editing etc locale alias to regenerate system s locales To install a locale on a Debian installation use following command with root priviledges dpkg reconfigure locales If package locales has never been installed you have to ins
122. d in directories lt cartoweb_home gt cli nt and lt cartow b_home gt server touch trace apd When using Cartoweb in direct mode only one trace file will be generated When using Cartoweb in SOAP mode two trace files will be generated one for client and one for server These files can be found in directory set in apd dumpdir variable php ini see above 10 2 2 Simple Execution Times To get global execution times use script cwprof php e First usage execute script on each trace file This could be useful to re parse an old trace file If you have separated trace files for client and server you will need to execute the script twice cd lt cartoweb_home gt scripts php cwprof php lt trace_file gt e Second usage execute script on a directory The script will parse the most recent trace file The 1oca1 option is used when client and server trace files are located in same directory In this case the two most recent trace files are parsed and results for client and server are merged cd cartoweb home scripts php cwprof php local trace directory Script output will look like this times in milliseconds Exec client 451 Exec server total 707 Exec MS obj 472 Exec MS other 85 Exec total 1524 e Exec client time elapsed on client Will be empty if script is executed on a server only trace file e Exec server total time elapsed on server It includes Exec MS obj and Exec MS other times
123. d ooo function yourToolReturn return someValue HUINCGEAGIN Yori Neyo Da eqs dew Eemere Leet db cea The Init function is used to set the incoming values It is always called when the ToolPicker starts It receives the input value recovered from the main page The Setup function can be used to do all the actions you want The Return function is used to return a value to the main page The Display function is used to display something in the main page It receives the id of the target element to use something_d Add the following four function definitions functionList yourToolInit yourToolInit functionList yourToolSetup yourToolSetup functionList yourToolReturn yourToolReturn functionList yourToolDisplay yourToolDisplay These are needed because of the dynamic function call inside the framework which do not use the eval function to increase performances The width of the tool area available on screen is 245 pixel Height is variable 79 Export Plugins 11 Export Plugins 11 1 Introduction It is possible to export maps and data from the viewer ie the CartoWeb user interface in order to print them or to save them on the user s computer Five formats are available PDF CSV HTML DXF and raw image The PDF export plugin is precisely described usage configuration in next chapter Chapter 12 PDF Export 11 2 HTML Export The exportHtmi plugin outputs an HTML simplified version of t
124. d or user deactivated images For data images a convenient alternative text should be specified but for layout only pictos it is no use to display a replacement message For instance img src mainmap gif width 400 height 200 alt Main map gt img src pixel gif width 50px height 1px alt 210 Unit Tests 7 Unit Tests 7 1 Introduction Unit tests are an important componant in the CartoWeb development environment The framework used for unit testing is based on PHPUnit2 http www phpunit de en index php a PEAR package For more informations abouth PHPUnit2 see http pear php net reference PHPUnit2 2 0 3 PHPUnit2 is included in the libraries shipped with CartoWeb Thus no installation is needed to run and write new tests 7 2 Writing Tests Information about writing tests for CartoWeb can be separated into two parts First part about writing Unit tests in general useful for people new to PhpUnit Then a part more specific about the infrastructure which is available in CartoWeb for writing tests 7 2 1 General Information About Writing Tests Test cases are located in directory tests for testing the core of CartoWeb and in the directoies project tests for for tests specific to project project Inside these tests directories path hierarchy mirrors the existing hierarchy they are testing For instance the tests hierarchy for the core CartoWeb testing is the following client
125. dcard e column 1 rule will be executed on columns called column 1 only coll rule will be executed on columns with name starting with col e rule will be executed on any columns For instance following rule may be executed on groups with name starting with myGr tables called myTable and all columns registry addColumnFilter myGr myTable array this myCallbackMethod Only one rule of each type may be executed on one item If two or more rules apply most specific rule will be choosen In the following rule definition only the third rule will be executed on a table myTable in a group myGroup Sregisbryv oaddColumnsSelector arravtteolumn 1 column 27 ji registry addColumnSelector myGr array column 1 registry addColumnSelector myGr myTable array column 2 registry addColumnSelector myGroup toto array column 3 2 4 3 4 Executing Rules 2 4 3 4 1 On Client Each time a table group is created it must be stored in Tables plugin in order to display it StablesPlugin this cartoclient getPluginManager tables StablesPlugin gt addTableGroups newTableGroup Tables rules are executed automatically at the same time 2 4 3 4 2 On Server Rules execution must be done explicitly on server A call to Tables plugin applyRules method is needed for each new table group before returning it to client 192 New Plugins StablesP
126. debugging the application The two concepts are somewhat related as logging is often used as a way to ease debugging 9 2 Logging Logging is an important feature for being able to see what happens debug more easily the application and track invalid or unexpected situations The logging framework used for CartoWeb is Log4php http logging apache org log4php Log4php is a portage to Php of the famous Log4j Java logging library Thus Log4php has lots of similarities with Log4j and users familiar with it will have no problems understanding it 9 2 1 Log4php Activation To activate the logging with the default settings uncomment the line log4php rootLogger DEBUG A1 in client conf cartoclientLogger properties 9 2 2 Log4php Configuration Files Log4php settings are customizable in the c1ient conf cartoclientLogger properties configuration file on the CartoClient and server conf cartoserverLogger properties on the CartoServer For the detailed syntax of the configuration file see the Log4php documentation A very short introduction is given there The line log4php rootLogger DEBUG A1 can be uncommented which will activate the loggers defined in the lines starting with log4php appender NAME where NAME is the name in the list DEBUG Ai After the loggers are activated the the log output will be redirected to the corresponding location In the line 16g4php appender A1 file LOG HOME cartoclient log
127. directory into the current directory or in the directory given by the install location parameter NOTE 1 You must be located where cartoweb3 directory will be created not inside like other commands NOTE 2 You may either use a path relative to the target cartoweb3 directory or an absolute path Ge ES Une abo Directory where to install CartoWeb when using fetch from cvs dir options delete existing Overwrite existing directories if any no symlinks Do not use symbolic links even if your operating System supports them lt Gontig Erom Pile FTEs Location obo n contsgurstocon fa2le Dor sutomatce variable replacement in in files NOTE You may either use a path relative to the target cartoweb3 directory or an absolute path config from project PROJECT Read the configuration file containing variables to replace in in files from the specified project fetch project cvs PROJECT Fetch the given project from CVS see cvs root option To fetch several projects at a time specify this option as many times as necessary fetch project dir DIRECTORY Fetch the given project from a directory To fetch several projects at a time specify this option as many times as necessary project PROJECT Installation is launched only for given project To install several projects at a time specify this option as many times as necessary default project PROJECT Default project to use base url BASEURL URL where you
128. ds ServerPlugin 7 Make your classes implement needed interfaces and redefine corresponding methods Note that the common part class YourPlugin does not have to extend or implement any CartoWeb class or interface It is used as a container for common data and treatment used by client and server classes 8 Activate your plugin by adding its name to the loadPlugins of the matching project configuration files 2 2 5 Automatic Files Inclusion Main plugin PHP files eg Cc1ientYvourPlugin php ServerYourPlugin php YourPlugin php are automatically included and their contained classes and objects are directly accessible Other files in client server Or common are not and must be included explicitely in the main plugin PHP files Templates stored in the plugin cemp1ates directory are also accessible directly by using PHP code similar to the followin one Ssmarty new Smarty Plugin this getCartoclient this smarty assign foo bar return smarty fetch yourPlugin tpl 2 3 Adapting a Plugin 2 3 1 Approaches If an already available plugin or coreplugin offers close functionalities to the ones you need if you wish to slightly modify its behavior or simply want to adapt its output to your website layout it is far easier to adapt it then to build a new one from scratch There are two levels of plugin adaptation You can override its HTML templates resources pictos CSS or JS files and its configuration as
129. e If you are using Windows XP it may be necessary to modify the extension dir value in php ini by using instead of 236 Create a New Project Appendix C Create a New Project This appendix describes how to configure your own project The main steps are detailed here C 1 Project Directory Get in the projects folder of Cartoweb Rename the sampleProject directory to the name of your project Edit the ciient ini in of this new project and modify the mapId parameter value with the name of your project mapId your project name Open the server conf directory and rename the sampl1eProject directory to the name of your project In this folder two more files need to be renamed sampleProject map and sampleProject ini With the name of the new project C 2 Setup Your Project In a command line prompt DOS shell launch the cw3setup php setup script XPHP INTERPRETER cw3setup php install base url http localhost cartoweb3 htdocs profile development project nameOfYourProject See Chapter 1 Installation for more info on the installation script If no error occured you should be able to access your project by typing http localhost cartoweb3 htdocs client php in your browser and selecting your project from the projects drop down menu C 3 Project Shortcut To make development easier you can create a shortcut file to access your project directly Go in cartoweb3 htdocs and copy the fil
130. e po If translation files see Section 16 1 3 Translating already exist a merge is done using msgmerge http www gnu org software gettext manual html_chapter gettext_6 html SEC37 command Follow these steps generate project and mapfile templates on server cd cartoweb home scripts php server2pot php For each mapfile two templates will be generated server po and 116 Internationalization server lt mapfile_name gt po generate project template on client cd lt cartoweb_home gt scripts php client2pot php For each project one template will be generated client po It is possible to specify for which project you want to generate the po file Simply add the project name as a parameter when launching the scripts client2pot and server2pot php server2pot php myprojectname If you do not specify a project name the po files will be generated for all projects 16 1 3 Translating As for any gettext system translating PO files can be done in Emacs in Poedit http poedit sourceforge net or in any text editor Translated PO files must be saved under name lt template_name gt lt lang gt po where lt lang gt is the 2 letters ISO language en fr de etc For instance the mapfile test of test_main project will have three PO files in its PO directory for a complete french translation e server fr po e server test fr po client fr po 16 1 4 Compiling PO to MO To compile all PO
131. e xsd integer element name offset type xsd integer element name columnIds type types ArrayOfString element name columnTitles type types ArrayOfString element name noRowId type xsd boolean lt element name rows type types ArrayOfTableRow Salt complexType tableld table ID e tableTitle table title e numRows number of rows in table e totalRows total number of rows in context for future use offset current position in context rows for future use e columnlds column IDs see Section 1 1 1 Simple Types for a description of type ArrayOfString columnTitles column titles see Section 1 1 1 Simple Types for a description of type ArrayOfString e noRowld if true table rows contain no row IDs 143 Calling Plugins e rows list of rows complexType name ArrayOfTable lt complexContent gt restriction base encll Array attribute ref encll arrayType wsdl arrayType types Table restriction complexContent lt complexType gt array list of tables complexType name TableGroup all element name groupId type xsd string element name groupTitle type xsd string element name tables type types ArrayOfTable all lt complexType gt e groupld ID of table group e groupTitle title of table group tables list of tables complexType name ArrayOfTableGroup lt com
132. e are the meta data that can be set to mapfile s layers mask color 0 255 0 255 0 255 color of the mask when mask layer layer name mask is not defined now e mask transparency true transparency of the mask when mask layer layer name mask is not defined outside mask layer name name of layer which will mask the outside aka complement If not set will try to find a layer named default outside mask Examples Mask using layer name mask layer LAYER NAME foo END LAYER NAME foo mask END 71 Queries Mask using layer name mask layer and an outside mask LAYER NAME foo METADATA outsids mast par END END LAYER NAME foo mask END LAYER NAME bar END Mask using dynamically generated layer and default outside mask LAYER NAME foo METADATA Lime ol o5 EU 215902 51215 0t mask transparency 60 END END LAYER NAME default outside mask END 12 Annotation and Redlining 10 Annotation and Redlining Imagine you want to draw some features points lines polygons in your map to show specific data and or print it The outline plugin is what you need It allows you to draw features and to annotate them with label texts It s also possible to use polygons shapes as a mask layer see Mask mode User can choose between mask or draw mode with radio buttons See Section 10 2 1 outline ini for more information Shapes colors a
133. e democw3 php Rename the file to any name usually your project name Edit the file and replace demoCW3 by your_project_name Your project is now directly available with the URL http localhost cartoweb3 htdocs your project name php the URL given above depends on your installation see the previous comments about 237 Create a New Project cartoclientBaseUrl and base url GA Loading Data As you can see the project you created is hopelessly empty Then we ll load spatial data in it Add the following in the mapfile your project name map LAYER NAME region TYPE POLYGON DATA reg france TEMPLATE ttt CLASS NAME region STYLE COLOR 240 240 240 OUTLINECOLOR 255 165 96 END END METADATA rdestbribute cstring CODES END END And in the 1ayers ini file server conf your project name add the following layers region className Layer layers region label R gions layers region msLayer region And add the new layer id in the root layer children list layers root children region For more details on how to fill the layers ini file see Chapter 6 Layers Also edit the your project name ini file in a text editor in order to set some initial mapstates such as default selected layers Add the following mapInfo initialMapStates default layers region selected true See Section 4 3 3 3 Initial Mapstates for more info about initialMapStates In your browser click on the reset session bu
134. e following class implements a filter which allows to recenter on an object while hilighting it class ClientFilterIdrecenter extends ClientPlugin implements FilterProvider public function filterPostRequest FilterRequestModifier request public function filterGetRequest FilterRequestModifier Srequest 186 New Plugins Sid request getValue id LE Is nallfs10 J Slayer grid classhilight request setValue query layer Slayer request setValue query maskmode 1 request setValue query select id request setValue id recenter layer Slayer request setValue id recenter ids id 2 4 3 Tables Tables plugin is responsible for table formatting and display 2 4 3 1 Tables Structures Tables plugin declares several structures to help plugin developer manage tables These structures are Class Table which includes in particular a list of rows class TableRow Class TableGroup Which includes in particular a list of tables Table groups are used for instance to separate table results coming from several plugins Class TableFlags which defines parameters that will be useful for a plugin using tables Typically a plugin using table will include a TableFlags in its request and a TableGroup in its result This is the case for Query plugin which is the only core plugin which uses tables 2 4 3 2 Setting Rules Tables plugin maintains an object called the regi
135. e if the security check of layer access is activated It might have a minor impact on performances if a large number of layer is used Here s an example of a security metadata key used in layer of the mapfile METADATA exported values security view some specific parameter security view admin some specific parameter value 113 Security Configuration dart ri bute steroq PUD erring mask transparency 50 nmask Colieie W255 255 y area_fixed_value 10 END In this example the layer containing this metadata description will only be visible for users having the admin role Note Notice the usage of the exported_values metadata key which lists the security related metadata key It is explained in Section 6 3 Metadata in Mapfile and layers ini Now let s look the case where the metadata key is set on a layer group in the layers ini configuration file layers group admin className LayerGroup layers group admin children grid defaulthilight layers group admin metadata security view admin In this example the admin role is set for the layerGroup called group admin You can notice the very similar syntax as used in the mapfile Warning Don t forget to set applySecurity to True in the layers ini CartoClient configuration file otherwise security metadata keys won t be taken into account 15 4 2 PDF Printing Permissions The roles management in Pdf printing is explaine
136. ecurity infrastructure from the developer point of view For general details about security and its configuration see Chapter 15 Security Configuration The security management in cartoweb is separated in the following parts Management of the user password roles database SecurityContainer class in common SecurityManager php Management of user authentication calling checkUser and setUser setUserAndRoles in SecurityManager e Granting access to objects based on the current roles 4 2 Plugins Managing Security Database and Authentication Point 1 and 2 in the previous section are the responsibility of specific plugins For an example see the autn plugin 4 3 Plugins Granting or Denying Access to Objects Features in CartoWeb This point is the most important for plugin developers wanting to use the CartoWeb security mechanisms to allow or deny an access to a feature object The plugin can call the method nasRo1e roles on the current security manager For an example let s take the pdf plugin which has to restrict printing some formats only to allowed users in the ini file we could have formats A4 allowedRoles printers admin In the plugin we can then check the permissions with in the routine building the available format list 198 Using the Security Infrastructure foreach formats as format add the format to the list Sroles this getRolesForFormat format this should get it
137. els appear in the public view dropdown selector whereas invisible ones don t 105 Views 13 3 2 Editing Views Views edition is restricted to users whom roles match at least one of those specified in the client conf client ini viewAuth parameter see Section 13 2 2 Main Views Controller Views editors can create update or delete views 13 3 2 1 Saving a View To save the current map state as a view simply fill in the form fields with matching metadata To make the view visible check the Show view option Finally push the save button Y ou may also save a new view using an existing view To do so load the desired view as described in Section 13 3 1 Loading Views modify it as explained in Section 13 3 2 3 Updating a View and push the Save as new view button 13 3 2 2 Deleting a View Load the view you want to delete as shown above and push the Delete button A JavaScript confirmation pops before irreversible deletion 13 3 2 3 Updating a View To modify a view map properties selected layers annotations map extent etc as well as its metadata title visibility etc load it as seen above If your changes only concern metadata simply update the dedicated form fields and push the Update button To update the view map properties check the Memorize form option Metadata and selected view ID are then memorized while you perform your changes pans zooms annotations layers selections
138. ernationalization Translation handling in CartoWeb now uses gettext http ww w gnu org software gettext manual However internationalization architecture is ready for other About Outline Apropos Dessin translation systems Ta make life easier for translators scripts that gather the strings to be translated in the templates and in the configuration files are available 2 9 Access Rights Cartographic Functionalities Access to different elements of CartoWeb can be allowed or denied according to who is currently using the application Both functionalities and data may have access restrictions For instance PDF printing may be totally unavailable for anonymous access limited low resolution for normal user and totally granted high resolution for superusers Similarly high resolution aerial views may only be visible within an organization while external users should be content with satellite photographs A basic file based authentication mechanism is included but any other mechanism that 1s able to authenticate an user and to link him to a role could be used as well 2 10 PDF Output and Other Export Formats CartoWeb is able to output a fully configurable PDF document Some options can be chosen by the end user in the following dialog while the CartoWeb admin defines which elements maps legends tables additional logos or watermarks are to be printed and sets their positions within the page Cartographic Functio
139. ers colunms titles formatting allowedRoles comma separated list of strings list of roles allowed to draw the current block il8n boolean if true block content is translated using CartoWeb Gettext system 118n stands for InternationalizatioN Translated contents may be standard texts or even URLs useful for instance to display a logo adapted to the used language Some additional block properties are available but are automatically set depending on 88 PDF Export other parameter values and thus are not listed above private access PHP built in default values type NULL content empty string e fontFamily times e fontSize 12 e fontltalic false e fontBold false e fontUnderline false color black e backgroundColor white e borderWidth 1 e borderColor black e borderStyle solid e padding 0 e horizontalMargin 0 e verticalMargin 0 e horizontalBasis left e verticalBasis top e hCentered false e vCentered false e textAlign center e verticalAlign center orientation horizontal e ZIndex 1 e weight 50 e inNewPage false e inLastPages false width NULL height NULL e multiPage false e parent false e inFlow true caption empty string e headers empty string 89 PDF Export e allowedRoles all e l n false 12 2 4 Colors definition Colors definitions in exportPdf ini configuration file are done using hexadecimal
140. eryableLayer will be taken into account To do so you should extend replace the toolTips plugin See Section 2 3 3 Extending a Plugin You can name it PrzojectToolTips for example So create a ClientProjectToolTips php file containing something like require once CustomLayers php Client part of ClientToolTips plugin package Plugins m class ClientProjectToolTips extends ClientToolTips see PluginManager replacePlugin SS public function replacePlugin metuit o cS SET Then create a new PHP file in the same directory named CustomLayers php Important The name of the class that extends ByXyQueryableLayer Or ByIdQueryableLayer should match the layerld It should look like class DepQueryableLayer extends ByXyQueryableLayer pub function comstrsot f parent NC OD T this addReturnedAttribute nom cht l x Sets the type of ResultLayer returned by ResultLayer queryLayer see QueryableLayer newLayerResult n protected function newLayerResult return new DepLayerResult class DepLayerResult extends LayerResult 137 ToolTips see LayerResult renderResult a public function renderResult smarty smarty assign layerId Sthis gt getId smarty assign layerLabel Encoder encode this getLabel config smarty assign depName this getAttribute nom dept smarty assign depCode this ge
141. est lt all gt lt element name className type xsd string gt lt element lt element lt element lt element lt element lt element lt all gt name shape type types Shape gt name queryAllLayers type xsd boolean gt name defaultMaskMode type xsd boolean gt name defaultHilight type xsd boolean gt name defaultTableFlags type types TableFlags gt name querySelections type types ArrayOfQuerySelection gt lt complexType gt e className QueryRequest or extended class name if project implements an extension 160 Calling Plugins shape type of query object dependant It can be a bounding box a polygon a circle or a point see Section 1 1 2 Shapes for a description of differents types e queryAllLayers if true will execute query on all selected layers ie layers sent through Layers request see Section 1 3 3 1 Layers Request Unused when bounding box is not specified e defaultMaskMode mask mode for new layers returned by query and but not yet in array querySelections Unused when queryAllLayers false e defaultHilight highlight for new layers returned by query and but not yet in array querySelections Unused when query AllLayers false e defaultTableFlags table flags for new layers returned by query and but not yet in array querySelections see Section 1 1 3 Tables for a description of type TableFlags Unused when queryAllLayers f
142. ex2 index3 index4 Switch 1 switches switch2 label Switch 2 switches switchl label layers layerl className LayerGroup layers layerl children switchl layer2 myAutoLayer indexl layers layerl children default layer2 myAutoLayer index2 layers layer2 className LayerGroup layers layer2 children myAutoLayer index4 57 Layers e auto mapId all map contains all layers used in 1ayers ini ie layers myAutoLayer indexl myAutoLayer index2 and myAutoLayer index4 e auto maplId switchl map contains layers used when Switch 1 is selected ie layers myAutoLayer index1 and myAutoLayer_index4 e auto maplId switch2 map contains layers used when Switch 2 is selected ie layers myAutoLayer index2 and myAutoLayer index4 e auto mapId default map contains layers used when no switch is selected ie layers myAutoLayer_index2 and myAutoLayer index4 6 7 Layer Reorder Plugin Ability to reorder displayed layers could be appreciated by end user And so even if your map is well designed with largest features layers on bottom and smallest on top and or even with well used transparent properties The plugin layerReorder is designed to do so Layers could be reorder on the displayed stack to improve visibility of one layer Each layer defined in the mapfile and currently selected in legend menu and only them will be displayed in the reorder menu list 6 7 1 Plugin activation To activate the plugin add it
143. f file advices you to edit your exportPdf ini file So move exportPdf ini from sampleFiles to client conf Take care that this is a client side configuration file Try a new print no need to reset For more information on how to edit your exportPdf ini file see Chapter 12 PDF Export C 9 Templating and Layout Create a new templates folder in your project directory and move the cartoclient tpl file from sampleFiles to this new folder This file is the main template for CartoWeb Refresh the application in your browser refresh button and enjoy To customize your project even more you may apply styles sheets To do so first create a ht docs folder in your project directory In this folder create a new folder named css Then move cartoweb css and folders css from sampleFiles to this new folder At this step you need to launch the setup script so that the new ressources you just created are copied or linked depending on your OS in a web reachable folder You can now refresh the browser and see the new colors and styles 241 DocBook Documentation Generation Appendix D DocBook Documentation Generation CartoWeb documentation source are in DocBook XML format and located in documentation user manual source in CartoWeb archive You may want to generate it by yourself in order to produce XHTML or PDF output D 1 Documentation Generation on UNIX like System D 1 1 Tiny DocBook Install Uncompress the tiny docbook
144. f the current map outline in the overview Default red general showRefMarks boolean if true reference marks are added to the exported main map They are never displayed on the overview general pdfEngine CwFpdflPdfLibLite name of the PDF engine to use For now only FPDF is available and must be called using CwFpdf pdfEngine value A PDFLib Lite version is very partially implemented and as a result should not be used for now pdfEngine value PdfLibLite general pdfVersion string PDF version that must be used only available with PdfLibLite pdfEngine general output inlinelattachmentllinklredirection indicates how generated PDF file must be output default redirection inline file is generated and displayed on the fly might not work with buggy IE attachment generated on the fly but a dialog box asks the user weither the file must be opened or saved link PDF file is actually written on the server and a link pointing towards it is displayed redirection PDF file is written on the server and than user s browser is automatically redirected towards it general filename string indicates how generated PDF files must be named It is possible to specify a date formatting using PHP date format see http php net date Default is map date dMY His pdf which gives for instance map 03Jan2005 193256 pdf 84 PDF Export e general distUnit mmlcmlptlin unit used to measure blocks distance properties Onl
145. fied frozen if true layer is displayed in tree but attribute selected cannot be modified selected if true layer is displayed as selected in tree e unfolded if true layer tree is displayed unfolded layer groups lt complexType name ArrayOfLayerState lt complexContent gt restriction base encll Array attribute ref encll arrayType wsdl arrayType types LayerState restriction complexContent lt complexType gt array list of layer states lt complexType name InitialLocation gt eu element name bbox type types Bbox all lt complexType gt e bbox initial bounding box see Section 1 1 2 Shapes for a description of type Bbox lt complexType name InitialMapState gt 145 Calling Plugins all element name id type xsd string gt lt element name location type types InitialLocation lt element name layers type types ArrayOfLayerState gt lt all1 gt lt complexType gt e id initial state ID e location initial location e layers list of layer states lt complexType name ArrayOfInitialMapState gt lt complexContent gt restriction base encll Array attribute ref encll arrayType wsdl arrayType types InitialMapState lt restriction gt lt complexContent gt lt complexType gt array list of initial states lt complexType name MapInfo elt lt element name timestamp type xsd
146. following encoder classes are implemented e EncoderISo handles strings coded in ISO 8859 1 e EncoderUTF handles strings coded in UTF 8 120 Templating 17 Templating 17 1 Introduction Smarty Template Engine is a convenient way to write HTML templates for dynamic pages It enables to delocalize a great amount of layout processing Thus it is pretty easy to customize a CartoWeb application layout without affecting the application core CartoWeb templates are located in templates root directory and in plugins templates directories see Section 2 3 Plugins More info about Smarty templates can be found here http smarty php net A comprehensive online documentation including a reference and examples is available in various languages here http smarty php net docs php 17 2 Internationalization It is possible and recommended to use the SmartyGettext http smarty incutio com page SmartyGettext tool in order to translate template embedded textual strings Texts to be translated are identified using the t tag lt p gt t Default text please translate me t lt p gt lt p gt t name John Doe Hello my name is 1 t lt p gt lt p gt t l one 2 two 3 three The 1st parameter is 1 the 2nd is 2 and the 3nd 3 t lt p gt It is also possible to use the Itr smarty modifier if you want to apply some Smarty transformations on a translated string assign var label value Themes
147. from the ini if SecurityManager getInstance hasRole roles continue skips unauthorized resolution for this user do the work with the format in the routine handling the user passed parameters to the same check as above 199 Internationalization 5 Internationalization 5 1 Translations Texts to be translated can be found in e Smarty templates see Section 17 2 Internationalization Client and server ini files and map files see Chapter 4 Configuration Files e Client and server PHP code In the last case the script which finds strings to be translated see Section 16 1 2 PO Templates looks for calls to gc functions There are two different gc functions e 118n gt tries to translate the string given as argument and returns the translation This function assumes that string is UTF 8 encoded and returns a string ready for output see Section 5 2 Character Set Encoding It can be used on client side only e I18nNoop gt does nothing during runtime noop stands for no operations Call to this function is only needed to indicates that the string must be translated This function can be used on client and server side Below is an example on how to use I18nNoop gt Example for use of I18n gt functions client side is class ClientMyPlugin extends ClientPlugin implements GuiProvider ServerCaller public function initializeResult myPluginResult
148. g METHOD allows the same line to be used independently of the method where it is located 2 Onthe Logger object several methods can be used to log messages debug info warn error fatal They take a string as argument which is the message to log Example 221 Logging and Debugging this log debug My Message Inside objects Slog gt warn My Message Outside objects 9 3 Debugging Debugging is a large topic Everyone has its preference over the tool to be used like using an integrated debugging tool inside an IDE using print statements code printing and reading Because of this this section does not tells what tools to use but rather gives some tips when debugging 9 3 1 Understanding Exceptions and Stack Traces When a failure is encountered in CartoWeb the Php5 mechanism for exceptions handling is used to manage exception and display stack traces People knowing the Java language will be familiar with such stack traces The following example shows such a stack trace display It is easily understood as the list of functions called and the line numbers where the call happened Failure class SoapFault message Error 8 Undefined property ServerMapquery S currentQeury var www cartoweb3 coreplugins mapquery server ServerMapquery php 222 Backtrace file 182 var www cartoweb3 common Common php call Common cartowebErrorHandler file 222 var www cartoweb3 co
149. g Sessionable interface may be saved in views Because CartoWeb and its plugins evolve views might become outdated after some time Plugin session containers may change properties may be added removed renamed etc and thus shifts between old views and new plugin session formats appear Those shifts then prevent some views from correctly displaying or even make CartoWeb crash However CartoWeb offers upgrade tools to read outdated views 11 2 Upgrade Tools 11 2 1 Views Versions Plugins session data are saved in views in separated XML elements Each element records the plugin session container version Plugin session container version must be incremented whenever a change is applied on the container format new property name change etc Container version if not specified defaults to 1 To explicitely update it add following constant definition before container declaration define PLUGINNAME SESSION VERSION 3 where PLUGINNAME is the uppercased plugin name Container versions are always integers 11 2 2 Upgrade Filters Upgrading a view is done by sequentially applying filters each one updating it to the following version from version N to version N 1 If matching sequence cannot be detected missing filters upgrade is aborted and outdated data is discarded Current plugin data is then used instead Upgrade filters are PHP classes extending viewUpgrader the latter class being defined at the end of c1ient Views php
150. guration Client side configuration allow to specify which algorithms should be display within the user interface Currently there are 2 algoriths families that may be configured The first is about classification algorithms The second is about generation of color ramp The signification of the parameter is pretty straightforward The choroplethDataFromCurrentBoundingBox parameter allows to choose whether classes should change when users zoom or if they should remain constant for every scales The following classification method are currently supported F Custom lt 0 R Equal intervals 1 B puer Uer 2 e Modes 3 choroplethClassifMethodDefault 2 choroplethClassifMethodsList 0 2 3 The following color ramp generation method are currently supported 5 Custom RGB interpolation 1 S HSV interpolation lt 2 Max diffrence 3 choroplethColorRampMethodDefault 1 choroplethColorRampMethodList 1 3 choroplethDataFromCurrentBoundingBox false 132 ToolTips 23 ToolTips 23 1 Introduction The tooltips plugin aim is to show features attributive information on top of the map without refreshing the whole page This can be achieved using three different methods The choice must be done regarding advantages or disadvantages of each method 23 2 Basic Usage 23 2 1 Mouse Timeout Asynchronous 23 2 1 1 Introduction When user moves the mouse over the map and stops during several milliseconds an AJAX request
151. h 12 3 4 1 Block Template and Overriding 93 PDF Export Since all blocks descriptions are based on the same PdfBlock object a template block has been defined to factorize blocks common configuration for instance font family background color borders padding etc It is also a way to specify default blocks parameters values It is then possible to personalize blocks by overriding those properties within the block own description Blocks configuration overriding can be schemed as follows PHP PdfBlock hard coded gt gt gt block template user configured gt gt gt final block user configured Note that it is not necessary to redefine properties in blocks or in their template if their current values defined in parent structures are already OK For instance blocks default settings template type text template fontFamily times template fontSize 12 template fontItalic false template fontBold false template color black template backgroundColor white template borderWidth 0 25 black solid template borderColor template borderStyle template padding 3 template horizontalMargin 0 template verticalMargin 0 template horizontalBasis left template verticalBasis top template hCentered false template zIndex template textAlign center template verticalAlign center template orientation horizontal 12 3 4 2 Blocks Positioning CartoWeb uses a CSS like syntax for
152. handlePreLoading SCH public function handlePreLoading data viewId Your customized code 229 AJAX Implementation 12 AJAX Implementation 12 1 Introduction CartoWeb implements an AJAX layer enabling asynchronous update of the HTML GUI 12 2 AJAX Implementation Outline The implementation of AJAX in CartoWeb is achieved by extending the Cartoclient and creating a lightweight Javascript engine It introduces a few new concepts e Synchronous and asynchronous modes e Ajaxable interface Plugins Javascript side Plugins actions Plugins enablement level Client web cartoclient cartoserver Plugin 1 ajax 1 Plugin 2 non ajax Plugin n ajax messages 12 2 1 Synchronous And Asynchronous Modes In addition to the implicit synchronous mode traditional until now Cartoclient execution flow an asynchronous mode has been implemented to process AJAX calls e The synchronous mode is the default Cartoclient execution flow that processes each plugin s logic and renders a monolithic HTML page Non AJAX projects will run the synchronous mode without any alteration The asynchronous mode is the execution flow specifically built to process AJAX calls In this mode a subset of the plugins features is processed and an XML 230 AJAX Implementation document containing plugins output is rendered to be processed by the Javascript part 12 2 2 Ajaxable Interface Client plugins ca
153. hat padding space between border and content is taken into account only in the horizontal direction for text blocks To remove a block border one can simply set its width borderwidth to 0 Note that some border styling parameters are not available with all pdfEngines For instance blocks title zIndex 2 blocks title weight 10 blocks title verticalBasis top blocks title verticalMargin 15 blocks title hCentered true blocks title fontSize 20 blocks title fontItalic true blocks title fontBold true blocks title fontUnderline true blocks title backgroundColor eeeeee e blocks title height 15 It is possible to specify a text content in the configuration file by using the content parameter Note that n strings in the content value will result in line feeds in the final block blocks myText content This is myText block content blocks myText2 content myText2 block nis multilined Text blocks content may also be retrieved from external data source such as text files or databases using following syntaxes Connection parts are separated by a First part indicates what medium i1eladb is used e file file source blocks myText content file my source file path The source file path can either be a absolute URL or a filesystem path Relative filesystem paths are allowed and are based on the CartoWeb root path For instance blocks myText content file http myserver mysourcefile
154. he application You can run this file with the ne1p parameter to see the available options For instance lt PHP INTERPRETER gt cw3setup php help where PHP INTERPRETER is the location of your php interpreter On Windows it can be c wamp php php exe or on Unix usr lib cgi bin php 1 1 3 1 List of Available Options Usage cw3setup php ACTION OPTION 1 OPTION N Possible actions Shel or cum Display this help and exit SUSE LOM mp cv Output version information and exit Sistas Install CartoWeb fetch demo Fetch the demo data from cartoweb org and extract it in the demo project if not already there clean Clean generated files and caches llgne Cie steen debug Turn on output debugging writableowner OWNER The user who should have write permissions for 18 Installation generated files cocus Toot CVS Root directory to use when fetching CartoWeb project out of CVS ccfevcoh from cvs Fetch CartoWeb from CVS and install it in the current directory or in the directory given by the install location parameter NOTE You must be located where cartoweb3 directory will be created not inside like other commands cartoweb cvs option OPTIONS A string which will be given to the cvs checkout command of cartoweb not projects For instance to fetch a specific branch use r MY BRANCH Or for a specific date waa DES AUS EA fetch from dir DIRECTORY Copy CartoWeb from the specified
155. he viewer main map keymap and layers list It is often launched by clicking on a HTML print link or button and opens a new browser window It is specially useful to quickly basic HTML layout same maps used than in viewer display raw maps in order to print them No configuration is required To enable or deactivate this plugin simply add or remove exportHtmlfrom the loadPlugins parameter in client conf client ini For instance ove exportHtml is listed as activated loadPlugins auth outline exportHtml Fa To customized the exported page layout simply edit the plugin template file exportHtml templates export tpl ltis recommended not to modify the regular template file but to override it in a project version of the exportHtm1 plugin For more info about projects see Section 2 4 Projects To get advanced printing capabilities rather use the CartoWeb PDF export plugin exportPdf described in next chapter 11 3 CSV Export The exportcsv plugin enables to export tabular data from various queries results in a comma separated CSV or assimilated text format The returned CSV file can then be opened and edited in any text editor or rendered as a table document in OpenOffice or MS Excel For instance Id Object Description 80 Export Plugins ujn a Line CSV export links are generally displayed in the viewer at the bottom of each queries results tables Each link can only export a single layer table at
156. hen you have used the same msgid in different po files Note Each po file contain a single fuzzy entry at the beginning this should not be removed fuzzy fisci t msgstr EIERE KURS 9t Gettext automatically comments msgid and msgstr that are not found anymore in your templates Commented lines start with Sometimes this is unwelcome simply uncomment the lines If your CartoWeb profile is set to production Section 4 1 Common client ini and server ini Options do not forget to clean the temporary templates files by typing php cw3setup php clean See Section 1 1 3 2 4 Cleaning Generated Files Map PDF Temporary Files and Smarty Cache for more details 119 Internationalization Note It can also be usefull sometimes in development mode 16 2 Character Set Encoding Configuration Character set configuration is needed when CartoWeb strings may include international characters with accents or other special characters Two types of encodings must be set how files map files configuration files etc are encoded on server and on client To set this encoding add the following line in server ini andin client ini EncoderClass config encoder class how CartoWeb exports including HTML output must be encoded To set this encoding add the following line in c1ient ini EncoderClass output encoder class Where encoder class is the class used for encoding Currently
157. hp fetch demo 1 1 3 2 6 Install or Reinstall CartoWeb from CVS and Set Up It at Once 1 1 3 2 6 1 Install lt PHP INTERPRETER gt cw3setup php install cvs root pserver anonymousGdev camptocamp com var lib cvs public fetch from cvs base url http www example com cartoweb Note Do no execute this command from the cart oweb3 folder Because this will fetch the whole cartoweb3 hierarchy from cvs including the cartoweb3 folder If you executed this from the cartoweb3 folder you would end up with something like cartoweb3 cartoweb3 Instead copy the cw3setup php in the parent directory delete or backup the cartoweb3 folder and execute the command 1 1 3 2 6 2 Reinstall lt PHP INTERPRETER gt cw3setup php install cvs root pserver anonymous dev camptocamp com var lib cvs public 20 Installation fetch from cvs delete existing base url http www example com cartoweb Warning This command will automatically delete the existing cartowepb3 folder Be sure to backup the files and projects you wish to keep Note See note on Section 1 1 3 2 6 1 Install Notice here the delete existing parameter Needed here because cart oweb3 already exists Without it the cw3setup script issues a warning and stops 1 1 3 2 7 Update CartoWeb from CVS To keep your CartoWeb up to date with the development version simply type the following command in the cart owep root folder cvs d pser
158. hy of layers and different rendering options The notion of LayerGroup makes it possible 6 2 1 Layers and LayerGroups There are two types of layers like objects in 1ayers ini Layers and LayerGroups They play fairly different roles and consequently have different possible attributes Layers have a 1 to 1 correspondance to Mapserver layers as defined in the layers map while LayerGroups group together atomic Layers or other LayerGroups 6 2 2 Layers Options 49 Layers As seen before the Layer object maps directly to a layer in the mapfile By default all layers in the mapfile are made available as a Layer in the layers ini with an identifier having the same name as the name of the mapserver layer Thus if you have the following option in your mapfile LAYER NAME my layer TYPE line END This is equivalent as writing the following configuration in the 1ayers ini layers my layer class Layer layers my layer label my layer layers my layer msLayer my layer Tip If you don t need special parameters see below for your layer then you can avoid adding it in the 1ayers ini However if you want these layers to appear in the layer list you still have the responsibility to affect them a parent layer using the children property of the LayerGroup layer declarations Here is the syntax for the various configuration parameters of a Layer e Jayers layerld className Layer defines the object as a Layer
159. if needed return type lt description gt method type mandatory description if needed var type description variable type mandatory description if needed link lt class gt l lt method gt anywhere to add a hyperlink to a class or method see class l method anywhere to add a reference to a class or method see is also used for interface implementation Because PhpDocumentor doesn t inherit tags param return etc and because we don t want to copy paste these tags we add a simple see tag to interface method definition See example below 8 2 3 Example Here is a code example Please note simpleVariable doesn t need a description but var tag is mandatory here constructor doesn t need a description getters and setters are too simple to have a description but don t forget the param and return use but not abuse of link and see This can be really useful to navigate through documentation php EE E f EA Test file The purpose of this file is to show an example of how to use PhpDocumentor DocBlocks in CartoWeb package MyPackage author Gustave Dupond lt gustave dupond camptocamp com gt version Id This is a require description require_once required_file php t This is a short description of MyClass MyClass long descrition package MyPackage class MyClass extends
160. ins The simpliest way to obtain a map from CartoWeb server is to send an X Y location and a scale First thing to do is to declare the SOAP client Class SoapClient will need the WSDL code dynamically generated by script cartoserver wsdl php php client new SoapClient http url to server cartoserver wsdl php mapId swiss project swiss The map ID is required also in the request object request mapId swiss project swiss In this example only main map and scale bar are requested So key map s isDrawn attribute is set to false request imagesRequest className ImagesRequest request imagesRequest mainmap isDrawn true request imagesRequest mainmap path request imagesRequest mainmap width 500 request imagesRequest mainmap height 500 request imagesRequest mainmap format request imagesRequest keymap isDrawn false request imagesRequest keymap path request imagesRequest 5keymap width 0 request imagesRequest keymap height 0 request imagesRequest keymap format request imagesRequest scalebar isDrawn true request imagesRequest scalebar path request imagesRequest scalebar width 100 request imagesRequest scalebar height 100 request imagesRequest scalebar format Two layers are displayed Resolution attribute is set to null to keep standard Mapserve
161. ion see Section 1 2 Call to getMapInfo e serverMessages list of messages returned by server 1 3 2 Images The Images plugin generates MapServer images The three types of images are main map key map and scale bar Basic parameters such as image size are defined in this request result More specific parameters such as map location or content are defined in other plugins 1 3 2 1 Images Request lt complexType name Image gt SNP element name isDrawn type xsd boolean element name path type xsd string element name width type xsd int element name height type xsd int all lt complexType gt e isDrawn true if the image should be generated when used in a request or if it was generated when returned in a result e path relative path of generated image Not used in request e width image width e height image height 152 Calling Plugins lt complexType name ImagesRequest all element name className type xsd string element name mainmap type types Image element name keymap type types Image lt element name scalebar type types Image gb lt complexType gt e className ImagesRequest or extended class name if project implements an extension mainmap main map image information e keymap e scalebar key map image information scale bar image information 1 3 2 2 Images Result lt complexType name I
162. ipt with the config from file option php cw3setup php install base url http www example com cartoweb config from file projects demoPlugins demo properties Note Routing fonctionnalities are also integrated in this demo But they need a more advanced configuration and the Pgdijkstra module installed in the database so they aren t integrated in the basic installation The steps to integrate routing fonctionnalities and create database tables are described in next section 1 2 3 Routing specific installation Install the Pgdijkstra PostgreSQL module Note To do so o if you are on Debian you can directly install the Pgdijkstra PostgreSQL extension module To do so you can have a look at Appendix A Mapserver Debian Installation o instead you can download the Pgdijkstra Routing Module file and follow the instructions given in the routing module README file at http www cartoweb org contribs html Execute the dijkstra sql file to install the functions in your database by typing 26 Installation pecil Sd demo glugins r dijkstra sql If you have PostGIS installed you should launch dijkstra postgis sql paql d demo plugins f dijkstta postgis sql Import Europe road geodata in PostGIS create its graph structure and configure plugin routing database To do so simply execute the demo routing sql file located in the CARTOWEB HOME projects demoPlugins server co
163. irectory D 1 5 PDF Generation To generate a pdf version of the documentation execute instead configure make pdf Resulting pdf will be generated in book pdf file Note You need to have at least a JRE or JDK installed on your system in order to generate PDF The environment variable JAVA_HOME must also be rightly set e g export JAVA HOME dir path where jre is put on your system D 2 Documentation Generation on Windows using Cygwin At this time the only known way to generate xhml or pdf version of the documentation on Windows is by using Cygwin You will need to install the following Cygwin packages libxml2 libxslt make Then follow the same instructions as for UNIX like system Section D 1 Documentation Generation on UNIX like System 243 Index Index A Accounting 123 AJAX 129 all 112 anonymous 112 applySecurity 113 areaFactor 74 attributes 134 135 authActive 111 autoClassLegend 54 B bbox initial 63 block positioning PDF 94 Blocks configuration PDF 86 93 bottomLayers 58 C charsetUtf8 CSV 81 collapsibleKeymap 64 Colors PDF 90 Column reorder 191 Coreplugins 173 crosshairSymbol 61 crosshairSymbolColor 62 crosshairSymbolSize 61 CSV export plugin 80 D dbSecurityDsn 111 dbSecurityQueryRoles 112 dbSecurityQueryUser 111 dbTableName 134 135 defaultAttributes 68 defaultHilight 67 defaultMaskmode 67 defaultPolicy
164. is chapter describes how to configure PDF export using client conf exportPdf ini parameters First part Section 12 2 Configuration Reference is a comprehensive reference of user available configuration parameters Second part Section 12 3 Tutorial is intended to be a small tutorial giving explanations and examples about how to configure the PDF exportation tool 12 2 Configuration Reference 12 2 1 General Configuration Parameters are named using a lt object gt lt property gt convention These parameters are grouped within dedicated objects that deal with separated aspects of the export For instance general horizontalMargin 10 general verticalMargin 10 formats A4 label A4 formats A4 bigDimension 297 Some objects handle the general description of the PDF document as well as user form generation general and formats Other objects are blocks typed They deal with block presentation color size content etc and positioning Blocks are basic entities of the PDF document text images For instance overview mainmap scalebar title are described with block objects To factorize blocks description it is possible to describe a template block object that defines the default configuration of blocks Those default settings are then overriden by each block specific description e general guiMode string type of GUI used Must be either classic default or rotate rotate mode adds the pos
165. istrator to avoid that the log file eats all the available free disk space It exists several tools which can be used to manage the log files and to avoid it takes too much place For instance the Logrotate software can be used to rotate the log files regularly Warning Activating accounting and not taking care of log file management can slow down or interrupt CartoWeb good working if the log file becomes too large 124 Locate Plugin 19 Locate Plugin 19 1 Introduction The locate plugin deals with autocompletion of input fields used to recenter on a feature on the map It is based on AJAX requests When a few characters have been typed in the dedicated input field an AJAX request is processed on the database defined by its DSN The first results beginning with these characters are displayed in a drop down list When a result is clicked the map is recentered on it The JavaScript part of this plugin is based on the script aculo us http script aculo us Autocompleter 19 2 Activation The plugin needs obviously to be activated using the client conf client ini loadPlugins parameter For instance loadPlugins auth exportPdf views locate To enable the plugin you also need to add required parts in the cartoclient tpl template In the head element if S locate_active default lt link rel stylesheet type text css href r type css plugin locate loca if S locate_active default lt script
166. it edit geometry column string name of the geometry field in the table edit geometry type string type of the geometry of the features for the layer possible values are point line polygon 107 Editing May differ from the msLayer type rendering edit srid integer optional id of the SRID edit attributes string comma separated list of attributes used for edition Each value represents the attribute name and type separated by a pipe symbol Only attributes with type set are editable Attribute types available values are string and integer 14 3 How To In this section are described the steps to get the edit plugin working on a cartoweb project First you need a PostgreSQL database with postGIS enabled Let s say it is named edit db for the following explanations e At that point you may launch demoEdit schema sql and demoEdit data sql located in the CARTOWEB HOME projects demoEdit directory This will create 3 sample geometry tables one for each type of geometry In CartoWeb you ll have to load the edit plugin in your project on both client and server sides loadPlugins edit Then you ll need to configure the plugin by setting the layer ids in the editLayers parameter in the edit ini file editLayers edit poly edit line edit point n your mapfile in the corresponding LAYER you ll have to set the specific metadatas as following LAYER NAME edit poly
167. ize is used defined by the two following parameters e mapWidth mainmap width in pixels if mapSizesActive false e mapHeight mainmap height in pixels if mapSizesActive false e mapSizes width 0 1 2 available mainmap width in pixels for mapsize when mapSizesActive true e mapSizes height 0 1 2 available mainmap height in pixels for mapsize when mapSizesActive true e mapSizes label 0 1 2 label that describes mapsize appears in drop down list If not specified a lt width gt x lt height gt pattern is used as the label e mapSizesDefault integer indicates the default mapsize to be used among the above Only when mapSizesActive true If no mapsize settings are found the default mapsize is 400x200 pixels 8 1 2 Keymap and Scalebar Options The plugin images can also deal with few keymap and scalebar options e collapsibleKeymap if true keymap is shown on map and possibly hidden e noDrawKeymap if true keymap will not be drawn at all e noDrawScalebar if true scalebar will not be drawn 8 2 Server side Configuration Here are the options that can be set e maxMapWidth maximum allowed width in pixels of the generated mainmap If 64 Image Format Options the value requested by the client is greater maxMapWidth takes precedence over it e maxMapHeight maximum allowed height in pixels of the generated mainmap If the value requested by the client is greater max
168. l sets called plugins that aim to be independent from each other although some dependencies cannot be totally avoided Some plugins core plugins cannot be disabled while the other ones must be explicitly loaded in the server and or client configuration files 34 Structure Nearly all plugins have configuration options set in ini files The full description of these options makes the bulk of this user manual Modifying existing plugins or writing new ones requires some acquaintance with PHPS as it involves some coding The related documentation is thus reported to the developer s part of this manual see Section 2 1 What are Plugins but that shouldn t deter anybody from experimenting with it Each plugin directory contains one or more subdirectories Here are all the possible subdirectories client Client side plugin code e common Client and server code htdocs Web accessible directory e server Server side plugin code templates Smarty templates 2 4 Projects The aim of projects in CartoWeb is to clearly separate mainstream files from project specific files Developers should thus only work in projects and not modify add delete files in the root directory This will ensure smooth updates The directory projects my project has exactly the same structure as the root directory shown above Section 2 2 Global Directory Structure Files added in directory projects override corresponding files
169. l Role Names geesde eoe teet Red 112 15 3 Global CartoWeb Permissions eee 112 15 4 Plugin Specific Permissions eere 113 15 4 1 Layers Related Permissions ees 113 15 4 2 PDF Printing Permissions eene 114 I6 Internatio ali ation EE 115 IN Translations E 115 16 1 1 Config ration EE 115 6 1 2 PO Templates 5 ui eni Itiner eSI IO a 116 16 1 5 Translating as EE 117 16 1 4 Compiling PO to MO eene 117 T6352 Example EE EEN 117 16 1 6 Debuging translation problems 118 16 2 Character Set Encoding Configuration 120 17 Sibi 121 171 Introduction EE 121 17 2 Internationalization usen teer ec I Hte Pete aerae ceases 121 L4 5 EE 121 L Accounting S 123 18 1 Accounting Configuration EE 123 EA WR Weu Te EE 123 18 1 2 client ini or Server EE 123 18 2 Managing Accounting Information eese 124 18 2 1 Accounting Log Files Administration 124 19 Eocate Pl gin 3 it OI e ea El a E TU Tei ease 125 19 1 IntEOGUC DOT siese vedete UNI ERE SO INNO PY Mae ieu d ed au EU ed 125 19 2 ACUVALOD itr iS Pei ed e Edge deele E 125 PDS Config ration xoc utei do Rho ditus pfe dst s Cis ONE REA 125 20 WMS Browser isi RU NEE OU UI ig nese 127 20 T Introductlon EE 127 20 2 Installing Chameleon XML Parser eene
170. l suffix used to distinguish CartoClient sessions parts for a given user In most cases it is not necessary but may be needed when using for instance sub projects This string is an ulimited comma separated list of t ype value couples Three types are available o str a constant string o conf uses value of one of the current client ini configuration parameters o env uses value of given PHP environment variable if set For instance sessionNameSuffix estrrtotvo conti profile envsmybnvVar sessionNameSuffix Here OO Site 9 ere env CW3 APP ID sessionNameSuffix Tools configuration e initialTool indicates which tool is activated when in initial state If not specified the first tool in the toolbar is activated Possible values are zoomin zoomout pan query distance surface e toolbarRendering indicates how to render tools selectors icons within toolbar Possible values are radio default outline swap If radio an HTML radio 40 Configuration Files button appear nexts to each tool icon If outline active tool icon is outlined with a colored border If swap an alternate icon over is displayed to mark the active tool Project handling configuration e showProjectChooser truelfalse Shows a drop down list for selecting the active project e availableProjects list List of the project to show in the drop down list If not set all projects found will be used Plugins config
171. l wel ies eragoen wool aote Lus Leger wool_vwwicjouie_ Jee tool_id_list You can initialize one or more tools at once The tool_id_list parameter is composed of one or more numerical values separated by comma and enclosed by quotes or simplequotes Example 2 or 1 4 or 3 2 1 The order of the id influes on the order of the tool panels when displayed on screen tool input list and tool output list The script needs an input value and will return an output value The input value is retrieved from an html input element In the same way the output value is returned to an html input element The script needs as many input element id as initialised tools If two tools are initialised parameter tool id list tool input list must also contain two input id Ids are separated by comma and enclosed by quotes or simplequotes Example return id tool 4 return id tool 2 The first input id corresponds to the first tool id in tool id list A different id can be specified if the element storing the output value must be different from the element storing the input value The same rule applies to tool input list and tool output list See Section 10 4 5 Examples of Usage Each tool also have some particularities 10 4 3 1 ColorPicker When a color is selected the script will set the css property background color of a div in the template accordingly to the color picked The id of the div is based on the output element id if i
172. layerld is a string that uniquely identifies the object The general rules of syntax for a ini file must be respected in the choice of the layerld e g no are allowed e layers layerld msLayer string name of the corresponding Mapserver layer in the mapfile e layers layerld label string caption of the layer in the layer tree on the client this is a raw label before any internationalization The i18n scripts automatically include this label in the strings that can be translated e layers layerld icon filename filename of the static picto that illustrates this Layer in the layer tree The file is expected to be in server_conf lt mapId gt icons and a setup script launch is in most cases required See also Section 6 4 Layers Legends for a description of the automatic legending process e Jayers layerld link url provides a link for the layer e g to some metadata makes the caption in the tree clickable 6 2 3 LayerGroups Options 50 Layers Here is the syntax for the various configuration parameters of LayerGroups Note that a special LayerGroup with layerld root must be present Unsurprisingly it is the root top level of the hierarchy It doesn t appear in the visible tree e Jayers layerld className LayerGroup defines the object as a LayerGroup layerld is a string that uniquely identifies the object The general rules of syntax for a ini file must be respected in the choice of the layerld e g no
173. le php ini in any text editor and go to the Dynamic Extensions section Activate the SOAP Curl and Gettext extensions Simply remove the at the beginning of the lines 234 Apache amp Mapserver Windows Manual Installation If you can not see the extension in the list you will need to add it manually extension php soap dll extension php curl dll extension php gettext dll The corresponding DLL files must be present in the extensions folder of PHP It should be c wamp php ext by default If you can not find it look in the PHPINFO local value for parameter extension dir visible in php ini as well you will notice something like C wamp php ext e Restart Apache left click on the WAMP icon in the systray gt Apache gt Restart Service e Check in the PHPINFO if the new extensions loaded correctly look for a section with their name B 2 Mapserver Mapscript Install You need a Mapscript version compiled for PHP5 Win32 You can get one here http www maptools org dl mapserver 4 5 win32 php5 0 3 zip If the link doesn t work go to http dl maptools org dl and look for mapserver 4 5 win32 php5 0 3 zip or newer Note MapServer for Windows PHP5 archives are also available on CartoWeb website at http cartoweb org downloads html msw Additional instructions for installing DLL s are given in the matching README txt files Once you have downloaded the archive uncompress it in any directory The REA
174. ll be added after the last added WMS layer or after this mapfile layer if no WMS layer has ever been added To do so in server conf mapId wmsBrowser ini specify the mapfile layer name in the wnsInsertLayerAfter parameter 6 8 4 Perform added WMS layers appearance in the layers list If you want to perform added WMS layers appearance in the layers list you still have to affect them a parent LayerGroup Specify in client conf layers ini the LayerGroup name in the userLayerGroup parameter default is root 60 Navigation 7 Navigation The plugin location is the core plugin that deals with geographic navigation on the map It handles bboxes visible areas and scales it drives the tools zoom in zoom out and panning the directional arrows around the main map and the overview map The corresponding configuration files are 1ocation ini client side and location ini server side 7 1 Client side Configuration Here are the options that can be set e scalesActive boolean if true the scales dropdown list is displayed default false If no visible scales are defined on the server a simple input text will be displayed e recenterActive boolean if true the coords recentering form is displayed default false e idRecenterActive boolean if true the id recentering fields will be displayed default false e idRecenterLayers the comma separated list of layers which will appear in the id recentering selection f
175. lugin this serverContext getPluginManager tables readyForClientTableGroups StablesPlugin gt applyRules newTableGroup 193 Dynamic mapfile modifications 3 Dynamic mapfile modifications 3 1 Introduction This chapter describes the mapOverlay plugin This plugin allows dynamic modifications of the mapfile it can be used for example to let the user add a WMS layer restrict data to be exported to the user change the color of layers etc The plugin has only a server part and only a public method public function updateMap BasicOverlay Soverlay The Soverlay argument is either a MapOverlay Or a LayerOverlay instance it represent respectively a mapfile or a layer Customizable elements are e ColorOverlay e StyleOverlay LabelOverlay e ClassOverlay e MetadataOverlay e LayerOverlay e MapOverlay The organization of these elements are the same as the mapfile structure a MapOverlay contains zero or many LayerOverlay Who cantains zero or many MetadataOverlay etc None of theses elements or instance variables are mandatory you just need to provide informations about property you want to search update insert or delete For each of theses mapfile elements the developer have to provide an action by setting the action instance variable The action set the behavior of the element during the mapfile update process action is one of e BasicOverlay ACTION_SEARCH this action search or create the ele
176. magesResult gt lt all gt lt element name className type xsd string gt lt element name mainmap type types Image element name keymap type types Image element name scalebar type types Image all lt complexType gt e className ImagesResult or extended class name if project implements an extension e mainmap main map image information see Section 1 3 2 1 Images Request for a description of type Image e keymap key map image information e scalebar scale bar image information 1 3 3 Layers The Layers plugin handles layers selection Its request object includes list of layers to be displayed on main map This plugin has no specific result object 1 3 3 1 Layers Request complexType all element element element element name LayersRequest gt name className type xsd string gt name layerIds type types ArrayOfLayerId name resolution type xsd int name switchId type xsd string gt 153 Calling Plugins all lt complexType gt e className LayersRequest or extended class name if project implements an extension e Jayerlds list of layers to include in map generation see Section 1 1 1 Simple Types for a description of type ArrayOfLayerld resolution MapServer resolution Set this to null if you want to use default resolution e switchld current switch ID 1 3 3 2 Layers Result lt complexT
177. mee Se Regular plugins including how to configure them are precisely described in Part II User Manual For more information about how to write or customize plugins see Chapter 2 New Plugins 3 4 2 Projects 13 Architecture Projects are used to separate the upstream application from its customizations They contains all the modifications and adaptations you could have performed to make CartoWeb suit your needs layout templates pictos special configurations personal plugins etc By using projects you can e keep the general application clean from tricky modifications that would compromise the future upgrades e gather your project files to easily save and copy them to another CartoWeb instance For example when copying them from your test server to your production one run different projects on the same CartoWeb instance For more information about projects see Chapter 3 Projects Handling 3 5 Templates CartoWeb layout customization is achieved using the well known and powerful Smarty http smarty php net template engine For more information about templating see Chapter 17 Templating 3 6 Users and Roles CartoWeb enables to define and manage different levels of permissions Thus it is possible to restrict some or all functionalities to some users or categories of users For more information about users and roles see Chapter 15 Security Configuration 3 7 Performance Enhancement CartoWeb t
178. ment BasicOverlay ACTION_INSERT insert the element at a given position or at the end if not specified e BasicOverlay ACTION REMOVE remove the element BasicOverlay ACTION UPDATE update or create the element If no action is specified the default action is BasicOverlay ACTION UPDATE 194 Dynamic mapfile modifications The standards steps to use this mechanism are Create all the needed elements and combine them together in a Mapoverlay ora LayerOverlay Instance 2 Call the updateMap function The function returns a MapOverlay instance If needed use the result instance to retrieve an index or a element name Note that the modification are not saved in the project s mapfile the result of the mapfile modifications are specific to a session 3 2 Plugin usage This chapter contains some basic examples of the plugin usage All the code listed here must be placed in the server part of a plugin 3 2 1 Class creation Consider this code excerpt color new ColorOverlay Seolor sred 255 color green 0 Scolor gt blue 0 Sstyle new StyleOverlay Sstyle gt index 0 style scolor 560lor 1abel new LabelOverlay Slabel gt outlineColor color Sclass new ClassOverlay class action BasicOverlay ACTION INSERT class name foobar class 5styles array style class label 1abel A ColorOverlay and a StyleOverl
179. n now implement an interface called Ajaxable that enables a plugin to handle an asynchronous request and render XML See CartoWeb 3 3 API documentation interface Ajaxable http www CartoWeb org doc cw3 3 apidoc Client Ajaxable html 12 2 3 Plugins Javascript Side Each Ajaxable plugin is made of a Javascript part that handles HTTP POST GET parameters generation for AJAX requests e GUI refresh logic processing of the plugin XML response and DOM injection manipulation 12 2 4 Plugins Actions AJAX introduces the concept of actions An action is provided by a plugin and is used to define From the Javascript side what are the HTTP parameters GET amp POST to be sent to the Cartoclient From the Caroclient side what subset of each plugin s logic is to be processed In example the Location coreplugin provides the following actions e Location Pan e Location Zoom e Location FullExtent e Location Recenter 12 2 5 Plugins Enablement Level When the Cartoclient s asynchronous mode is triggered the action is used to determine what subset of each plugin s logic should be processed Processing a subset of a plugin s logic is achieved by changing it s enablement level Enablement levels are by default set to Full i e the whole logic is processed 231 AJAX Implementation Here are the yet available enablement levels Load The plugin is loaded e Process The plugin is loaded and handles GET POST Req
180. nType type of location e bboxLocationRequest bounding box request parameters see Section 1 3 5 1 1 BBox Request e panLocationRequest panning request parameters see Section 1 3 5 1 2 Pan Request e zoomPointLocationRequest zoom recenter on point parameters see Section 1 3 5 1 3 Zoom Point Request e recenterLocationRequest recenter on IDs parameters see Section 1 3 5 1 4 Recenter Request e locationConstraint constraint to be respected when location request is executed 1 8 5 1 1 BBox Request lt complexType name BboxLocationRequest gt ul JL element name bbox type types Bbox all lt complexType gt e bbox bounding box to be recentered on see Section 1 1 2 Shapes for a description of type Bbox 1 3 5 1 2 Pan Request lt simpleType name PanDirectionType gt lt restriction base xsd string gt lt enumeration value VERTICAL_PAN_NORTH gt lt enumeration value VERTICAL_PAN_NONE gt lt enumeration value VERTICAL_PAN_SOUTH gt lt enumeration value HORIZONTAL_PAN_WEST gt lt enumeration value HORIZONTAL PAN NONE enumeration value HORIZONTAL PAN EAST lt restriction gt lt simpleType gt VERTICAL_PAN_NORTH panning north VERTICAL_PAN_NONE no vertical panning VERTICAL_PAN_SOUTH panning south HORIZONTAL_PAN_WEST panning west HORIZONTAL_PAN_NONE no horizontal panning 156 Calling Plugins e HORIZONTAL PAN EAST pa
181. nalities Themes Print Search Format and Resolution dpi Orientation e Portrait C Landscape Title Note Options Iv Scalebar BR Oye nd em m Quen Results J Legend E On map c In new page e Mane Frim Other output formats include the graphic formats jpeg png of the map itself simplified html templates and comma separated values tables of the query results Architecture 3 Architecture 3 1 Introduction CartoWeb uses an innovative design and state of the art technologies The following sections briefly review the main employed approaches 3 2 MapServer MapScript CartoWeb is based on the UMN MapServer http mapserver gis umn edu engine Interactions between CartoWeb and MapServer are achieved using the MapServer PHP Mapscript http mapserver gis umn edu doc44 phpmapscript class guide html module MapServer must be installed prior to any CartoWeb setup MapServer resources e MapServer HomePage http mapserver gis umn edu e MapServer Download http mapserver gis umn edu dload html e MapServer Documentation http mapserver gis umn edu doc html e MapServer PHP Mapscript Class Reference http mapserver gis umn edu doc44 phpmapscript class guide html 3 3 Web Service Architecture SOAP One of the CartoWeb specificities is its ability to work along a client server model as well as a stand alone application Thus it is possible to host a
182. nd opening parenthesis It is also recommended to use curly braces even when they are optional This is correct if condition 6 3 1 3 Function Calls Functions should be called with no spaces between the function name the opening parenthesis and the first parameter spaces between commas and each parameter and no space between the last parameter the closing parenthesis and the semicolon This is correct Svar foo Sbar Sbaz Squux 204 Code Convention 6 3 1 4 Function Definitions Function declarations follow the one true brace convention Arguments with default values go at the end of the argument list Always attempt to return a meaningful value from a function if one is appropriate 6 3 1 5 Class Modifiers Modifiers keywords public protected private are mandatory in class members and methods definitions It is recommended to use private for most members and properties Use pub1ic only for methods that needs to be accessible from outside the class In coreplugins or plugins classes it is generally better to use protected instead of private since most methods may have to be redeclared in extended classes projects plugins Then only use private for members properties you do not want to be redeclared 6 3 1 6 Nesting Avoid deep blocks nesting This is correct Loe Si 0p Si DI ERE if something i continue doMore 6 3 1 7 PHP Code Tags Always use lt php gt
183. nd styles should be set with specific configuration in the mapfile See Section 10 3 Related Elements in Mapfile The total area of the drawn polygons is displayed on the interface 10 1 Client side Configuration 10 1 1 outline ini Here are the options that can be set on the client e multipleShapes boolean if true the user is allowed to draw multiple shapes That means that drawn features remain until browser session is closed If false will outline only one shape at a time new feature simply erases overrides currently drawn one When he wants the user can erase all the drawn feature by clicking on the outline clear form button default true e labelMode boolean if true user is asked to input a label text that is drawn to annotate drawn shape e weightOutlinePoint integer defining display order of the outline point tool icon in toolbar if not specified default to 70 A negative weight disables the tool e weightOutlineLine see weightOutlinePoint default to 71 e weightOutlineRectangle see weightOutlinePoint default to 72 e weightOutlinePoly see weightOutlinePoint default to 73 10 2 Server side Configuration 10 2 1 outline ini Here are the options that can be set on the server 73 Annotation and Redlining pointLayer defines the name of the mapserver LAYER set in the mapfile to display points lineLayer defines the name of the mapserver LAYER set in the mapfile to display lines polyg
184. ndler php script php E Pare SetEnv CW3_PROJECT your_project_name Directory Warning You will need Apache s Env module to use SetEnv command To load this module add the following line to your Apache configuration LoadModule env module usr lib apache 1 3 mod env so 3 2 2 Using current project txt Add a file named current project txt in CartoWeb root directory This file must contain a single line with project name 3 2 3 Using a GET Parameter You can pass a GET parameter project YOUR PROJECT to the client php script for instance http path to cartoweb client php project myProject 3 2 4 Using the Projects Drop down List Have a look at the configuration of client ini described in Section 4 2 client ini in particular directives showProjectChooser and availableProjects to display the project selection drop down menu 37 Projects Handling If showProjectChooser is true a dropdown menu will appear in your CartoClient interface giving the list of all projects available in your project s directory Selecting one will make it the active one Your choice is propagated from page to page Note that if the selected project has snowProjectChooser set to false the project selection dropdown will no more appear keeping you from activating another project To go back to the initial project call the initial client php page without posting the HTML form 3 2 5 Using a Modified client php This shoul
185. ne and only one class to this layer It will be use as template for the generated classes You may use this class to define border color label or other default parameter You should not add this layer to the layers ini configuration file 22 3 2 geostat ini Configuration Choropleth layers are managed differently then ordinary layer within cartoweb server conf mapId geostat ini s used to define layers that may be used for geostatistics Take a look to a sample of this file geostat 0 mslayer region geostat fill geostat 0 label Region geostat 0 choropleth true geostat 0 choropleth_attribs POPULATION HOUSINCOME geostat 0 choropleth_attribs_label Population Average house income These example represents a single layer definition The general for of parameter is geostat n key value nis an incremental number first layer of the config file is 0 131 Geostatistics key is a parameter for this layer value is the value associated to the following parameter The following parameters defined choropleth generation e msLayer name of the layer in the mapfile e label Label for the layer in the interface e choropleth Should choropleth be activated This is present for future development e choropleth attribs Comma separated list of attributes that may be used for choropleth e choropleth attribs label Comma separated list of labels to display as description of the preceding attributes 22 4 Client side Confi
186. nf sql directory Note These steps are detailed in the next section Edit the cartoweb3 projects demoPlugins demo properties file and uncomment the line beginning with ROUTING_PLUGINS e Execute cw3setup php file with the config from file option as described in the previous steps 1 2 4 Locate Plugin specific installation This plugin allows user to search features by their names and recenter on them By typing the first letters of a name user is given a list of corresponding names Clicking on one of them recenters the map on it Note In the locate ini you also need to specify the layers on which you want to do a search by name and the sql statements to request the database Tip Ensure that the tables have the correct privileges GRANT SELECT in the database 1 2 5 Plugins extensions further information The aim of this part is to give you further informations on creation of demoPlugins and demoEdit plugins extensions If you create a new plugin or adapt an existing one we guess it will be helpful to take these plugins extensions for example or use one of these two resources e User HowTo http www cartoweb org cwiki HowTo 27 Installation e Dev tutorial new plugins part Chapter 2 New Plugins 1 2 5 1 demoRouting Extension The routing module is a set of functions that compute a shortest path from a set of edges and vertices Some functions are provided for importing data
187. ng packages 23 Installation Note To enable you to execute PHP scripts easily set the path to the PHP binary in your bashrc in C cygwin home Administrator by default export PATH PATH cygdrive c wamp php The example above is true if the PHP binary are installed in c wamp php If you do not want to install the cvs and gettext Cygwin package you need to add also the path to the external CVS and gettext binaries export PATH SPATH cygdrive c program Files GnuWin32 bin export PATH S PATH cygdrive c program Files TortoiseCVS See the note in Section 1 1 4 3 1 CartoWeb Setup with DOS 1 2 Demos 1 2 1 Introduction A few demos are embedded in CartoWeb to demonstrate the range of functionalities that CartoWeb offers and give users examples on how to implement them e demoCWS3 this is an overview of the standard functionalities that are somehow visible for an end user in CartoWeb e demoPlugins it shows the new functionalities that are available in latest CartoWeb versions e demoEdit a simple demonstration of the geographical objects edition and persistent storage tools Demo data are freely downloadable Next section explains how to install them Configuration and programming details are then described 1 2 2 Installation Before installing these demos you need to have a working CartoWeb installation You can refer to the previous chapters how to install it To install the demoCW3 projec
188. ng script makedoc php el ae lena php makedoc php This will generate documentation in directory CARTOWEB_HOME documentation apidoc 8 2 DocBlocks DocBlocks are comments located at the beginning of a file or just before a class a method a function outside a class or a variable declaration These comments will be parsed by PhpDocumentor to generate documentation For a full description of DocBlocks see official PhpDocumentor documentation http phpdoc org docs HTML SmartyConverter default phpDocumentor tutorial phpDocumentor howto pkg htmlstbasics docblock 8 2 1 DocBlocks Types In CartoWeb we use e Page level DocBlocks one DocBlock for each PHP file Class method class variable and function outside a class DocBlocks one DocBlock for each Require include define if needed one DocBlock for each or all 8 2 2 DocBlocks Contents Short description if needed a one line description Long description if needed a longer description e package package file class we use one package for each directory which 216 Code Documentation contains PHP files it means there are the following packages Client Server Common CorePlugins Plugins Scripts Tests author author file author with email address version Id file always Id content automatically set by CVS param type lt description gt method type mandatory description
189. ni file The dedicated parameters are e viewOn boolean true l false activates deactivates the main view controller Views plugin will not work if the controller is off e viewStorage string file l db tells what storage container must be used file or database viewablePlugins comma separated list of strings list of plugins that must 103 Views have their data saved in views Note that viewable plugins must implement the Sessionable interface If you wish to save data from extended plugins you must add the extended plugin to the list not the standard one eg myLocation instead of location e viewMetas comma separated list of strings list of metadata fields that must be saved in addition to the viewable plugins data for instance author email description Common metadata fields such as viewTitle are anyway saved Note that metadata fields must have homonym form fields in plugins views templates views tpl to be taken into account e viewDsn string DSN Data Source Name gives the database connection parameters Only used in database storage mode Any DSN format supported by PEAR DB can be used See PEAR DB manual for more info about DSNs at http pear php net manual en package database db intro dsn php Note that you can call any database server type as long as it is supported by PEAR DB and that your PHP distribution has the matching extension enabled e viewAuth comma separated list of
190. nning east lt complexType name PanDirection gt lt all gt lt element name verticalPan type types PanDirectionType gt lt element name horizontalPan type types PanDirectionType gt gabe lt complexType gt e verticalPan type of vertical panning e horizontalPan type of horizontal panning lt complexType name PanLocationRequest gt lt all gt lt element name bbox type types Bbox gt lt element name panDirection type types PanDirection all lt complexType gt e bbox current bounding box see Section 1 1 2 Shapes for a description of type Bbox e panDirection panning directions 1 8 5 1 3 Zoom Point Request lt simpleType name ZoomType gt lt restriction base xsd string gt lt enumeration value ZOOM_DIRECTION_IN gt lt enumeration value ZOOM_DIRECTION_NONE gt lt enumeration value ZOOM_DIRECTION_OUT gt lt enumeration value ZOOM_FACTOR gt lt enumeration value ZOOM_SCALE gt lt restriction gt lt simpleType gt ZOOM DIRECTION IN zoom in default is x2 ZOOM DIRECTION NONE no zoom recenter on point only ZOOM DIRECTION OUT zoom out default is x0 5 ZOOM FACTOR zoom using a custom factor ZOOM SCALE zoom to a fixed scale lt complexType name ZoomPointLocationRequest gt lt all gt lt element name bbox type types Bbox gt lt element name point type types Point gt element name zoomType type types
191. ntent lt complexType gt array list of shapes with style lt complexType name OutlineRequest gt lt all gt lt element name className type xsd string gt lt element name Shapes type types ArrayOfStyledShape lt element name maskMode type xsd boolean gt eL lt complexType gt e className OutlineRequest or extended class name if project implements an extension e shapes list of styled shapes e maskMode if true will draw the complement of all shapes merged together 1 3 7 2 Outline Result complexType name OutlineResult all element name className type xsd string lt element name area type xsd double lt al1l gt lt complexType gt e className OutlineResult or extended class name if project implements an extension e area total area for all shapes 163 Calling Plugins 1 4 Examples The following examples show simple SOAP calls using PHP To use these examples with your CartoWeb server you ll have to modify the map ID and the layer names Please note that in these examples access to resources uses symbolic links see Chapter 4 Configuration Files 1 4 1 Retrieving Server Configuration First thing to do is to declare the SOAP client Class SoapClient will need the WSDL code dynamically generated by script cartoserver wsdl php php Sclient new SoapClient http url to server cartoserver wsdl php mapId swiss project swiss
192. oDrawKeymap 64 noDrawScalebar 64 noRowld 68 North Arrow blocks PDF 101 O outputformat 65 outside_mask 71 Overall configuration PDF 91 P panRatio 61 PDF 83 persistentQueries 67 Plugin adaptation 178 Plugin creation 174 Plugin extension 179 Plugin overriding 179 Plugins 173 Plugins calling 175 Plugins interfaces implementations 175 Plugins structure 173 pointLayer 74 polygonLayer 74 Projects 36 Q query Layers 67 query returned attributes 69 R recenterActive 61 recenterDefaultScale 62 recenterMargin 62 refLinesActive 63 refLinesFontSize 63 refLinesSize 63 refMarksColor 62 refMarksInterval interval 63 refMarksInterval maxScale 63 refMarksOrigin 62 245 Index refMarksSize 62 refMarksSymbol 62 refMarksSymbolSize 62 refMarksTransparency 62 Resources 121 returnAttributesActive 67 Roles management PDF 101 roles USERNAME 111 root layergroup 51 roundLevel DXF 82 S scaleModeDiscrete 62 scales label 62 scales value 62 scales visible 62 scalesActive 61 scaleUnitLimit 61 securityContainer 111 separator CSV 81 shortcuts bbox 62 shortcuts label 62 shortcutsActive 61 showRefMarks 62 Smarty Templates 121 Special plugins 183 T Table blocks PDF 98 Tables 187 template 134 135 template object PDF 93 Templates 121 Text blocks PDF 95 textDelimiter CSV 81 tooltips 133 topLayers 58 transparencyLevels 59
193. of the root directory For instance if you want to change the layers template i e basically the representation of the layers hierarchy simply copy the default coreplugins layers templates layer tpltO projects my project coreplugins layers templates layer tpl and make your changes there For more information about projects see Chapter 3 Projects Handling 35 Projects Handling 3 Projects Handling 3 1 Introduction Projects are used to customize a CartoWeb application to your needs By creating a new project you can override templates resources files pictures style sheets JavaScript files etc configuration files and even add new plugins or modify existing ones It is strongly recommended to use projects when deploying a CartoWeb application with non standard layout or plugins The main reason is the necessity to keep upstream files unchanged in order to easily apply the application upgrades Projects are in fact a mirrored collection of directories and files from the original architecture Files placed in a project are in most cases used preferentially to the original files There is an exception with plugins PHP classes the latter must be extended and not simply overridden In projects you can also add brand new files for instance new plugins that have no original version in the upstream structure Fore more details about how to write or customize plugins in projects see Chapter 2 New Plugins in Part II
194. olean if true block is vertically centered overloads verticalBasis property textAlign centerlleftlright indicates how content must be horizontally aligned within the block extent verticalAlign centerltoplbottom indicates how content must be vertically aligned within the block extent orientation horizontallvertical indicates if content will be displayed form left to right or from bottom to top only for text blocks zIndex integer indicates how overlapping blocks must be stacked The higher the zIndex the higher the block in the stack foreground weight integer indicates in what order blocks with the same zIndex must be processed Low weighted blocks are handled first inNewPage boolean indicates if a new page must be added before printing the block inLastPages boolean indicates if block must be added in a new page at the end of the document width float block width in distUnit height float block height in distUnit multiPage boolean if true given block will be displayed on every document page parent string if specified current block will be printed inside given parent block inFlow boolean if true block will be printed right after previous block preserving the vertical alignment caption string for table blocks only name of separated block used to describe table caption formatting headers string for table blocks only name of separated block used to describe table head
195. olumns Parameter co1umnids should contain an array of column IDs determining which columns to remove 2 4 3 2 3 Group Filter public function addGroupFilter groupId callback Group filter rules allow to modify group title Parameter ca11back should contain a pointer to a callback method with the following signature Static function myCallbackMethod group id group title return group new title 2 4 3 2 4 Table Filter 188 New Plugins public function addTableFilter groupId S tableId callback Table filter rules allow to modify table title Parameter ca11back should contain a pointer to a callback method with the following signature static function myCallbackMethod table id table title return table new title 2 4 3 2 5 Column Filter public function addColumnFilter groupId S tableId columnId callback Column filter rules allow to modify column title Parameter ca11back should contain a pointer to a callback method with the following signature static function myCallbackMethod table id column id column title return column new title 2 4 3 2 6 Cell Filter public function addCellFilter groupId tableId columnId inputColumnIds callback Cell filter rules allow to modify content of a cell Values of columns given in parameter inputColumnids will be transfered to the callback method for cell content calculation Parameter ca11back should contain a pointer to a callback
196. omized applications Developed by Camptocamp SA http www camptocamp com it is based on the UMN MapServer http mapserver gis umn edu engine and is released under the GNU GPL license http www gnu org copyleft gpl html 1 2 Credits To date the following people have been more or less involved in the development of CartoWeb Yves Bolognini Mathieu Bornoz Oliver Christen Damien Corpataux Olivier Courtin Daniel Faivre e Alexandre Fellay Marc Fournier e Jean Denis Giguere e Florent Giraud e Pierre Giraud David Jonglez e Fr d ric Junod e Sylvain Pasche e Claude Philipona e Arnaud Saint Leger e Alexandre Saunier Cartographic Functionalities 2 Cartographic Functionalities 2 1 Introduction CartoWeb is quite a complex piece of software This chapter is only a quick and consequently incomplete overview of the standard functionalities that are somehow visible for an end user The internal architecture and all the hidden features that make CartoWeb customizable and extensible are presented in the next chapter 2 2 Overview The first figure is an overall view of the user interface of the demo that is shipped with CartoWeb The numbers refer to more or less visible underlying features They are Main map Dynamic keymap Navigation tools zoom in zoo out panning Layers tree Geographic query tool Redlining tools to draw points lines rectangles polygons Measuring t
197. on as follows blocks overview content static In that case parameters overviewScaleFactor overviewColor overviewOutlineColor are ignored 12 3 2 2 formats Formats objects describe the PDF pages sizes bigDimension smallDimension One can describe as many formats as desired Moreover there is no theoritical page size limit except that the bigger the maps the longer the document generation A format is determined by its biggest dimension bigDimension and its smallest dimension sma11Dimension The label parameter will be translated using Cw3 I18n internationalization system Chapter 16 Internationalization It is not required to be identical to the format object id On the other hand the latter id must be textually listed in general formats parameter or else it will not be taken into account In addition a couple of format parameters can be specified norizontalMargin and verticalMargin override the corresponding general parameters if different margins must be applied for the given format maxResolution indicates the highest allowed 92 PDF Export resolution for the given format it enables to limit the applied resolution when for instance printing big dimensioned maps For instance formats settings formats A4 label A4 formats A4 bigDimension 297 formats A4 smallDimension 210 formats A3 label A3 formats A3 bigDimension 420 formats A3 smallDimension 297 formats A3 horizontalMargin
198. onLayer defines the name of the mapserver LAYER set in the mapfile to display polygons Note that rectangles are displayed as polygons maskColor defines the RGB color of the mask This color is used to fill the polygons outside s area Drawn polys will appear as holes in a colored sheet showing the map under This parameter is optional and set by default to 255 255 255 white areaFactor defines an optional value for ratio by which the area is multiplied before it is returned to the client For example people can use it to convert square meters to square kilometers symbolPickerHilight inversedlborderhilight set the hilight mode to use in the SymbolPicker interface See Section 10 4 3 2 SymbolPicker 10 3 Related Elements in Mapfile 10 3 1 Layers Specific layers must be set in the mapfile in order to draw the shapes LAYER NAME cartoweb point outline TYPE POINT LAYER NAME cartoweb line outline TYPE LINE LAYER NAME cartoweb polygon outline TYPE POLYGON The point layer is optional as it can be replaced by polygon layer when missing Don t forget that layers names must be set in the server side outline ini file See Section 10 2 1 outline ini 10 3 2 Labels In case of using labels i e labelMode set to true see Section 10 1 1 outline ini a 74 Annotation and Redlining LABEL object is needed in the layers class Example LAYER NAME cartoweb point outline TYPE POINT CLASS
199. only the TableGroup query is visible but you can specify more than one separate by comma If this block is not defined in the configuration file all TableGroup are visible in the PDF file backward compatibility 99 PDF Export The query results data come from the plugin Table which offers the mechanism of table rules see Section 2 4 3 2 Setting Rules which describes how tables must be displayed You can also add table rules specificaly for the PDF output like this example SoutputType this cartoclient getOutputType if SoutputType Cartoclient OUTPUT_HTML_VIEWER rules for HTML output if SoutputType pdf rules for PDF output output Type is generally the export plugin name without the export prefix 12 3 4 6 Legend Block There is usually only one instance of legend block in a CartoWeb PDF document It gives the list of the selected layer class icon couples Content is automatically retrieved according to selected layers You only need to set the text formatting and row height as for a table block Legend blocks does not provide any table like headers or caption You can avoid that a given set of layers be displayed in the legend blocks no change on the maps by listing the forbidden layers ids in the legend block content won parameter prefixing each layer id with an exclamation point For instance blocks legend content background layer3 Note
200. ools distances and surfaces Language switch internationalization support SOP roov nO op cansa sse uS Login link users and roles support e Print dialog PDF production Cartographic Functionalities e d EZE ail Camptocamp CartoWeb3 Demonstration GIS IT Engineering About Outline Themes l Print Search Background Cc None c Vector Raster Human activities BM Toms O row Agglomeration Bn Transports D N Roads r e Category Hydrology v amp Icelands AV Rives V EJ aes Rebesh o 41 82 123 164 km 1 1500000 Scale Mapsize 520x420 7 Powered by CartoWeb Camptocamp SA 2 3 Navigation Interface There are many possibilities to navigate on the main map that is to change the scale and the position e The arrows surrounding the main map The dynamic i e clickable keymap e The navigation tools zoom and pan The drop down menu Scale The various options in the Search tab The menu Mapsize is self explanatory 2 4 Arbitrarily Complex Hierarchy of Layers Contrary to Mapserver itself CartoWeb supports an arbitrarily complex hierarchy of layers with infinite depth The elements of the layers tree have different rendering options normal checkboxes Cartographic Functionalities blocks radio button exclusive options drop down menu exclusive options Examples of these rendering options are presented in
201. or CartoClient plugins and in server conf mapId mapId ini for CartoServer ones For instance loadPlugins auth outline exportHtml Since they are not always available simple plugins usually do not rely on each other On the other hand it is not a problem for them to call some coreplugins functionalities if the latter are publicly accessible Simple plugins files are grouped in the plugins directory The general philosophy is to gather all files of a given plugin in the same dedicated directory including files from both CartoClient and CartoServer sides of the plugin Thus it is easy to plug a new module in CartoWeb architecture by simply pasting it in the plugins or coreplugins parent directories Note however that plugins configuration files named lt pluginName gt ini are placed in the client_conf and or server conf mapid depending if those plugins have CartoClient CartoServer components 2 1 3 Plugins Structure 173 New Plugins Plugins and coreplugins have the following general structure lt pluginName gt lt pluginName gt client lt pluginName gt server lt pluginName gt common lt pluginName gt templates lt pluginName gt htdocs lt pluginName gt htdocs gfx lt pluginName gt htdocs js lt pluginName gt htdocs css e client contains all specific CartoClient side PHP files e server contains all specific CartoServer side PHP files e common contains PHP files shared by
202. orage you would need first to create an appropriate table called views Here is an example of SQL statements for PostgreSQL CREATE TABLE views views id serial NOT NULL PRIMARY KEY views ts timestamp without time zone viewtitle character varying 50 author character varying 50 sessiondata text viewshow boolean weight integer Tip Field views ts is just present in table views but not visible in the graphical interface of the views plugin This value is usefull to know the time of the creation modification of a view only available with option viewStorage db 13 3 Views Usage 13 3 1 Loading Views Any defined view may be loaded by any users Loading a view may be achieved selecting it among a dropdown views list Two dropdown lists are available apublic one that only displays views labels that have been marked as visible by their creators aselector within the Views plugin edition interface This view selector contains all views including the ones that have not been marked as visible by their creators Note that this selector provides a view ID integer input as well Views may also be loaded using GET parameters in URLs that look like http cartoweb client base url handleView 1 amp viewLoad l amp viewLoadId viewId or simply http cartoweb client base url view viewId Tip Views not marked as visible may anyway be loaded by anyone Visible only means that their lab
203. orm If this list is absent all msLayers appear in the form e shortcutsActive boolean if true the shortcuts direct access dropdown list are displayed default false e scaleUnitLimit scale above which DHTML measures use km below they use m e panRatio ratio for panning by clicking directional arrows Default is 1 no overlap no gap Values below 1 result in an overlap of the old and the new maps values above 1 in a gap between these two maps e weightZoomin integer defining display order of the zoomin tool icon in toolbar if not specified default to 10 A negative weight disables the tool e weightZoomout see weightZoomin default to 11 e weightPan see weightZoomin default to 12 e weightFullextent see weightZoomin default to 14 e crosshairSymbol integer numerical id of symbol to use to materialize recentering point see your symbolset file crosshairSymbolSize integer defining the size used to display the recentering crosshair symbol 61 Navigation e crosshairSymbolColor RGB code comma separated list of integers of the crosshair color e showRefMarks if true will add reference marks to the main map Reference marks configuration is set on server 7 2 Server side Configuration Here are the options that can be set e minScale if set minimal scale allowed e maxsScale if set maximal scale allowed e scaleModeDiscrete boolean if true only specified scales see below can be
204. ove performance Warning This parameter will be overrided by the profile parameter See Section 4 1 Common client ini and server ini Options Warning Setting this option to a1se means that your template won t be updated any more Pay attention to this if you need to change them on the server 5 2 WSDL Cache When using SOAP and the usewsal1 option is set to true in the client conf client ini or server conf server ini the WSDL generated document can be cached for more performance This is the purpose of this cache option So it should be activated in production environment and turned off during development if your changes have an impact on the WSDL 5 3 MapInfo Cache MapInfo is a structure generated on the server and used by the cartoclient to access static server information This cache keeps a copy of the MapInfo structure on the http smarty php net 46 Caches Configuration client or the server so that the client does not need ask it everytime and the server can avoid regenerating it from scratch 5 4 MapResult Cache This is a server side only cache which caches the requests made to the server This cache works at the Php level meaning that it can be used when CartoWeb is used in direct or SOAP mode For the distinction between these two modes see Section 4 2 client ini However the XML SOAP cache is more appropriate when using SOAP mode see details in the next chapter 5 5 XML SOAP
205. p airport gt tmp airport sql psql d demo plugins f tmp airport sql ShpZpgsgl i builtupa shp agglo gt tmp aggio sqi psql d demo plugins f f tmp agglo sqi shp2pgsql I polbnda shp district gt tmp district sql psqL el demo pluging f V tnp dsstrict sgl shp2pgsql I mispopp shp town gt tmp town sql psql d demo plugins f tmp town sql ur Note shp2pgsql is a command line program that exports a shapefile into SQL commands Don t forget to specify its location on your system to use it You 25 Installation have to specify the path to the shapefiles if they aren t in the current directory Execute cw3setup php file with the fetch demo option to download geographical data cw3setup php Options To finish demoPlugins installation you will need to launch the cw3setup php With the config from file parameter pointing to a property file containing database configuration informations Such a file is provided in the cartoweb3 projects demoPlugins demo properties file You need to edit this file and change the parameter to match your environment In particular the DB HOST DB USER DB PASSWD and DB PORT options need to match your database access configuration DB LOCATE NAME must be set to the name of the database for the locate plugin This file contains comments about the description of each variables Here s an example how to call the cw3setup php scr
206. pical predefined roles Example 15 2 Global Permissions Usage SecurityAllowedRoles loggedIn 15 4 Plugin Specific Permissions The main part of permissions is set in the different plugins of CartoWeb For instance permissions related to which layer can be viewed are set in the layer plugin configuration files and pdf printing permissions in the pdf plugin These sections either describes the plugin permissions which can be used or make references the the corresponding chapters 15 4 1 Layers Related Permissions It is possible to restrict which layer can be viewed by a set of users For instance only logged in admin users can be allowed to view security sensitive layers These layer permissions are inherited by children It means that if a parent LayerGroup is not allowed to be viewed then all the children won t be visible The permissions for layer must be activated in the layers ini CartoClient configuration file and are set in the metadata of the mapfile or the 1ayers ini configuration file The concept of metadata in mapfiles and ini file is described in Section 6 3 Metadata in Mapfile and layers ini The metadata key name which can be used is called security view and contains a coma separated list of roles which are allowed to view this layer If no such metadata key is associated to a layer or layerGroup anyone can see the layer Heres the description of the 1ayers ini configuration file e applySecurity Tru
207. plexContent gt restriction base encll Array attribute ref encll arrayType wsdl arrayType types TableGroup restriction complexContent lt complexType gt array list of table groups complexType name TableFlags all element name returnAttributes type xsd boolean element name returnTable type xsd boolean gt all lt complexType gt e returnAttributes if true will return attributes row cells in addition to row IDs e returnTable if false won t return any table information This can be useful for instance when hilighting an object on which no information is needed 1 2 Call to getMapInfo 144 Calling Plugins This method returns server configuration which includes layers initial states and other plugin specific configuration Variables returned by this method are set in server configuration files described in Part II User Manual 1 2 1 Global Server Configuration This includes layers configuration and initial states complexType name LayerState all element name id type xsd string gt lt element name hidden type xsd boolean gt lt element name frozen type xsd boolean gt lt element name selected type xsd boolean gt lt element name unfolded type xsd boolean gt lt all gt lt complexType gt e id layer state ID hidden if true layer isn t displayed in tree and attribute selected cannot be modi
208. proaches ceeeceeeeeeeeeeeeeeeeeeeees 181 2 4 ERT CEET 183 2 ET EXport EE 183 VE DM qe 185 ESSI ER cette Neate ta cde nen at epee tact heen ete 187 3 Dynamic mapfile modifications esee 194 SNE age eet EE 194 3 2 Plugin usage eg orsi se WS a RUNS ANN ERES NS N ore ANNE O PEE Aa PASS 195 32A WEE EE 195 3 22 Add Teat re i EE tein db ep 196 22 9 Pilter data eegene Ee etel i 196 D2 IBI at 197 4 Using the Security Infrastructure EE 198 SN PE TOM MCU OM ET 198 4 2 Plugins Managing Security Database and Authentication 198 4 3 Plugins Granting or Denying Access to Objects Features in Carto E 198 5 Int rnationaliz tion scis e Ee ent ta o EI rege weeds 200 De PPADS A TEE 200 5 2 Character Set Encoding ugereegt nora e Pn PH RS 201 6 Code Conyentlon ee EENEG 203 6 T Introduction eine dee 203 CartoWeb Documentation 6 2 General Coding Rules 405 554 85 8 iau s dash Een 203 NHS EE 203 6 2 2 Extract and Run Deployement sess 203 6 2 3 Development Configuration cceeecceeeereeeeeeeeeeteeeees 203 9 2 4 U nb EE E EU IR asad see Seeds Dota eG 203 0 3 PHP ii uses nanna RD i a pd e 204 6 3 1 ee ME TE 204 0 3 2 COMMEONES dienen 206 6 4 HTML Coding Statidards se cds teri ee deett ade ege 206 0 4 1 Nesting E 207 6 4 2 Lower CASE ect tae QU terio e tUe EUIS Se 207 6 4 3 GI P M 208 6 4 4 ME D EEN 208 6 5 Id TEE 209 6 4 6 Image alt da te eet
209. r resolution request layersRequest className LayersRequest request layersRequest layerIds array swiss layer LI swiss layer 2 request layersRequest resolution null In this case the location request object is of type zoom point and zoom type is set to ZOOM SCALE Bbox is unused but is required request locationRequest className LocationRequest request locationRequest locationType zoomPointLocationRequest 167 Calling Plugins request locationRequest zoomPointLocationRequest bbox minx 500000 request locationRequest zoomPointLocationRequest bbox miny 100000 request locationRequest zoomPointLocationRequest bbox maxx 600000 request locationRequest zoomPointLocationRequest bbox maxy 200000 request locationRequest zoomPointLocationRequest point x 550000 request locationRequest zoomPointLocationRequest point y 150000 request locationRequest zoomPointLocationRequest zoomType ZOOM SCALE request locationRequest zoomPointLocationRequest scale 200000 Now request object is ready SOAP method is called EX Y result client getMap request priut r osrosultis catch SoapFault fault IER Eenheet Ex Result is shown below It includes relative paths to generated images and new bounding box computed from requested scale stdClass Object timestamp
210. ransparency type xsd int Siet lt complexType gt symbol index of Mapserver symbol e size size of shape color color e outlineColor outline color e backgroundColor background color transparency transparency lt complexType name LabelStyle gt lt all gt lt element name font type xsd int gt lt element name size type xsd int gt lt element name color type types Color gt lt element name outlineColor type types Color element name backgroundColor type types Color yall lt complexType gt font index of Mapserver font e size size of font color color e outlineColor outline color e backgroundColor background color lt complexType name StyledShape all element name shapeStyle type types ShapeStyle lt element name labelStyle type types LabelStyle lt element name shape type types Shape 162 Calling Plugins element name label type xsd string gt all lt complexType gt e shapeStyle style of shape e labelStyle style of label e shape shape can be a point rectangle line or polygon see Section 1 1 2 Shapes for a description of type Shape label content of label complexType name ArrayOfStyledShape lt complexContent gt restriction base encll Array attribute ref encll arrayType wsdl arrayType types StyledShape restriction complexCo
211. rectory If not set generic 1ayerResult tplis used The template to use can also be set in renderResult method in PHP code if QueryableLayer is extended See Section 23 3 2 Extending classes area async members label Members area async members dsn pgsql www data www data localhost 5432 france area async members dbTableName points area async members attributes name age place Note For area async layers layer definition in mapfile doesn t have to be a postgis connectiontype layer For example user is able to draw geographical data coming from a shapefile and show attribute values coming from a non geographical database 23 2 3 Area Direct 23 2 3 1 Introduction For the area direct defined layers area tags are sent within the HTML source of the page as well as the relative attributes names and values Interactive areas area available on the map on top of corresponding features When the user moves the mouse over each area and stops during several milliseconds a basic HTML table is built with the attributes using javascript and display with the tooltip 23 2 3 2 Pros Cons Pros simplest way to use tooltips no database needed can work with shapefiles or data files e no server call live result 135 ToolTips Cons cannot work for line type features may be ressource consuming and performances may fail for large amount of features only one result at one time
212. replugins mapquery server ServerMapquery php call Common cartowebErrorHandler file 222 var www cartoweb3 coreplugins mapquery server ServerMapquery php call ServerMapquery queryByBbox file 248 var www cartoweb3 coreplugins query server ServerQuery php call ServerMapquery queryByBbox 8 Undefined property ServerMapquery currentQeury var www cartoweb3 coreplugins mapquery server 222 Array 2 file 369 var www cartoweb3 coreplugins query server ServerQuery php call ServerQuery queryLayer polygon Object Bbox file 58 var www cartoweb3 server ServerPluginHelper php call ServerQuery gt handlePreDrawing Object Bbox Object QuerySelection file 96 var www cartoweb3 server ServerPluginHelper php call ClientResponderHelper callHandleFunction Object QueryRequest 9 3 2 Using Direct for More Verbosity In some situations a fatal error on the server will display a message with not much verbosity 222 Logging and Debugging Failure class SoapFault message parse error unexpected T VARIABLE The fact no line number and Php file is displayed is a limitation of the Php SOAP implementation workarounds are welcomed In such a situation a solution for this problem is to enable the CartoWeb direct access mode of operation Direct access mode is set with the cartoserverDirectAccess parameter of the cient conf client ini configuration file For more details
213. request that was sent to server e Call all plugins to ask for request modification eg map resolution changes keymap generation enabled disabled etc e Call server to get a new modified result Use the result to generate output Return output in a standardized form 2 4 1 1 Export Plugin Naming Convention Warning Export plugins MUST have names that begin with the string export for instance exportPdf exportCsv Of exportHtml This rule does not apply to extended plugins since only the original plugin name is detected 2 4 1 2 ExportPlugin Class ExportPlugin implements a special type of client plugin with some specific functionnalities for export It implements interface GuiProvider so child classes must implement corresponding methods Class methods are e getLastMapRequest returns last used request object This is useful to prepare a new call to server in order to obtain data specific to export This call is done in method getExportResult e getLastMapResult This can also be useful in some cases to have the last returned result obect 183 New Plugins e getExportResult executes call to server in order to obtain a modified result suitable for export generation Calls all exportable plugins in order to modify request see Section 2 4 1 4 Exportable Interface e getExport abstract contains export generation itself Should prepare export configuration call getExportResult and generate e
214. returned for each row 170 Calling Plugins stdClass Object timestamp 1107925732 serverMessages gt Array imagesResult stdClass Object className gt ImagesResult mainmap stdClass Object isDrawn gt 1 path gt images 110846607738541 7jpg width height format keymap gt width height format 500 500 gt stdClass Object isDrawn gt 1 path gt images 110846607738542 png gt 150 gt 99 gt scalebar gt stdClass Object isDrawn gt path gt width gt height gt format gt locationResult gt stdClass Object className LocationResult bbox gt stdClass Object minx gt 550000 miny maxx gt 100000 gt 600000 maxy gt 150000 scale gt 377952 96 queryResult gt stdClass Object className tableGroup QueryResult stdClass Object groupId query groupTitle Query tables 0 gt Array stdClass Object tableId swiss layer 1 tableTitle swiss layer 1 numRows gt 0 totalRows gt 0 offset gt 0 columniIds gt Array columnTitles gt Array 171 Calling Plugins gs noRowId gt rows Array gt stdClass Object tableId swiss layer 2 tableTitle swiss layer 2
215. rgin indicate how much space will be kept blank around each page No block will be printed below these distances from the sheets borders Note that these values can be overriden in the formats description For instance general settings general guiMode classic general formats A4 A3 general defaultFormat A4 general resolutions 96 150 300 general defaultResolution 96 general overviewScaleFactor 10 general defaultOrientation portrait 91 PDF Export general activatedBlocks mainmap title note scalebar overview copyright queryResult page legend logo scaleval tlcoords brcoords general pdfEngine CwFpdf general pdfVersion 1 3 general output inline general filename map date dMY Hi pdf general distUnit mm general horizontalMargin 10 general verticalMargin 10 general importRemotePng false Some overview map settings are available as well The overviewScaleFactor indicates how wide the overview will be compared to the mainmap actual extent overviewColor and overviewOutlineColor respectively set the inner and border colors of the mainmap outline in the overview map Note that the out line plugin must be activated ie added in the c1ient ini loadPlugins parameter for those settings to be taken into account Tip To use the classical MapServer keymap in place of the overview set the overview block content parameter to static see Section 12 3 4 Blocks Configurati
216. rmissions Permissions describe parts of the application which can be allowed or denied access A permission can have roles for which access is allowed and roles for which it is denied 15 2 Auth Plugin The security system in CartoWeb was developped to be modular and to allow different authentications systems to be easily plugged in This section describes one implementation of authentication user password and roles management which is the auth plugin shipped with CartoWeb Cartoclient Title Login dialog Please enter your login and password Username Password Submit Click here to go back to the map 110 Security Configuration The auth plugin is not a core plugin That s why you need to enable it if you want to enable users to log in See Chapter 4 Configuration Files how to enable it in the list of plugins If it is not activated the login dialog won t be available so users will remain anonymous The next section describes the configuration file of the auth plugin It is basically the management of usernames passwords and roles 15 2 1 auth ini Client side The auth ini configuration is located in the client This file contains the list of usernames their password and the roles they belong to e authActive boolean Whether to show the Authentication login logout buttons note this is not related to the fact the authentication system will be active or not users USERNAME List of users and their pass
217. rojects yourProject coreplugins images templates with the templates of the overriden part of the coreplugin Remember templates are stored in the overriden part and PHP classes in the extended part yourImages tpl input type text name testField value SimagesTest php i version Id ClientYourProjectImages php v 1 8 2005 02 23 11 52 43 johndoe Exp A class ClientYourProjectImages extends ClientImages indicates that we want to use current plugin instead of regular images plugin public replacePlugin return images overloaded method public function renderForm Smarty Stemplate a Simage2 Smarty var must have been added in cartoclient tpl template assign image2 S this drawNewImagesField parent renderForm Stemplate additional method private function drawNewImagesField Ssmarty new Smarty_Plugin S this gt getCartoclient this smarty assign imagesTest Foobar return smarty fetch yourImages tpl 2 gt Don t forget to activate the extended plugin in projects yourProject 182 New Plugins client conf client ini loadPlugins yourProjectImages 2 4 Special Plugins 2 4 1 Export Plugins Export plugins allow to export maps and data Concepts described below provide tools to help writing such plugins In brief export plugins follow these steps in order to generate an output Retrieve last
218. ructure e Q lient Client specific code files client conf Client configuration files see Chapter 4 Configuration Files e common Common client and server code files e coreplugins Basic mandatory plugins o images Image generation see Chapter 8 Image Format Options o layers Layers management see Chapter 6 Layers o location Navigation see Chapter 7 Navigation o mapquery Perform queries based on a set of selected id s see Section 9 2 2 MapServer Query Configuration o query Perform queries on layers see Chapter 9 Queries o Statictools Distance and surface calculation o tables Table rules management see Section 9 1 2 Tables Configuration documentation documentation o apidoc PHP source code documentation o user manual source DocBook XML source of the present documentation e htdocs Web accessible directory o css css files o gfx icons files o js javascript files e include libraries used by CartoWeb locale locale files for internationalization purposes see Chapter 16 Internationalization e log logs mainly used for development and debug purposes plugins Standard but not mandatory plugins see Section 2 3 Plugins o auth authentication plugin see Chapter 15 Security Configuration 33 Structure o exportCsv Csv export plugin see Section 11 3 CSV Export o exportHtml HTML export plugin see Section 11 2 HTML Export o exportPdf PDF e
219. ryByCircle 43 e weightOutlinePoint 70 e weightOutlineLine 71 e weightOutlineRectangle 72 e weightOutlinePoly 73 e weightDistance 80 e weightSurface 81 Use a negative value to deactivate a tool weightFullextent 1 4 4 2 Grouping Tools Icons CartoWeb offers the possibility to display tools icons in separated locations of its interface For instance browsing icons may be displayed in the general toolbar whereas outline pictos may only appear in a dedicated folder To do so simply add an integer group index for each tool in matching plugin configuration file For instance 44 Configuration Files groupDistance 2 By default all tools icons are affected to group 1 Note that the parameters naming convention is the same than for weight parameters see Section 4 4 1 Ordering Tools Icons only substituting the group prefix to the weight one It is also possible to specify a global plugin group index that will be applied to all the given plugin tools if no individual group index has been set To do so use the groupPluginin the matching plugin configuration file as follows groupPlugin 3 To take benefit of the tools groups update the main CartoWeb template file templates cartoclient tpl by including the toolbar tp1 template at the correct places with the correct group indexes as follows include file toolbar tpl group 2 For more information about templates writing see Chapter 17 Templating
220. s 10 4 3 2 2 Without the Outline Plugin Standalone Use If you do not use the outline plugin you will need to set the following javaScript variable somewhere in your page lt script type text javascript gt d Ee CBATAT Z var imgPath path to symbol images var symbolType type of image files jpeg gif png whatever var symbolNamesArray new Array symbolfilenamel symbolfilename2 othersymbolfilename var symbolLabelArray new Array symbollabell symbollabel2 othersymbollabel JO script 77 Annotation and Redlining symbolNamesArray contains the list of filename to use for your images symbolLabelA rray contains the list of label used on screen for the symbols Create your symbol images and put them in path to symbol images You also need to create hilighted versions of your images give them the same filename but add the suffix over Exemple symbol l gif gt symbol 1 over gif Put them in the same folder 10 4 3 2 3 Symbol Hilight Mode There are two modes to hilight the selected symbol in the SymbolPicker interface You can select between border hilight and inverted image border hilight simply use a css property to hilight the border of the selected symbol inverted image need the php library GD to create an inverted version of the symbol which is then used for the selected symbol The hiligh mode is set in the server conf outline ini file e symbolPickerHilight
221. s Plugins are called several times during the program execution entry points Thus they can interact at various level of the application To determine what plugins must be called at what moment and to perform what action plugins must implement one or more of the CartoWeb plugin interfaces according to the object oriented programing meaning The interfaces define methods that will be triggered by the main program during its execution For example you can take a look at the following simplified Caztoclient doMain method main program defined in client Cartoclient php private function doMain this callPluginsImplementing InitUser handleInit this getMapInfo if this isRequestPost 175 New Plugins this cartoForm this httpRequestHandler handleHttpRequest this clientSession Sthis cartoForm request new FilterRequestModifier REQUEST this callPluginsImplementing FilterProvider filterPostRequest request this callPluginsImplementing GuiProvider handleHttpPostRequest request getRequest else Srequest new FilterRequestModifier _REQUEST this callPluginsImplementing FilterProvider filterGetRequest request this callPluginsImplementing GuiProvider handleHttpGetRequest request getRequest SmapRequest this getMapRequest t mapRequest t his mapResult t his call t
222. section describes specific features developped in CartoWeb for running tests and infrastructure classes for more simple test case writing 213 Unit Tests 7 2 2 1 HttpUnit Based Tests To test features of the cartoclient the HttpUnit http httpunit sourceforge net software is used It is written in Java and there is no Php port The http unit tests are run if you have a JVM in you path For more information about running HttpUnit tests see the tests client httpunit README file in the CartoWeb distribution 7 2 2 2 Testing CartoWeb Plugins Plugins are a main component in CartoWeb architecture That s why there is support to maintain common code used for testing plugins As described in Section 7 2 1 General Information About Writing Tests the tests for plugins have to mirror the file hierarchy of the base application That s why there are coreplugins and plugins directories where test for core plugins and plugins are stored respectively Note Tests are also available for projects So to test a plugin in a project the path of the test will be lt cartoweb3 gt lt projectname gt tests plugin lt pluginname gt Testing plugins is separated into two tasks 1 Locally testing client common or server classes For plugin client classes it requires a CartoClient environment available and identically a CartoServer environment for testing server classes 2 Remote plugin tests throught the webservice API
223. seed 140 ENEE 141 US EN KEEN 142 1 2 Call to SSUM ADIBTO dossier Papeete in ed Beta it 144 1 2 1 Global Server Configuration eese 145 L22 rs qp E 146 Ee EE 149 1 24 Layer Reordet seniste aedes Eet 150 1 3 Call to BetM3ap odi eig ete EUR deele 151 1 53 Global rt 151 1 3 2 Images aeuo noU ERROR UID OT 152 e e EE 153 1 3 4 Layer Reordet ee ninne 154 E S EGUdIHOD EE 155 CartoWeb Documentation E DATE 161 1 4 E E 164 1 4 1 Retrieving Server Configuration esses 164 1 4 2 Getting a Map Using a Point and a Scale 166 1 4 3 Ex c ting a QUGEPYV tee enore aM e dits Docs RANGE 169 2 New EE 173 2 T Whatare EE 173 PNE Nb 173 2 1 2 Plugins and Coreplugins 5 aee ciet de tetto tete eene 173 2 1 3 Plugins SI eture o nie iio ged e 173 2 2 WHEN a PIUSUR eege eebe qe eee enar gu tiae dar dap aged 174 2 2 T Introduction eer Ueber MINI e UU R VETE 174 2 2 2 Plugin or Coreplugin aides ep teu ecran ts 175 2 2 3 How Plugins Are Called esee 175 2 2 4 Plugin Creation Check List 2 0 0 ceeceeeeeeeeereeeeeeeeeeeeeeees 177 2 2 5 Automatic Files Inclusion eere 178 7 2 Adapung EM ER Ege i aiU 178 2 3 1 Approacbes auissseaaui eie lori o iin Bet ense A Re 178 2 923 Overrniding a PIUS sar eorpore tare eae ee Qr ar Rees 179 2 3 3 Extending a Plugin eie ettet teen e d s d n 179 2 3 4 Combining Both Ap
224. sibility to rotate the map to be printed directly on screen e general formats comma separated list of strings ids of available sheet sizes Must match format objects names see Formats configuration below 83 PDF Export general defaultFormat string default selected used format Must be one of the above list items general resolutions comma separated list of integers list of available resolutions in dot per inch dpi general defaultResolution integer default selected used resolution Must be one of the above list items general scales comma separated list of integers list of available printing scales 1000 should be read 1 1000 Used only when guiMode is rotate general defaultScale integer default printing scale Must be one of the above list items Used only when guiMode is rotate general defaultOrientation portraitllandscape sheet orientation The same orientation is used for every pages of the PDF document general activatedBlocks comma separated list of strings names of blocks that will be used in the document Names must match block objects names See Blocks configuration section general overviewScaleFactor float sets the extension of the overview map The bigger this parameter the wider the extension Default 10 general overviewColor string sets the inner color of the current map outline in the overview Default none general overviewOutlineColor string sets the border color o
225. sing this list and displayed in the GUI switches switchl label Switch 1 switches switch2 label Switch 2 switches switch3 label Switch 3 Then each layer group that needs to change its children depending on the switch ID may add this ID as a suffix to the children option layers layerId className LayerGroup layers layerId children switchl layerl layer3 layers layerId children switch2 layer2 layer3 layers layerId children switch3 Special suffix default can be used to define a default children list layers layerId className LayerGroup layers layerId children switch2 layer2 layer3 layers layerId children default The following layer group definitions are equivalent layers layerId className LayerGroup layers layerId children default layer4 layers layerId className LayerGroup layers layerId children layer4 6 3 Metadata in Mapfile and layers ini Metadata are keyword value pairs which can be associated to a MapServer layer in the mapfile or to a Layer or LayerGroup in the layers ini configuration file These metadata are used in several different contextes such as layer specific configuration security handling The metadata related to the functionalities of CartoWeb are described in the documentation of the corresponding plugins 6 3 1 Metadata in Mapfiles 52 Layers Specifying metadata in mapfiles is based on the standard MapServer syntax For instance LAYER NAME my layer
226. strings list of roles allowed to perform views edition actions Given roles must match client_conf auth ini defined ones See also Chapter 15 Security Configuration e viewSavedRequest comma separated list of strings list of REQUEST variables GET POST COOKIE that must be preserved when loading a view Some are already built in listed such as tool js folder idx project collapse keymap and views related parameters Adding other CartoWeb reserved REQUEST variables names to the list may prevent the view system from working correctly e viewLogErrors boolean if true outdated views loadings will be logged in 1og viewErrors log e viewUpgradeOut dated boolean if true CartoWeb will try to upgrade outdated views on the fly Else view outdated parts will be discarded and current plugin session data will be used instead e viewHooksClassName string name of the PHP class used to customize some views processing See Section 11 3 Customizing Views Processing Using Project Hooks for details on how to write customized views hooks For instance Views management viewOn true viewStorage db viewablePlugins location layers query outline viewMetas author viewDsn pgsql www data localhost cw3 viewAuth admin viewSavedRequest personalVarl personalVar2 viewLogErrors true viewUpgradeOutdated true viewHooksClassName FoobarViewHooks 104 Views Should you decide to use a database st
227. stry one on client and one on server This object allows to add table rules which will describes how tables must be displayed It is recommended to add rules in plugin s initialize method so they are ready at the earliest stage To obtain the registry object first you have to get the Tables plugin object On client public function initialize StablesPlugin this cartoclient getPluginManager tables Sregistry tablesPlugin gt getTableRulesRegistry 187 New Plugins Add rules here On server plugin manager is stored in ServerContext object V DES E StablesPlugin this serverContext getPluginManager tables P wes Now you are ready to add rules Next sections describe the different types of rules Registry s method signature is explained for each type Once rules have been added in registry they must be executed on tables See Section 2 4 3 4 Executing Rules for a description of table rules execution 2 4 3 2 1 Column Selector public function addColumnSelector groupId tableId columnIds Column selector rules allow to keep only a subset of columns from the source table Parameter co1umnIds should contain an array of column IDs determining which columns to keep 2 4 3 2 2 Column Unselector public function addColumnUnselector groupId StableId columnIds Column unselector rules allow to keep only a subset of columns from the source table by removing a list of c
228. sult lt complexType name LocationResult gt lt all gt lt element name className type xsd string gt lt element name bbox type types Bbox gt lt element name scale type xsd double gt Salt lt complexType gt e className LocationResult or extended class name if project implements an extension e bbox new bounding box see Section 1 1 2 Shapes for a description of type Bbox scale new scale 1 3 6 Query The Query plugin allows to search objects hilight them on map and return text results Search can be executed from a rectangle selection and or using a list of object IDs Query request object is not mandatory For more information about Query plugin see Chapter 9 Queries 1 3 6 1 Query Request lt simpleType name QuerySelectionPolicy gt lt restriction base xsd string gt lt enumeration value POLICY_XOR gt lt enumeration value POLICY_UNION gt lt enumeration value POLICY_INTERSECTION gt lt restriction gt lt simpleType gt POLICY XOR XOR selection when selecting a group of objects already selected ones are unselected and not yet selected ones are selected default type POLICY UNION union selection when selecting a group of objects already selected ones are kept selected and not yet selected ones are selected POLICY INTERSECTION intersection selection when selecting a group of objects only already selected ones are kept selected comple
229. t e y y coordinate Point e minx minimum x coordinate Bbox or Rectangle miny minimum y coordinate Bbox or Rectangle maxx maximum x coordinate Bbox or Rectangle e maxy maximum y coordinate Bbox or Rectangle points list of points Line or Polygon complexType name ArrayOfShape lt complexContent gt restriction base encll Array attribute ref encll arrayType wsdl arrayType types Shape restriction complexContent lt complexType gt array list of shapes 1 1 3 Tables These types define a table structure used in particular in Query plugin see 142 Calling Plugins Section 1 3 6 Query lt complexType name TableRow gt lt all gt lt element name rowId type xsd string gt lt element name cells type types ArrayOfString gt all lt complexType gt e rowld row ID cells cell contents see Section 1 1 1 Simple Types for a description of type ArrayOfString complexType name ArrayOfTableRow lt complexContent gt restriction base encll Array attribute ref encll arrayType wsdl arrayType types TableRow restriction complexContent lt complexType gt array list of rows lt complexType name Table gt lt all gt lt element name tableId type xsd string element name tableTitle type xsd string element name numRows type xsd integer element name totalRows typ
230. t lt enumeration value recenterLocationRequest gt lt restriction gt lt simpleType gt e bboxLocationRequest recenters on a bounding box e panLocationRequest moves horizontaly verticaly panning e zoomPointLocationRequest recenters on a point includes relative zoom and fixed scale e recenterLocationRequest recenters on mapfile IDs lt complexType name LocationConstraint gt lE TL lt element name maxBbox type types Bbox lt all gt lt complexType gt e maxBbox maximum bounding box If given parameters lead to a larger bounding box it will be cropped see Section 1 1 2 Shapes for a description of type Bbox lt complexType name LocationRequest gt lb element name className type xsd string element name locationType type types LocationType gt lt element name bboxLocationRequest type types BboxLocationRequest minOccurs 0 gt lt element name panLocationRequest type types PanLocationRequest minOccurs 0 gt lt element name zoomPointLocationRequest type types ZoomPointLocationRequest minOccurs 0 gt element name recenterLocationRequest type types RecenterLocationRequest minOccurs 0 gt element name locationConstraint type types LocationConstraint minOccurs 0 all complexType 155 Calling Plugins e className LocationRequest or extended class name if project implements an extension e locatio
231. t you need to gather the data by launching the cw3setup php with the fetch demo option On the other hand the demoPlugins project uses plugins that work with databases Consequently some databases settings and configuration are required We describe here how to install these databases and how to use cw3setup php 24 Installation Step by step guide l Install PostgreSQL with PostGIS support Prerequisite Postgresql gt 8 0 Note If you are on Debian you can have a look at Appendix A Mapserver Debian Installation Create a PostgreSQL database using the following command createdb demo plugins Integrate PostGIS functionalities in this database Typically you can type createlang plpgsql demo plugins psql d demo plugins f lwpostgis sql psql d demo plugins f spatial ref aus sol Note psql is a terminal based front end for PostgreSQL It enables you to type in queries interactively issue them to PostgreSQL and see the query results Don t forget to specify its location on your system to use it If the wpostgis sql and spatial ref sys sql files aren t in the current directory you have to specify their path Create tables used by the locate plugin to allow you to do a recenter on features by searching their names To do so you should export the free downloadable layers airport agglo district and town in PostgreSQL PostGIS tables by typing the following command shp2pgsql I aerofacp sh
232. t specified if not the input element id is used to which a d is added 76 Annotation and Redlining Example if the input element id is return color 12 the id of the div used to display the color will be return color 12 d 10 4 3 2 SymbolPicker When a symbol is selected the script will set the css property background image of a div in the template accordingly to the symbol picked The id of the div is based on the output element id if it specified if not the input element id is used to which a d is added Example if the input element id is return symbol 12 the id of the div used to display the symbol will be return symbol 12 d The SymbolPicker is used with CartoWeb outline plugin usually but it also can be used without the plugin 10 4 3 2 1 Within the Outline Plugin In CartoWeb server conf yourprojectname outline ini file defines a list of symbols to use For each kind of symbols you want to use pointSymbols circle square star anyothersymbol All these symbol names MUST BE defined in the sym file in server conf yourprojectname If you want to add language support for the symbol name add the following parameter in server conf yourprojectname outline ini pointSymbols labels symbolnamel symbolname2 anyothername These names will be used to translate into the chosen language using the gettext functionnality Add the corresponding translations in the server po file
233. tAttribute code dept smarty assign depChefLieu ucfirst strtolower S this getAttribute nom chf 1 return smarty fetch layerResult depLayer tpl This method allows people to build tooltips with results coming from several sources joined tables for example Tip Don t forget to load the plugin on client side client_conf client ini 23 3 3 Styling Here are some considerations on how to customize the tooltip appearance TODO 138 Developer Manual Part Ill Developer Manual As is implied by its name this part of the documentation is aimed at those who need to customize or extend CartoWeb for their specific needs 139 Calling Plugins 1 Calling Plugins This chapter describes the structure of SOAP calls to CartoWeb server methods in order to obtain cartographic data Warning Due to some CartoWeb evolutions please note that some parts of the current chapter may need some updates Global WSDL code can be found in file CARTOWEB HOME server cartoserver wsdl WSDL code specific to plugins are located in PLUGIN HOME common plugin name wsdl inc Interesting parts from these files are copied in the following sections Complete WSDL code dynamically generated for a map ID is accessible at the URL CARTOWEB URL cartoserver wsdl php mapId project name mapfile name SOAP method getMapInfo is used to retrieve server configuration information such as avail
234. tall it before apt get install locales Two scripts have been prepared to check if gettext is correctly installed on the 115 Internationalization system e scripts testgettext sh This will compile and run a small C program that will test xgettext and msgfmt e scripts testgettext php Given that gettext was correctly installed on the system this will test that gettext works in PHP Note These scripts need that locales have been correctly configured They were tested on GNU Linux with a Debian Sarge install 16 1 1 2 Win32 In order to have the language translation working correctly in Cartoweb with Gettext you need to have the languages you want to use installed in the nput Locales of Windows windows 2000 Control Panel Regional Options Input Locales windows XP Control Panel gt Regional and Language Options gt Details gt Settings 16 1 2 PO Templates Texts to be translated can be found in e Smarty templates using SmartyGettext http sourceforge net projects smarty gettext see Section 17 2 Internationalization Client plugins ini files for instance map sizes Server plugins ini files for instance scales labels e Mapfile s ini and map layers labels e Client and server PHP code see Section 5 1 Translations To generate PO templates you will need to launch scripts on server and on client Templates are generated in directory cartoweb home projects project nam
235. tart over again your templates customization using demoCW3 or test_main as a basis as these projects templates are AJAX ready We recommend that you diff your cartoclient tpl mainmap tpl and all redefined plugin templates with the upstream This is the best way to be up to date especially if you use the latest CVS version of CartoWeb Tip Also you can have a look at the templates patch http bugzilla maptools org attachment cgi id 126 amp action view 130 Geostatistics 22 Geostatistics 22 1 Introduction This chapter describes how to configure geostatistics functionnalities 22 2 General Behavior The Geostat plugin allows advanced cartographic representation based on attributes of geospatial data Currently there is only support for polygonal entities There will be support for ponctual symbol very soon Every vectorial formats supported by Mapserver may be use The client side of the plugin allow the specification of the mandatory and optional paramaters These parameters will be passed to the server side which will create the map layer and return some informations about the dataset 22 3 Server side Configuration 22 3 1 Mapfile Configuration On the server side the first configuration step is made within the mapfile The only requirement is a least on polygonal layer which expose at least one attribute You may consider an attribute as exposed if you can use it as CLASSITEM for this layer You must add o
236. tate mapInfo initialMapStates default layers polygon selected true mapInfo initialMapStates default layers point hidden true mapInfo initialMapStates map25 layers polygon selected true mapInfo initialMapStates map25 layers polygon unfolded true 4 4 Ini Files for Plugins Each plugin may have a configuration file associated with it It may be found in client conf OF server conf your project name directory depending which side needs to access the parameters They have the same name as the plugin and ends with ini extension For instance the layers plugin has a configuration file named layers ini 43 Configuration Files All plugins configuration files are described in the next sections of this chapter Every plugin that provides tools icons can be configured for 4 4 1 Ordering Tools Icons To modify the toolbar icons sequence update the tools weight values Icons with the lowest weights are placed first in the toolbar Parameters naming convention is to concatenate the weight prefix to the capitalized first lettered tool name as in weightDistance For two word tool names eg exemple tool each word has its first letter capitalized and the underscore is removed For instance exempleTool something Default weights value are e weightZoomIn 10 e weightZoomOut 11 e weightPan 12 e weightFullextent 14 e weightQueryByPoint 40 e weightQueryByBbox 41 e weightQueryByPolygon 42 e weightQue
237. tended functions This form is mainly used by developers see TODO link to developer s doc e queryLayers the comma separated list of layers which will appear in the extended selection form If this list is absent all msLayers appear in the form e returnAttributesActive if true the layers attributes can be requested If false only object IDs will be returned default false e defaultPolicy can be either POLICY XOR POLICY UNION POLICY INTERSECTION or POLICY REPLACE Defines how new selected objects are mixed with previous ones default POLICY XOR e defaultMaskmode if true selected objects are highlighted in mask mode default false See also Section 9 3 3 2 Mask Mode e defaultHilight if true objects are highlited default true 67 Queries e defaultAttributes if true the layers attributes are returned default true e defaultTable if true the results table is displayed default true e weightQueryByPoint integer which defines display order of the query by point tool icon in toolbar default 40 Negative weighted tools are disabled e weightQueryByBbox see weightQueryByPoint default 41 e weightQueryByPolygon see weightQueryByPoint default 42 e weightQueryByCircle see weightQueryByPoint default 43 9 1 2 Tables Configuration Tables plugin can be used by any plugin to manage transfer and display tables structure In basic CartoWeb installation only Query plugin uses this functionality
238. ter default is root 128 AJAX 21 AJAX 21 1 Introduction CartoWeb implements an AJAX layer enabling asynchronous update of the HTML GUI 21 1 1 Browser Compatibility Browser compatibility e Mozilla 1 74 e Firefox 1 0 74 e Internet Explorer 6 e Safari 1 3 24 Known browser incompatibility Opera e Internet Explorer 5 for Mac e Konqueror 21 2 Make Your Project AJAX Enabled To enable your project with AJAX it is recommended that you build your project based on demoCW3 or test main projects CartoWeb version 3 3 0 or higher A project based on demoCW3 won t need any tuning A project based on test main will require the following e Enable AJAX in your client ini or client ini in If you have a project running since version 3 2 0 or before and want to enable AJAX you ll need to e Enable AJAX in your client ini or client ini in e Adapt your cartoclient tpl mainmap tpl and all redefined plugin templates if they are based on test main or demoCW3 project templates from CartoWeb version 3 2 0 129 AJAX 21 2 1 Client ini Configuration Add the ajaxOn directive and set it to true in your project yourProjectName client conf client ini Of project yourProjectName client conf client ini in ajaxOn true 21 2 2 Templates Adaptation Warning Adapting your templates is a tricky bit Unless you customized your templates thoroughly we recommend that you s
239. ter Set Encoding Configuration Function Encoder encode must be used in the following situation onclient or server when reading a text from a configuration file SencodedText Encoder encode readText config Function Encoder decode must be used in the following situations onclient when outputing a text without calling 118n 9t 0 StextToDisplay Encoder decode encodedText onclient or server when calling an external module eg Mapserver for a query StextToUseInMapserver Encoder decode encodedText config 201 Internationalization Note that function 118n gt takes an encoded text as argument and already prepares texts for output It means you don t need to call Encoder decode after a call to 118n gt 202 Code Convention 6 Code Convention 6 1 Introduction As an Open Source software CartoWeb needs to be written following some coding guidelines and or rules It is the required condition unless the developpers community isn t able to share new features and enhancements Some of those advises may seem obvious others less For all it is principaly a good way to produce more readable maintainable and portable code 6 2 General Coding Rules 6 2 1 Paths It is highly recommended to be avoid absolute paths as much as possible CartoClient and CartoServer may be relocated with very minimal even none reconfiguration 6 2 2 Extract and
240. th 40 blocks logo height 7 blocks logo padding 2 blocks logo parent mainmap blocks logo horizontalBasis right blocks logo inFlow false blocks logo horizontalMargin 5 blocks logo verticalMargin 5 Tip If you want to switch the image file depending on the used language set the block i18n parameter to true and add languages matching URLs filepathes to your PO files 12 3 4 5 Table Blocks Tables blocks are used to represent tabular data such as query results A table is composed of a caption row title a headers row columns fields titles and one or more data rows All cells can only contain textual content The table block describes how data cells will be rendered font text color background color using the same parameters than for text blocks The table width will be computed according to the cells content with a upper limit materialized by the 98 PDF Export page or the parent block available extent If the max extent is reached line feeds will be added automatically to the cells contents The neignt parameter gives the height of a single lined row and not the total table height Note that if a table is too high to fit a page page breaks will automatically be added Caption and headers are described using separated blocks They are specified by filling the table block caption and neaders fields with the matching blocks ids Since they are not standalone there is no need to activ
241. the Pgdijkstra PostgreSQL extension apt get install pgdijkstra Some of the packages were inspired from http agrogeomatic educagri fr 233 Apache amp Mapserver Windows Manual Installation Appendix B Apache amp Mapserver Windows Manual Installation This page describes the step by step procedure to install Cartoweb3 on Windows using WAMP Mapscript and Cartoweb The following configuration was tested e Windows 2000 e WAMP 1 4 4 Apache 1 3 33 PHP 5 0 4 e Mapserver 4 5 e Cartoweb 3 0 0 and Cartoweb3 CVS version B 1 Apache PHP5 Install Cartoweb requires php5 MS4W only supports php4 3 so we will need WAMP 1 4 4 or greater You can get the installation package here http www wampserver com download php Launch the setup by clicking on the executable file you just downloaded here wamp5_1 4 4 exe Keep default install options Install WAMP in C wamp e Set www root folder as C wamp www Once installation is completed If WAMP didn t loaded automatically icon in the system tray in the lower right of the screen load it Stat menu Programs WampServer Start Wampserver Type http localhost in a browser e Once the page has loaded click on Tools gt phpinfo http localhost exemples phpinfo php to display the complete PHPINFO information e Take note of the path to the php ini file Configuration File php ini Path It should look like C wamp apache php ini e Open the fi
242. the double quotes around the content value that contains special characters such as Two behavior are offered to the visitor embedding the legend block in the map or printing it in a separated page First case is OK when there is little legend items to print block is limited to one column whereas the second possibility enables to display lots of legend items using several columns if needed In the map embedded case if the overview map is printed the legend block width will be automatically set to the overview width value For instance blocks legend type legend blocks legend zIndex 1 blocks legend weight 40 blocks legend fontSize 8 blocks legend height 5 blocks legend width 50 blocks legend padding 1 5 blocks legend verticalMargin 10 100 PDF Export blocks legend horizontalMargin 10 blocks legend content nix 12 3 4 7 North Arrow Block There is usually only one instance of north arrow block in a CartoWeb PDF document It displays an arrow or any image that will automatically show the north direction Path set in arrow block content parameter is relative to CartoWeb root directory For instance blocks north type north content plugins exportPdf htdocs gfx arrow png width 10 height 36 blocks nort blocks nort blocks nort blocks north padding 2 blocks north verticalBasis bottom blocks north horizontalBasis left blocks north inFlow false blocks north
243. to loadPlugins from Both CartoClient and CartoServer configuration files client conf client ini and server conf mapId mapId ini For instance loadPlugins layerReorder 6 7 2 Layer exclusion If you want to exclude some layers and then not allow them to be reordered have a look on client_conf layerReorder ini You will be able to exclude some layers and to choose to keep them on bottom or on top To do so use the following configuration parameters e topLayers list of all layerlds to keep on top of the genererated map Layerlds must be comma separated bottomLayers same as previous one but obviously keep these layerIds on bottom Useful for example with a raster background layer 6 7 3 Transparency selector 58 Layers You could also add a transparency selector on each layer displayed with this plugin End user will so be able to choose a different transparency level for each displayed layer To activate it set enableTransparency tO true in client conf layerReorder ini Default transparency selector values are 10 20 5096 75 and 100 You could also customize transparency values available in this selector with a comma separated value in transparencyLevels A transparency value is a integer between 1 to 100 with 100 mean an opaque layer as 1 mean a nearly invisible one 6 8 WMS Browser Plugin Ability to access map data using web services could be appreciated by end user For instance
244. tton and you should now see the France regions 238 Create a New Project C 5 Location Parameters Move the location ini file you will find in the sampleFiles folder into the Server conf your project name One This file defines some parameters such as scales or shortcuts For more details on how to configure those parameters see Chapter 7 Navigation Click on the reset session button in your browser page New elements should appear You should be able to choose a scale and a shortcut C 6 Your Own Data After that the next point is to add your own data You should just have to e get your data available by default in the data folder or somewhere else on your filesystem e modify the mapfile extent e modify the extent defined in the initialMapstates your project name ini e add layers definitions in the mapfile your project name map add layers definitions in the 1ayers ini e reset the session in the browser and get your data displayed C 7 Outline Let s see how to load a plugin Edit the c1ient ini infile client cont and add the outline plugin in the list of plugins to load loadPlugins outline Do the same in the your project name ini file on server side server conf your project name but also add the mapOverLay plugin mapInfo loadPlugins outline mapOverlay Move the outline ini file from sampleFiles to server conf your project name In the mapfile your project name map
245. txt blocks myText content file C mydir mysourcefile txt blocks myText content file home johndoe mysourcefile txt blocks myText content file www data mysourcefile txt 96 PDF Export If your source file contains several lines or n strings the generated block will also be multilined e db database source blocks myText content db DSN SQL query The DSN Data Source Name gives the database connection parameters Any DSN format supported by PEAR DB can be used See PEAR DB manual for more info about DSNs at http pear php net manual en package database db intro dsn php Note that you can call any database server type as long as it is supported by PEAR DB and that your PHP distribution has the matching extension enabled For security reasons only SELECT SQL queries are allowed but there is no other limitation On the other hand the query results are basically rendered using a new line for each result line and simply separating result elements with blank spaces For instance blocks myText content db pgsql user password localhost dbname select name phone number from phone book where area id 12 Tip It is possible to make some text blocks have their contents translated by setting their il8n parameter to true For instance blocks myTextBlock content This text will be translated blocks myTextBlock il8n true Translatable blocks are CartoWeb built in blocks copyright and date as well as
246. uests e ServerCall The plugin handles GET POST requests builds overrides server request and handles server result e Full The plugin s whole logic is executed Note that all enablement levels perform a Sessionable saveSession 12 3 Making Your Plugin Ajaxable An ajaxable plugin has the ability to refresh the CartoWeb GUI asynchronously if the project using it enables the AJAX mode see how to enable AJAX in a project Section 21 2 Make Your Project AJAX Enabled Please have a look at the wiki for an up to date howto explaining how to make a plugin ajaxable http www cartoweb org cwiki HowToAjaxablePlugin 232 Mapserver Debian Installation Appendix A Mapserver Debian Installation Some Debian packages are available for PHP 5 and MapServer A 1 Setting Up Your Repository and Preferences File Add the following to your etc apt sources list cartoweb deb http dev camptocamp com packages debian prod sarge main deb src http dev camptocamp com packages debian prod sarge main You may want to pin c2c packages higher than 1000 to have them preferred over the upstream ones even if downgrading Add in etc apt preferences Package Pin release o c2c te tee eyi LL A 2 Installing the Packages To install PHP MapScript and PHP 5 type the following apt get update apt get install php5 mapscript If you want to install PostGIS and PostgreSQL apt get install libpostgisl pg80 If you want to install
247. uggest that you select your route by starting from a town until an other town This is possible because for each object of a european towns layer we have identified the nearest object of the roads_europe_vertices table That is why in the demoRouting configuration there is a client side configuration Normally in the plugin routing client side only allows you to type an id of object from which to start and an other to finish the route No configuration is needed So if you use demoRouting extension you must specify client side the e postgresRoutingVerticesTable vertices table e stepName vertices table col containing informations you want to propose a choice on e dsn the connexion string to the database 3l Installation Anyway server side you must specify the routing table postgresRoutingTable option the routing layer in the mapfile postgresRoutingResultsLayer option the results routing table postgresRoutingResultsTable the connexion string to the database dsn option 1 2 5 2 demoEdit Extension Some useful tips are available in Section 14 3 How To 32 Structure 2 Structure 2 1 Introduction This chapter is an overall tour of the CartoWeb code structure It briefly explains the role of each directory When available links to relevant chapters of this documentation are also provided 2 2 Global Directory Structure After installation CartoWeb has the following directory st
248. uration Note If you are using the demo you need to have Gettext support installed as it uses Gettext by default If you are using Cygwin simply install the gettext devel package e SOAP optional if using direct mode only You need the SOAP module if you want to use CartoWeb as a Webservice or with separated CartoClient and CartoServer This is related to the cartoserverDirectAccess parameter described in Section 4 2 client ini 16 Installation Note If you are using Windows simply use the Windows Installer Section 1 1 2 CartoWeb Download If you absolutely want to install PHP manually see Appendix B Apache amp Mapserver Windows Manual Installation MapServer PHP MapScript from MapServer 4 4 see http www maptools org php_mapscript for more information and installation instructions Note If you are using Debian and you need to install MapServer you can have a look at Appendix A Mapserver Debian Installation Note If you are using Windows simply use the Windows Installer Section 1 1 2 CartoWeb Download If you absolutely want to install MapServer manually see Appendix B Apache amp Mapserver Windows Manual Installation PostgreSQL with PostGIS Support Optional If you want spatial database support in CartoWeb you will need to install PostGIS of the PostgreSQL database See http postgis refractions net for more information 1 1 2 CartoWeb Downloa
249. uration e loadPlugins list list of client plugins to load in addition to the core plugins Note that most client plugins also have a corresponding server plugin that must be loaded on the server side See Section 4 3 3 2 myMap ini Internationalization e l8nClass is now deprecated See Chapter 16 nternationalization for a description of the internationalization options and the corresponding configurations e default ang string default language possible values are the usual ISO locale codes en fr de e langList list list of usable languages Used to order and restrict the available languages In case you have many languages in directory lt cartoweb_home gt locale and do not want to use them all in your project you may use this parameter to specify a list of languages to use The order in which you input the languages codes will be used to display the languages links in the interface Example 4 1 langList usage langList it de fr The exemple above restricts the availablelanguages to it de and fr They will be displayed in that order in the interface languages list ToolPicker 41 Configuration Files e toolPickerOn truelfalse enable the ToolPicker dhtml See Section 10 4 The ToolPicker 4 3 Server Configuration Files 4 3 1 Introduction This page describes the configuration options of the CartoServer There is a global configuration file server ini directly in the server
250. uration File server ini 42 4 3 3 Map Configuration Files seeeeeeee 42 4 4 Ini Files for Plugins EE 43 4 4 1 Ordering Tools Icons eere 44 4 4 2 Grouping Tools Icons eene 44 4 5 Developer Specific Configuration esee 45 2 Cach s RETTEN 46 5 1 Smarty Cache saisi eB nor OM HIS RR eiceg 46 2 2 WSDE ache gaere dont teu ter cis ide Eb itum 46 5 3 MapInfo Cache siis ass e See RUNE AINS ERES NU SN ose ANTO PRO Aa 46 DA M pResult ET oit su rdi tee uti ete eae Roe a URN EUER 47 5 5 ME SOAP Cache iioii ginti aita 47 2 68 CACHES Configuration EE 47 5 6 T Rationale 5e cce oett tecti Pet bestie ooa tuas 47 5 6 2 Client and Server Cache Options sessssss 47 5 6 3 Server Cache Options 21 5 ti orate te isis A deeg 47 OUI TE 49 6 1 Introduction 2 aceite EE 49 6 2 Hierarchy of Layers and Rendering esses 49 6 2 1 Layers and LayerGroups a sccsscsdsatacessatesccecess scceadenaesdaes 49 6 2 2 Layers CEET 49 6 2 3 LayerGroups Options esee 50 62 4 EI EE 52 6 3 Metadata in Mapfile and layers ini sese 52 CartoWeb Documentation 6 3 1 Metadata in Mapfiles A 52 6 3 2 Metadata in layers ini sessseesseesseessesseessseesssressresseessee 53 6 3 3 Using the metadata fields in templates layers tpl 53 6 4 Layers Legends esc ete tette Sea ER
251. user 9 3 Related Elements in Mapfile 9 3 1 Making a Layer Queriable To make a MapServer layer queriable one have to add a TEMPLATE parameter in the mapfile layer definition In our case any value fits For instance LAYER NAME foobar LEMP GATE Ju E END 9 3 2 Meta Data Here are the meta data that can be set to mapfile s layers ow e id attribute string nameltype describes the attribute used for the id and the type of the id Type can be either int or string Caution case sensitive e query returned attributes attributel attribute2 the names space separated of the fields returned by a query If not set all fields are returned Caution case sensitive Example METADATA igcaettribuLe string eech query returned attributes FID FNAME END 9 3 3 Hilight Configuration Hilight plugin can be used by any plugin to hilight objects on the map In basic CartoWeb installation only Query plugin uses this functionality As Hilight plugin is not a core plugin it must be loaded in order to use it with queries 9 3 3 1 Normal Mode Hilight on a specific layer can be generated by several means special layer activation special class activation dynamic layer class generation Decision is made 69 Queries in the following order 1 looks for a layer named layer name hilight 2 if not found looks for a class named hilight in the current layer if not found dynamically creates
252. ust as other layers In this exemple an auto layer myAutoLayer_ was declared in the mapfile template see Section 6 6 2 Mapfile Templates layers layerl className LayerGroup layers layerl children layer2 myAutoLayer index1 layers layer2 className LayerGroup layers layer2 children myAutoLayer_index2 6 6 2 Mapfile Templates Mapfile templates for auto layers are PHP files The main template must be called mapId map php If this file exists then CartoWeb assumes that auto layers generation is used If the file does not exists CartoWeb looks for a standard maptid map The following functions are predefined and can be used in mapfile templates e printLayer name contents adds a new auto layer The name is the final name of the layer without the index suffix Contents include Mapserver layer definition with PHP code for parts that will be different for each instance of auto layer e printIndex adds the current auto layer index Must be used in auto layer contents e printName adds the current auto layer full name Must be used in auto layer contents e getIndex returns the current auto layer index It can be useful for instance in conditional statements Must be used in auto layer contents e includeFile path adds the content of another PHP mapfile template Here is an example MAP NAME MyMapfile ICT RC TRO 209 20 d php printLayer myAutoLayer lt lt lt AUTOLAYER This
253. values for all newly added cells Parameter newCo1umnids should contain the list of new column IDs Values of columns given in parameter inputColumnIds will be transfered to the callback method for cells content calculation Values for all rows are transfered at the same time Parameter ca11back should contain a pointer to a callback method with the following signature static function myCallbackMethod table id array WO e uergen i Techn dV Yelling di row dV a toolumi 2t gt Tya lue 2 row dL E array Neola a Ss Maneet bag I row 25 column 2 gt value 2 row 2 return array Q gt array new column 1 gt cell value 1 row Li new column 2 gt cell value 2 row 1 ILS EE new column 1 gt cell value 1l row 2 new column 2 gt cell value 2 row 2 See Section 2 4 3 2 9 ColumnAdder to know more about parameter columnPosition 2 4 3 2 11 Column reorder public function addColumnReorder groupId tableId columnIds Column reorder rule allow you to reorder the columns and their contents Parameter 191 New Plugins columnIds should contain an array of column IDs given the new column s order Note that all the IDs must appear in co1umnIds even they don t move 2 4 3 3 Precedence of Rules Depending on rule type rules are set for a group a table or a column Parameters groupid tableId or columnId can point to one object or to a group of object using wil
254. ver anonymous dev camptocamp com var lib cvs public update Warning This may have some serious effects on your existing developments it is recommended you backup the CartoWeb root folder and all subforders before execution 1 1 4 Windows Installation 1 1 4 1 Windows Install with Win32 Installer Recommended Download the WAMP installer at http www wampserver com Double click on the executable to launch it This will install Apache with PHPS5 Download the CartoWeb installer at http cartoweb org downloads html Double click on the executable to launch it This will install MapServer and CartoWeb Reboot Windows when prompted That s it Point your browser to http localhost cartoweb3 htdocs client php Aninstaller for the demo data is available as well Download it at http cartoweb org downloads html and double click on the executable to launch it This will only install the demo data CartoWeb must have been previously installed 21 Installation Warning Do not forget to restart your web server WAMP Services Restart Apache after installing CartoWeb Once it is installed you can modify CartoWeb setup with the command line script cw3setup php Section 1 1 3 Command Line Installation from either a DOS or a Cygwin prompt See Section 1 1 4 3 CartoWeb Setup for more info about how to use those interfaces 1 1 4 2 Windows Manual Install Instructions for Apache PHP and Map
255. w ExportOutput output setContents contents 184 New Plugins return output Final output headers content is done in method output For instance publie function osukpub 1 header Content Type text html print this getExport getContents O0 tens Bet d S 2 4 2 Filters Filter plugins can be used to modify parameters transfered from browser to CartoWeb client These parameters can be part of a POST request HTML forms or a GET request URL query string Once a new filter plugin has been developed it can be activated by adding it to the loadPlugins variable in file client_conf client ini 2 4 2 1 Interface and Classes Interface FilterProvider declares following methods e filterPostRequest FilterRequestModifier request modifies parameters transfered via a POST request e filterGetRequest FilterRequestModifier request modifies parameters p transfered via a GET request Class FilterRequestModifier is used to get old values from the request and set new ones It implements two main methods e getValue key retrieves old value e setValue key value sets new value 2 4 2 2 Available Parameters This is the list of parameters that can be set in a filter plugin using function setValue Images plugin o mapsize ID of the selected map size see Section 8 1 Client side Configuration e Location plugin 185 New Plugins recenter bbox new bounding box
256. words USERNAME is the name of the user for whom the password is set Passwords values are md5sums of the password To get this value you can type in a shell echo n mypassword md5sum Example users alice e3e4faee0cc7f c55ad402f517cdaf40 e roles USERNAME List of roles for each user USERNAME is replaced by the user for whom the roles are set Some roles have a special meaning see Section 15 2 2 Special Role Names It is possible to use two different location where user and password are stored There are two mechanisms built in in CartoWeb 1 ini file 2 database The parameter securityContainer controls which backend is used as described below with parameters specific to the database backend e securityContainer can be file for the file storage of users password or db for the dabase storage e dbSecurityDsn The database connection string to be used For instance pgsql user password localhost test e dbSecurityQueryUser The SQL query to perform to check a username password 111 Security Configuration pair is valid It should return a row if the pair is correct For instance SELECT FROM users WHERE username s AND password s e dbSecurityQueryRoles The SQL query used to retrieve roles for a given user It should return one column with all roles for the user each row For instance SELECT roles FROM users WHERE username s 15 2 2 Special
257. xType name QuerySelection lt ALL 159 Calling Plugins element name layerId type xsd string element name idAttribute type xsd string element name idType type xsd string lt element name selectedIds type types ArrayOfString element name useInQuery type xsd boolean element name policy type types QuerySelectionPolicy lt element name maskMode type xsd boolean element name hilight type xsd boolean element name tableFlags type types TableFlags all complexType layerld layer ID on which query will be executed idAttribute name of ID attribute id Type type of ID attribute string or int selectedIds list of IDs useInQuery if true will force query to use this layer policy type of selection maskMode if true will apply a mask instead of a simple selection This won t work when using MapServer s hilighting feature see Chapter 9 Queries hilight if false selection won t be hilighted on map e tableFlags table flags see Section 1 1 3 Tables for a description of type TableFlags lt complexType name ArrayOfQuerySelection gt lt complexContent gt restriction base encll Array attribute ref encll arrayType wsdl arrayType types QuerySelection restriction complexContent lt complexType gt array list of query selections lt complexType name QueryRequ
258. xport in an ExportOutput object 2 4 1 8 ExportConfiguration Export configuration objects contain information on what is needed by export plugin to generate output For instance for a CSV export no images are needed and it would be a waste of time to generate them Configuration is set in method getExport then passed to method getExportResult in order to get modified result Configuration is used by plugin to know how to modify request to retrieve useful data 2 4 1 4 Exportable Interface Exportable interface declares a method adjustExportMapRequest which modifies a standard map request to a special export request For instance plugin Image uses ExportConfiguration object to know if maps are needed by export plugin If not image request is modified 2 4 1 5 Example Plugin exportCsv is a good simple example of export plugin Configuration is filled in method get Configuration No images are required to output a CSV file protected function getConfiguration Sconfig new ExportConfiguration Sconfig gt setRenderMap false Sconfig gt setRenderKeymap false Sconfig gt setRenderScalebar false Result rendering is done in method getExport Note that no calls to methods get LastMapRequest Or adjustExportMapRequest are needed as those calls are handled by method getExportResult protected function getExport this getExportResult this getConfiguration Vi asa output ne
259. xport plugin see Chapter 12 PDF Export o hello test plugin o hilight hilight plugin see Section 9 3 3 Hilight Configuration o outline redlining and annotations see Chapter 10 Annotation and Redlining po PO templates files used for gettext translation system see Section 16 1 2 PO Templates projects CartoWeb user projects dir see Section 2 4 Projects scripts maintenance and administration scripts server CartoWeb server code files server_conf Cartoweb server side configuration files see Section 4 3 Server Configuration Files templates CartoWeb Smarty templates files see Chapter 17 Templating templates c smarty templates cached files tests CartoWeb unit tests suite mainly used for development and debug purposes www data writable and web accessible directories for generated files o icons Generated icons o images Mapserver images o mapinfo cache Client side server configuration cache see Section 5 6 Caches Configuration o mapresult cache Client requests and associated server results cache see Section 5 6 Caches Configuration o pdf Pdf generated cache files o Ssoapxml cache Client SOAP XML requests and associated server results cache see Section 5 6 Caches Configuration o wsdl cache Client side WSDL cache see Section 5 6 Caches Configuration 2 3 Plugins Modularity is a key feature of CartoWeb Its functionalities are packaged in logica
260. y one unit can be used in the whole configuration e general horizontalMargin float horizontal distance between the sheet border and the useful area in distUnit general verticalMargin float vertical distance between the sheet border and the useful area in distUnit e general allowedRoles comma separated list of strings list of roles allowed to print PDF documents e general importRemotePng boolean if true remote PNG files gathered using a URL are copied in a local directory before being included in the PDF document This option is recommended when using physically separated CartoClient and CartoServer See Chapter 4 Configuration Files e general extraFonts comma separated list of strings list of additional fonts to import in FPDF not available for other pdfEngines Each font contains the font family name the font style optional and the font PHP definition file optional separated by PHP definition files must be uploaded in FPDF fonts directory Parameters are described in FPDF AddFont documentation http fpdf org en doc addfont htm Definition files generation is explained here http fpdf org en tutorial tuto7 htm Example general extraFonts Comic I comici php MyFont BI myfontbi php MyOtherFont PHP built in default values e pdfEngine CwFpdf e pdfVersion 1 3 e distUnit mm e horizontalMargin 10 e verticalMargin 10 formats NULL e defaultFormat NULL e resolutions
261. yer Average income just to cite a few examples Now the basic purpose of any viewer is to make these data available to users by allowing navigation within a layer as well as comparison between layers A way to organize the layers is thus mandatory if an user friendly application is to be developed In CartoWeb the files that contain the configuration instructions for the layers are on the server side in the directory server_conf lt myMap gt Usually this directory is part of a project CartoWeb is based on the geographical engine Mapserver The Mapserver documentation http mapserver gis umn edu doc html http mapserver gis umn edu doc html is an integral part of the CartoWeb doc To be concise you have to know how to write a mapfile if you want to use CartoWeb So it doesn t come as a surprise that a mapfile myMap map is included in the lt myMap gt directory together with its annexes typically a symbol file myMap sym a directory etc for the required fonts the graphic file used as keymap background maybe also data files We ll see that some functionalities of CartoWeb require small changes of the mapfile content But most of the configuration is done in the file 1ayers ini The file myMap ini sets the required plugins and the initial state of the map Its content is described in Chapter 4 Configuration Files 6 2 Hierarchy of Layers and Rendering Contrary to Mapserver itself CartoWeb supports an arbitrarily complex hierarc
262. yerGroup id gt root label gt root children gt Array 0 gt swiss layer 1 1 gt swiss layer 2 minScale ll AV TVA cone maxScale icon gt link gt aggregate gt rendering gt metadata Array 0 gt foo bar 1 gt stdClass Object className Layer id gt swiss layer 1 label Swiss Layer 1 children gt Array 165 Calling Plugins minScale gt 0 maxScale gt 0 icon gt gfx icons swiss_project swiss icon_l png link gt metadata gt Array 2 gt stdClass Object className gt Layer id gt swiss_layer_2 label gt Swiss Layer 2 children gt Array minScale gt 1 maxScale gt 20 homi gt link gt metadata gt Array locationInit gt stdClass Object className gt LocationInit scales gt Array 0 gt stdClass Object label gt 1 50000 value gt 50000 1 gt stdClass Object masei 1 100000 value gt 100000 2 gt stdClass Object label gt 1 500000 value gt 500000 minScale gt 25000 maxScale gt 1000000 shortcuts gt Array 0 gt stdClass Object label gt Romandie bbox gt stdClass Object minx gt 475000 miny gt 65750 maxx gt 670000 maxy gt 212000 1 4 2 Getting a Map Using a Point and a Scale 166 Calling Plug
263. your own text blocks Some other CartoWeb built in blocks such as legend scaleval page or query results table blocks are translated anyway Note that you will have to explicitly add those entries to your Gettext PO files since there is no way for script client 2pot php to automatically detect them Tip The date text block is fully customizable You may specify the date format using PHP date formatting http php net date Both configurations are correct 97 PDF Export use to add the date string in complete sentence blocks date content Generated on Y m d H i by CartoWeb3 or if the date string is alone blocks date content Y m d H i If you want to have the date block translated set its i18n parameter to true and add the translated version including date format to your PO files 12 3 4 4 Image Blocks Image blocks are used to display the maps main overview the scalebar and other user defined pictures such as logos or diagrams Except for system image blocks maps scalebar the image file location must be specified in content using either an absolute URL or an absolute path within the server file system It is also possible to use a relative file path based on the CartoClient root directory eg htdocs g x layout c2c png width and heignt have to be set by the user For instance blocks logo type image blocks logo content http server gfx layout c2c png blocks logo wid
264. ype name LayersResult gt lt all gt lt element name className type xsd string gt lt falis lt complexType gt e className LayersResult or extended class name if project implements an extension 1 3 4 Layer Reorder The LayerReorder plugin handles layers reorder selection Its request object includes list of layerlds rightly ordered to be displayed on main map This plugin has no specific result object 1 3 4 1 Layer Reorder Request lt complexType name LayersRequest gt lt all gt lt element name className type xsd string gt lt element name layerIds type types ArrayOfLayerId all lt complexType gt e className LayerReorderRequest or extended class name if project implements an extension e Jayerlds list of layers to include in map generation rightly ordered from top to bottom see Section 1 1 1 Simple Types for a description of type ArrayOfLayerld 154 Calling Plugins 1 3 5 Location The Location plugin handles position and moves on the map Its request process includes different position methods such as recentering on a specific object or moves relative to previous position It returns the new bounding box and scale 1 3 5 1 Location Request lt simpleType name LocationType gt lt restriction base xsd string gt lt enumeration value bboxLocationRequest gt lt enumeration value panLocationRequest gt lt enumeration value zoomPointLocationRequest g

Download Pdf Manuals

Related Search

Related Contents

Vogel's PFS 3303  Detalles    INS RAM-90NP5B (SP)  LinkStation User Manual  研削面が透けて見える! 作業効率が大幅に向上します。  N_PianoSicurezzaCoordinamento.  DVL-919E  the Falcon Grande User Manual  KitchenAid KECD805E User's Manual  

Copyright © All rights reserved. Failed to retrieve file