Changes between Version 8 and Version 9 of DeveloperGuidelines/Tutorial/RESTCustomisation

Timestamp:

06/11/10 21:24:40 (15 years ago)

Author:

Dominic König

Comment:

--

DeveloperGuidelines/Tutorial/RESTCustomisation

@@ -111 +111 @@
   - '''!http://site.myserver.org/eden/wm/warehouse/report.xml'''
 
-How to tackle this?
-
-Yes - you can use shn_rest_controller for this!
-
-This could be your "warehouse" controller:
+How to tackle this? Yes - you can use shn_rest_controller for this!
+
+This could be your "warehouse" CRUD controller:
 
 {{{
 def warehouse():
+
    """ RESTful CRUD controller """
+
    return shn_rest_controller(module, resource, ...)
 }}}
@@ -127 +127 @@
 {{{
 def warehouse():
-    """ RESTful CRUD controller """
+
+    """ RESTful CRUD+Reports controller """
+
+    # Plug warehouse_report into warehouse resource:
     s3xrc.model.set_method(module, resource, method="report", action=warehouse_report)
+
     return shn_rest_controller(module, resource, ...)
 
 def warehouse_report(jr, **attr):
-    """" Warehouse report """
-    <Code to produce the report>
+
+    """ Warehouse report generator """
+
+    # Code to produce the report goes here
+    report = ...
+
     return report
 }}}
@@ -142 +150 @@
 {{{
 def warehouse_report(jr, **attr):
-    """" Warehouse report """
-    <Code to produce the report>
-    # Assemble the report as dict:
-    report = dict(title="Page Title", ...)
+
+    """ Warehouse report generator """
+
+    # Code to produce the report items:
+    title = T("Warehouse Report")
+
+    # Assemble the report items in a dict:
+    report = dict(title=title, ...)
     return report
 }}}
@@ -157 +169 @@
 {{{
 def warehouse_report(jr, **attr):
-    """" Warehouse report """
+
+    """ Warehouse report generator """
+
     if jr.representation in ("html", "popup"):
-        <Code to produce the interactive report>
-        # Assemble the report as dict:
-        report = dict(title="Page Title", ...)
+        # Code to produce the report items:
+        title = T("Warehouse Report")
+
+        # Assemble the report items in a dict:
+        report = dict(title=title, ...)
+
     elif jr.representation == "xls":
-        <Code to produce the XLS report>
+        # Code to produce the XLS report goes here
+        ...
+
     elif jr.representation in shn_xml_export_formats:
-        <Code to produce the XML report>
+        # Code to produce the XML report goes here
+        ...
+
     else:
         session.error = BADFORMAT
         redirect(URL(r=jr.request))
+
     return report
 }}}
@@ -180 +202 @@
     ...
     elif jr.representation in shn_xml_export_formats:
-        return export_xml(xrequest)
+        report = export_xml(xrequest)
     ...
 }}}
@@ -190 +212 @@
     ...
     elif jr.representation == "rss":
-        <Code to produce the RSS report>
-        return report
+        # Code to produce the RSS report goes here
+        report = ...
     ...
 }}}