Changes between Version 24 and Version 25 of DeveloperGuidelines/DataTables

Timestamp:

09/05/12 15:58:09 (12 years ago)

Author:

Fran Boon

Comment:

T, no current. in controllers and typo fix

DeveloperGuidelines/DataTables

@@ -46 +46 @@
                                  )
         else:
-            warehouses = "No warehouses exist"
+            warehouses = T("No warehouses exist")
    }}}
 }}}
-This code gets the rows from the resource and passes the data into the S3DataTable html() function the extra parameter of note is the dt_pagination which when set to 'false' will turn server side pagination off. All the data will be sent to the client and !DataTables will manage the filtering a sorting itself.
+This code gets the rows from the resource and passes the data into the S3DataTable html() function. The extra parameter of note is the dt_pagination which when set to 'false' will turn server side pagination off. All the data will be sent to the client and !DataTables will manage the filtering and sorting itself.
 
 The next stage is to build a controller that can manage pagination. To do this the controller will need to additionally manage requests from !DataTables for more data.  This can be set up as follows:
@@ -73 +73 @@
         # Get the filter and sort instructions from dataTables
         rfields = resource.resolve_selectors(list_fields)[0]
-        (orderby, filter) = S3DataTable.getControlData(rfields, current.request.vars)
+        (orderby, filter) = S3DataTable.getControlData(rfields, request.vars)
         # Now set up the resource filter and find out how many row are in the filtered resource
         resource.add_filter(filter)
@@ -105 +105 @@
                 return warehouse
         else:
-            warehouses = "No warehouses exist"
+            warehouses = T("No warehouses exist")
    }}}
 }}}
 Now the controller needs to manage the two standard request extensions for dataTables: html which is used for the initial table; and aaData which is used for subsequent calls. When the data is prepared for the dataTable it needs to know the total rows in the table and the number of rows that are available after filtering, the filter information is returned from dataTables and the static helper method S3DataTable.getControlData will return the filter and sort information which the user has set up. The json method requires an extra parameter the sEcho which it passes to the server itself. This value just needs to be returned back to the client. '''Note''' that the html call now no longer requires the dt_pagination parameter.
+
 == Configuring the table ==
 === Adding action buttons ===
@@ -132 +133 @@
                        ]
         rfields = resource.resolve_selectors(list_fields)[0]
-        (orderby, filter) = S3DataTable.getControlData(rfields, current.request.vars)
+        (orderby, filter) = S3DataTable.getControlData(rfields, request.vars)
         resource.add_filter(filter)
         filteredrows = resource.count()
@@ -168 +169 @@
                 return warehouse
         else:
-            warehouses = "No warehouses exist"
+            warehouses = T("No warehouses exist")
    }}}
 }}}