Database updated with real data; some minor bug fixes.

Author: lex0r

Scaffolding.php

@@ -1826,26 +1826,23 @@ private function prepareList($select)
             }
 
             foreach ($this->fields as $columnName => $columnDetails) {
-
-                if (!empty($columnDetails['hide']) && ($columnDetails['hide'] === true
-                     || $columnDetails['hide'] == 'list')) {
-                     continue;
-                }
-
                 // Table fields have fully-qualified SQL name.
                 if (strpos($columnDetails['sqlName'], '.')) {
-                    list($table, $column) = explode('.', $columnDetails['sqlName']);
-                    // If alias exist or column not found by its SQL primary name, let's try alias.
-                    if (empty($item[$column]) && !empty($item[$columnName])) {
+                    // If alias exist let's try alias.
+                    // @todo: or column not found by its SQL primary name,
+                    if (!empty($item[$columnName])) {
                         $column = $columnName;
+                    } else {
+                        list($table, $column) = explode('.', $columnDetails['sqlName']);
                     }
                 }
                 // Computed fields have alias only.
                 else {
                     $column = $columnName;
                 }
 
-                $value  = $item[$column];
+                // null values may be returned.
+                $value  = !empty($item[$column]) ? $item[$column] : null;
 
                 // Call list view modifier for specific column if set
                 if (isset($columnDetails['listModifier'])) {
@@ -1858,7 +1855,6 @@ private function prepareList($select)
 
                 $row[$columnName] = $value;
             }
-
             // Fetch PK(s).
             if (!is_null($info)) {
                 $keys = array();

tests/application/controllers/ReadersController.php

@@ -3,32 +3,71 @@
 class ReadersController extends Zend_Controller_Scaffolding
 {
 
-    public function init()
-    {
+    public function init() {
+        parent::init();
+
         $fields = array(
             'name' => array(
-                'title'     => 'First & last name',
+                // The title of the column
+                'title'     => 'Name',
+                // We want to be able to search by the reader's name
                 'searchable'=> true,
+                // We want to be able to sort by name
+                'sortable'=> true,
+                // The field is first in the list.
+                'listOrder' => 1
             ),
             'category' => array(
+                // We don't want to show the ID in the list.
                 'hide'          => 'list',
+                // Instead we want to show it as relevant
+                // text field from a related table, defined as key of the next field.
+                // Note: 'Category' is the name of reference rule defined in
+                // current model class (Application_Model_Readers) inside _referenceMap variable.
                 'displayField'  => 'Category.name'
             ),
+            // The field from related table, that will replace meaningless ID.
             'Category.name' => array(
                 'title' => 'Category',
+                'listOrder' => 2,
+                'sortable' => true
+            ),
+            // A field from dependent table that we also want to show.
+            // Note: 'Reader' is the name of the reference rule in the dependent
+            // table's model, that points to the current model class,
+            // 'balance' is the field we want to show, that belongs to dependent
+            // table, NOT current table (i.e. not 'readers').
+            // Important: this field is not intended for changes from the application
+            // and is just for demo purposes.
+            'Reader.balance' => array(
+                'title' => 'Balance',
+                'listOrder' => 3
             ),
             'created' => array(
                 'searchable'=> true,
-                'fieldType'      => 'jsPicker',
-                'hide'      => 'edit'
+                // This field will be transmitted with other
+                // fields of type 'jsPicker' to loadDatePicker method.
+                // This allows to create a JS widget (calendar for date,
+                // but any other if needed).
+                'fieldType' => 'jsPicker',
+                // We don't want to allow edit of this field
+                'hide'      => 'edit',
+                'listOrder' => 5
             ),
             'updated' => array(
                 'hide'  => 'edit',
-                'listOrder' => 2
+                'listOrder' => 4
             ),
+            // This field definition makes sense only for edit form
+            // and allows to show list of assigned books through a
+            // many-to-many table readers_books.
+            // Note: 'Books' stands for the reference rule defined in the dependent table
+            // Application_Model_ReadersBooks that points to books table, while
+            // 'title' is the textual name of the related entity (book) that
+            // substitutes a meaningless ID.
             'Books.title' => array(
                 'title' => 'Assigned books',
-            )
+            ),
         );
 
         $this->scaffold(new Application_Model_Readers(), $fields, array('csrfProtected' => false, 'entityTitle' => 'reader', 'disabledActions' => array(self::ACTION_DELETE)));

tests/application/models/ReaderAccounts.php

@@ -0,0 +1,14 @@
+<?php
+class Application_Model_ReaderAccounts extends Zend_Db_Table {
+    protected $_name = 'reader_accounts';
+
+    // References the main table 'readers'
+    protected $_referenceMap    = array(
+        'Reader' => array(
+            'columns'           => 'reader_id', // foreign key column
+            'refTableClass'     => 'Application_Model_Readers',
+            'refColumns'        => 'id'
+        ),
+    );
+}
+?>

tests/application/models/Readers.php

@@ -2,6 +2,8 @@
 class Application_Model_Readers extends Zend_Db_Table {
     protected $_name = 'readers';
 
+    // These MUST be defined if you want to use data from
+    // related tables (especially for one-to-many relationships)
     protected $_referenceMap    = array(
         'Category' => array(
             'columns'           => 'category', // foreign key column
@@ -10,6 +12,11 @@ class Application_Model_Readers extends Zend_Db_Table {
         ),
     );
 
-    protected $_dependentTables = array('Application_Model_ReadersBooks');
+    protected $_dependentTables = array(
+        // This is a many-to-many table.
+        'Application_Model_ReadersBooks',
+        // And this is 1-1 table that fully depends on reader.
+        'Application_Model_ReaderAccounts'
+    );
 }
 ?>