Changes between Version 70 and Version 71 of AjaxList

Timestamp:

2010-09-08T19:22:16Z (14 years ago)

Author:

Serge Okon

Comment:

--

AjaxList

@@ -227 +227 @@
 ==== Join Table Filters ====
 
-Join Table Filters
+Join Table Filters are used to render a drop down menu, where the user can select from a list of item the specific category of items to display. For example, it is used in iPeer to allow instructors to select which courses to display students for. In this case, the $joinTable is:
+{{{
+#!php
+// Set up the course list for Ajax List
+$courseList = array();
+// Add in the unassigned course entry:
+$courseList{"!!!null"} = "-- Unassigned --";
+foreach ($userCourseList as $id => $course) {
+    $courseList{$id} = $course['course'];
+}
+
+// The course to list for is the extra filter in this case
+$joinTables =
+    array(
+        array(  // Define the GUI aspecs
+            "id"            => "course_id",
+            "description"   => "for Course:",
+            // What are the choises and the default values?
+            "list"  => $courseList,
+            "default" => $this->rdAuth->courseId,
+            // What table do we join to get these
+            "joinTable"     => "user_enrols",
+            "joinModel"     => "UserEnrol",
+            "foreignKey"    => "user_id",
+
+            // Any show/hide features based on maps
+            "dependsMap"    => "User.role",    // Look to this column
+            "dependsValues" => array("S")  // Display only when this column is one of these values
+        )
+    );
+
+}}}
+The above is a great example, because it shows all the features of the joinTables in one example.
+
 
 Join Table filters are created by passing a few extra fields for each table joined in the $joinTables array. 
 
-   array( "joinTable" => "table_name", // -- Same format as above
+{{{
+#!php
+$joinTables = 
+   array( "joinTable" => "table_name", // -- Same format as the last section
           "joinModel" => "JoinModel",  //   "       "
            "localKey" => "local_key",   //  "       "
           "foreignKey"=>"foreign_key", //   "       "
           "localModel" => "LocalModel", //  "       "
-
+}}}
 ==== Data Post Processing ====