Changes between Version 14 and Version 15 of DeveloperGuidelines/Tutorial/RESTCustomisation

Timestamp:

03/03/14 20:38:53 (11 years ago)

Author:

Dominic König

Comment:

--

DeveloperGuidelines/Tutorial/RESTCustomisation

@@ -56 +56 @@
 or:
 
-{{{
+{{{#!python
 class AvailableShelters(S3Method):
     """
@@ -157 +157 @@
 }}}
 
-Note that "read" permission for the requested record (pr_group 5) is already checked ''before'' the method handler is called, so it does not need to be checked again. 
-
-But for any other record we intend to return to the user, we must check permissions explicitly in the method handler.
-
-Note that you must request permission for ''every'' table that you intend to return information about.
-
-=== S3Method Subclasses as Method Handlers ===
-
-Method handlers can also be defined as subclass of S3Method:
-
-{{{
-class AvailableShelters(S3Method):
-    """
-        Method handler for the "available_shelters" method
-    """
-
-    def apply_method(self, r, **attr):
-        """
-            Entry point for the RESTful API
-
-            @param r: the S3Request
-            @param attr: additional keyword parameters passed from the controller
-        """
-
-        # do something to produce output
-
-        return output
-
-}}}
+Note that "read" permission for the ''requested'' record (pr_group 5) is already checked ''before'' the method handler is called, so it does not need to be checked again. But for any other record from which we return information to the user, or any other method we intend to perform, we must first check permissions in the method handler.
 
 === Configuring a Method Handler ===
 
-To configure a method handler for a resource, use the {{{set_method()}}} function in S3Model (current.s3db):
+Eventually, we need to tell the REST API which function/class to call for the ''available_shelters'' qualifier:
 
 {{{
@@ -202 +174 @@
                                   *s3_metafields())
 
-        # Configure a custom method (with S3Method subclass)
+        # Configure a custom method
         self.set_method("pr", "group", method="available_shelters", action=AvailableShelters)
 
         ...
 
-class AvailableShelters(S3Method):
-    """
-        Method handler for the "available_shelters" method
-    """
-
-    def apply_method(self, r, **attr):
-        """
-            Entry point for the RESTful API
-
-            @param r: the S3Request
-            @param attr: additional keyword parameters passed from the controller
-        """
-
-        # do something to produce output
-
-        return output
-
 }}}
 
-This can be done both in the model (like above, so it is available in all controllers), or in just the controller that needs it:
+This can be done both in the model (like above, so it is available in all controllers), or in just the controller that needs it.
 
-{{{
-def group():
-    """ RESTful Controller for pr/group """
-
-    # Configure the handler for pr/group/N/available_shelters
-    s3db.set_method("pr", "group", method="available_shelters", action=available_shelters_handler)
-
-    return s3_rest_controller()
-
-def available_shelters_handler(r, **attr):
-    """
-        Method handler for the "available_shelters" method
-
-        @param r: the S3Request
-        @param attr: additional keyword parameters passed from the controller
-    """
-
-    # do something to produce output
-
-    return output
-
-}}}
+Note that if the method handler is implemented as S3Method subclass, we do ''not'' need to instantiate it. It will be instantiated only when it is needed to process the request.