Changes between Version 49 and Version 50 of DeveloperGuidelines/GIS

Timestamp:

09/18/13 12:10:34 (11 years ago)

Author:

Fran Boon

Comment:

Some updates to the 'Add New Layer Type' tutorial

DeveloperGuidelines/GIS

@@ -8 +8 @@
 == Guidelines for Developers wishing to make use of Mapping within their Module ==
 The easiest approach is to call the Mapping API.
+
 === Controller ===
 {{{
@@ -13 +14 @@
 return dict(map=map)
 }}}
+
 === View ===
 {{{
 {{=XML(map)}}
 }}}
+
 === Examples ===
 Check the following functions in {{{controllers/gis.py}}}:
@@ -154 +157 @@
 Assuming that !OpenLayers supports the layertype:
 ==== Model ====
-{{{models/03_gis.py}}}
+{{{modules/s3db/gis.py}}}
 {{{
 _gis_layer_types = ["newlayertype", "..."]
-table = db.define_table("gis_layer_newlayertype",
-                            name_field(),
-                            Field("description", label=T("Description")),
-                            Field("enabled", "boolean", default=True, label=T("Available in Viewer?")),
-                            Field("visible", "boolean", default=True,
-                                  label=T("On by default? (only applicable to Overlays)")),
-                            Field("url", label=T("Location"), requires = IS_NOT_EMPTY(),
-                                  comment=DIV( _class="tooltip",
-                                               _title="%s|%s" % (T("Location"),
-                                                                 T("The URL to access the service.")))),
-                            Field("version", length=32,
-                                  label=T("Version"), default="1.1.1",
-                                  requires=IS_IN_SET(["1.1.1", "1.3.0"], zero=None)),
-                            Field("base", "boolean", default=False,
-                                  label=T("Base Layer?")),
-                            Field("transparent", "boolean", default=True,
-                                  label=T("Transparent?")),
-                            gis_opacity(),
-                            role_required(),       # Single Role
-                            #roles_permitted(),    # Multiple Roles (needs implementing in modules/s3gis.py)
-                            *s3_timestamp())
+table = self.define_table("gis_layer_newlayertype",
+                          name_field(),
+                          Field("description", label=T("Description")),
+                          Field("enabled", "boolean", default=True, label=T("Available in Viewer?")),
+                          Field("visible", "boolean", default=True,
+                                label=T("On by default? (only applicable to Overlays)")),
+                          Field("url", label=T("Location"), requires = IS_NOT_EMPTY(),
+                                comment=DIV(_class="tooltip",
+                                            _title="%s|%s" % (T("Location"),
+                                                              T("The URL to access the service.")))),
+                          Field("version", length=32,
+                                label=T("Version"), default="1.1.1",
+                                requires=IS_IN_SET(["1.1.1", "1.3.0"], zero=None)),
+                          Field("base", "boolean", default=False,
+                                label=T("Base Layer?")),
+                          Field("transparent", "boolean", default=True,
+                                label=T("Transparent?")),
+                          gis_opacity(),
+                          role_required(),       # Single Role
+                          #roles_permitted(),    # Multiple Roles (needs implementing in modules/s3gis.py)
+                          *s3_timestamp())
 }}}
 
@@ -185 +188 @@
 def layer_newlayertype():
     """ RESTful CRUD controller """
-    if deployment_settings.get_security_map() and not shn_has_role("MapAdmin"):
+    if settings.get_security_map() and not s3_has_role("MapAdmin"):
         unauthorised()
 
     resourcename = request.function
     tablename = "%s_%s" % (module, resourcename)
-    table = db[tablename]
+    table = s3db[tablename]
 
     # Model options
@@ -219 +222 @@
 
     # Post-processor
-    def user_postp(jr, output):
-        shn_action_buttons(jr)
+    def postp(r, output):
+        s3_action_buttons(r)
         return output
-    response.s3.postp = user_postp
-
-    output = s3_rest_controller(module, resourcename)
+    response.s3.postp = postp
+
+    output = s3_rest_controller()
 
     if not "gis" in response.view:
@@ -237 +240 @@
 <li><a href='{{=URL(f="layer_newlayertype")}}'>New Layer Type</a> - Description</li>
 }}}
+
 ==== Module ====
 Classes need adding: