HandleStartUpWmsParams

From MapbenderWiki

User:Verena Diewald (Module maintainer)

<version, for example Mapbender >= 2.7>

Contents 1 API 2 english 2.1 user story 2.2 usage 3 deutsch 3.1 Funktionsumfang 3.2 Gebrauchsanweisung 4 SQL

API

technical documentation

english

user story

This element can be used to send layer parameters for control of layer visibility and queryability to a Mapbender application in the start up URL. Mapbender handles these URL parameters and sets visibility and queryability of the given layers.

usage

The following params can be used in the Mapbender start up URL:

• visiblelayers: a comma seperated list with all layer names that should be visible
• querylayers: a comma seperated list with all layer names that should be queryable
• disablelayers: a comma seperated list with all layer names that should be disable
• disablequerylayers: a comma seperated list with all layer names where queryable should be disable

regular expressions:

• visiblelayers_regexpr: a regular expression that match all layer names that should be visible
• querylayers_regexpr: a regular expression that match all layer names that should be queryable
• disablelayers_regexpr: a regular expression that match all layer names that should be disable
• disablequerylayers_regexpr: a regular expression that match all layer names where queryable should be disable

Example URL:

http://localhost/mapbender/frames/login.php?name=mb_user&password=mb_user_pw&mb_user_myGui=gui_name&visiblelayers=layer1,layer3&querylayers=layer2,layer4
http://localhost/mapbender/frames/login.php?name=mb_user&password=mb_user_pw&mb_user_myGui=gui_name&visiblelayers_regexpr=layer.&querylayers_regexpr=layer.

Examples for regular expressions:

* Mapbe.  - layername starts with the letters Mapbe
* bender$ - layername end with the letters bender
* Strassen|Fluesse - layername is Strassen or Fluesse

deutsch

Funktionsumfang

Dieses Element ermöglicht die Steuerung der Layer-Sichtbarkeit und Abfragbarkeit über Übergabeparameter in der Mapbender-Aufruf-URL. Mapbender liest diese Parameter aus und setzt entsprechend die Sichtbarkeit und Abfragbarkeit der Layer in der Applikation

Gebrauchsanweisung

Folgende Parameter können an die Mapbender-Aufruf-URL angehängt werden:

• visiblelayers: eine komma-separierte Liste mit allen Layernamen, die sichtbar geschaltet werden sollen
• querylayers: eine komma-separierte Liste mit allen Layernamen, die abfragbar geschaltet werden sollen
• disablelayers
• disablequerylayers

Reguläre Ausdrücke

• visiblelayers_regexpr: ein regulärer Ausdruck, der auf alle Layernamen passt, die sichtbar geschaltet werden sollen
• querylayers_regexpr: ein regulärer Ausdruck, der auf alle Layernamen passt, die abfragbar geschaltet werden sollen
• disablelayers_regexpr
• disablequerylayers_regexpr

Beispiel-Aufruf:

http://localhost/mapbender/frames/login.php?name=mb_user&password=mb_user_pw&mb_user_myGui=gui_name&visiblelayers=layer1,layer3&querylayers=layer2,layer4
http://localhost/mapbender/frames/login.php?name=mb_user&password=mb_user_pw&mb_user_myGui=gui_name&visiblelayers_regexpr=layer.&querylayers_regexpr=layer.

SQL

Use this sql statement to insert this module in the corresponding gui / Mit diesem SQL kann das Modul in die entsprechende GUI eingefügen werden:

INSERT INTO gui_element(fkey_gui_id, e_id, e_pos, e_public, e_comment, e_title, e_element, e_src, e_attributes, e_left, e_top, e_width, e_height, e_z_index, e_more_styles, e_content, e_closetag, e_js_file, e_mb_mod, e_target, e_requires, e_url) VALUES('<appId>','handleStartUpWmsParams', 2,1,'handle wms params given in startup URL','handleStartUpWmsParams','div','','',1,1,2,2,5,'','', 'div','../plugins/mb_handleStartUpWmsParams.php','', 'mapframe1','','http://www.mapbender.org/index.php/HandleStartUpWmsParams'); INSERT INTO gui_element_vars(fkey_gui_id, fkey_e_id, var_name, var_value, context, var_type) VALUES('<appId>', 'handleStartUpWmsParams', 'errormessages', 'log', 'log or alert if layer are not present, default is log' ,'var');