Changes between Version 6 and Version 7 of S3REST

Timestamp:

03/01/10 01:14:23 (15 years ago)

Author:

Dominic König

Comment:

--

S3REST

@@ -10 +10 @@
 s3rest is an instance of the RESTController class, implemented in modules/s3rest.py.
 
+=== Method Handlers ===
+
+The default method handlers for each of CRUD+S are implemented in models/01_RESTlike_controller.py:
+
+  - shn_read(jr, **attr)
+  - shn_list(jr, **attr)
+  - shn_create(jr, **attr)
+  - shn_update(jr, **attr)
+  - shn_delete(jr, **attr)
+  - shn_search(jr, **attr)
+  - shn_options(jr, **attr)
+  - import_xml(jr, **attr)
+  - import_json(jr, **attr)
+
+where ''jr'' is the current ''XRequest'', and ''**attr'' contains all further arguments passed to the REST controller.
+
+You can override these defaults at any time by 
+{{{
+s3rest.set_handler(action, handler)
+}}
+where:
+
+  - '''action''' is the name of the action, i.e. one of 'read', 'list', 'create', 'update', 'delete', 'search', 'options', 'import_xml' or 'import_json'
+  - '''handler''' is the handler function/lambda
+
+=== Custom Methods ===
+
+You can also add resource-specific custom actions by:
+{{{
+  s3xrc.model.set_method(module, resource, method, action)
+}}}
+where:
+
+  - '''module''' is the module prefix of a resource
+  - '''resource''' is the name of the resource (without prefix)
+  - '''method''' is a string representing the name of the method (e.g. "search_simple")
+  - '''action''' is the method handler function/lambda
+
+The ''action'' method has to take the same arguments as the default handlers: ''jr'' (XRequest) and ''**attr''.
 == XRequest ==