Changeset 3110

Timestamp:

04/13/08 09:14:54 (3 months ago)

Author:

pmjones

Message:

Solar_Sql_Model

---

Several breaks of internal logic and technique, which should make the system
more flexible and powerful. These are mostly in response to the addition of
logic in the Solar_Sql_Model_Related classes.

In addition, you can now use eager has-many join tables in your select params
without having to write your own fetch methods to construct a special SELECT
object. Cf. upcoming changes in Solar_Model_Nodes and Solar_Model_Tags.

* [CHG] Method call() now gives fully-qualified names to the select columns;

e.g., instead of just "id", the select column is "model_name.id".

* [REF] In all fetch*() methods, standardized internal variable names to

$params, $select, and $result for easier comparison.

* [BRK] Removed support methods _fetchAll() and _fetchAssoc(). Now that the

relation objects carry more logic, and that $params is passed in full to
newSelect(), they're not needed. Wrapped their support logic back into their
"parent" methods fetchAll() and fetchAssoc() respectively.

* [FIX] Method _setCollectionPagerInfo() now correctly sets the 'end' value

(was off by 1 too many).

* [CHG] Method countPages() now honors all eager joins. (Thanks, Jeff Surgeson,

for noting that previously it did not honor the joins; that report was the
driving force behind all these other changes.)

* [CHG] Method fixSelectParams()...

• Now defaults DISTINCT to null instead of false, so that existing
  DISTINCT values are not modified unless specifically set to true or
  false.
  

• Now "uniques" the requested column names.
  
  
• Now "uniques" the requested eager joins.
  
  

* [BRK] Method newSelect() now takes the **entire** $params array, not just

the 'eager' key from that array. This affords a lot more consolidation of
logic, and gives more power and flexibility to the building process. The
method is now responsible for building the whole SELECT for fetch*() calls.

* [CHG] Method newSelect() now honors **all types of eager joins** (including

"has many" and "has many through", although columns from the has-many
relations still have to be fetched separately). It does so by using the
"modSelectEager()" method from the relation object. This means you can have
selection criteria based on any eager-join relation.

* [CHG] Method insert() now sets the primary-key of the record object, not just

the first auto-increment key. This will help support non-autoinc-based
primary keys, such as sequence-based keys.

Files:

• trunk/Solar/Sql/Model.php (modified) (16 diffs)

trunk/Solar/Sql/Model.php

@@ -616 +616 @@
-            $col = preg_replace('/([a-z])([A-Z])/', '$1_$2', $col);
-            $col = strtolower($col);
-
+{$this->_model_name}.
-        }
-        
@@ -699 +699 @@
-    public function fetchAll($params = array())
-    {
-setup
+prepare
-        $params = $this->fixSelectParams($params);
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
-            return array();
-        }
+        
+        // create a collection from the result
+        $coll = $this->newCollection($result);
+        
+        // add has-many eager data to the collection
+        foreach ((array) $params['eager'] as $name) {
+            $related = $this->getRelated($name);
+            if ($related->type == 'has_many') {
+                $result = $this->fetchRelatedArray($select, $name);
+                $coll->loadRelated($name, $result);
+            }
+        }
+        
+        // add pager-info to the collection
+        if ($params['count_pages']) {
+            $this->_setCollectionPagerInfo($coll, $params);
+        }
+        
+        // done
+        return $coll;
-    }
-    
@@ -797 +771 @@
-    public function fetchAssoc($params = array())
-    {
-setup
+prepare
-        $params = $this->fixSelectParams($params);
-
-
-
-
-
-
-
-
-
-
-
-
+
-        
-        // fetch
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
-            return array();
-        }
+        
+        // create a collection from the result
+        $coll = $this->newCollection($result);
+        
+        // add has-many eager data to the collection
+        foreach ((array) $params['eager'] as $name) {
+            $related = $this->getRelated($name);
+            if ($related->type == 'has_many') {
+                $result = $this->fetchRelatedArray($select, $name);
+                $coll->loadRelated($name, $result);
+            }
+        }
+        
+        // add pager-info to the collection
+        if ($params['count_pages']) {
+            $this->_setCollectionPagerInfo($coll, $params);
+        }
+        
+        // done
+        return $coll;
-    }
-    
@@ -870 +818 @@
-    {
-        $total = $this->countPages($params);
-begin = ($params['page'] - 1) * $params['paging'] + 1
+start = ($params['page'] - 1) * $params['paging']
-        $coll->setPagerInfo(array(
-            'count'  => $total['count'],
@@ -876 +824 @@
-            'paging' => $params['paging'],
-            'page'   => $params['page'],
-begin
-begin
+start + 1
+start
-        ));
-    }
@@ -917 +865 @@
-    public function fetchOne($params = array())
-    {
-setup
+prepare
-        $params = $this->fixSelectParams($params);
-
-
-
-
-
-
-
-
-
-
+
-        
-        // fetch
-data
-data
+result
+result
-            return null;
-        }
-        
-        // get the main record, which sets the belongs_to/has_one data
-data
+result
-        
-        // get related data from each eager has_many relationship
@@ -992 +931 @@
-    public function fetchCol($params = array())
-    {
-setup
+prepare
-        $params = $this->fixSelectParams($params);
-
-
-
-
-
-
-
-
-
-
-
-
+
-        
-        // fetch
-data
-data
-data
+result
+result
+result
-        } else {
-            return array();
@@ -1057 +985 @@
-    public function fetchPairs($params = array())
-    {
-setup
+prepare
-        $params = $this->fixSelectParams($params);
-
-
-
-
-
-
-
-
-
-
-
-
+
-        
-        // fetch
-data
-data
-data
+result
+result
+result
-        } else {
-            return array();
@@ -1122 +1039 @@
-    public function fetchValue($params = array())
-    {
-        // setup
-        $params = $this->fixSelectParams($params);
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-        return $select->fetchValue();
-    }
@@ -1202 +1104 @@
-    public function countPages($params = null)
-    {
+        // fix up the parameters
-        $params = $this->fixSelectParams($params);
-        
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-        $col = "{$this->_model_name}.{$this->_primary_col}";
-        
-        return $select->countPages($col);
-    }
@@ -1272 +1180 @@
-        
-        if (empty($params['distinct'])) {
-
-
-
+
+
+
+
+
+
+
+
+
-        if (empty($params['cols'])) {
-            $params['cols'] = array_keys($this->_table_cols);
-        }
-        
+        // if we have eager values, make sure they're unique
+        if (! empty($params['eager'])) {
+            $params['eager'] = array_unique((array) $params['eager']);
+        }
+        
+        // even after uniqing, the eager values might still be empty
-        if (empty($params['eager'])) {
-            $params['eager'] = null;
@@ -1323 +1243 @@
-     * injected automatically, and with eager "to-one" associations joined.
-     * 
-eager An array of to-one relationship names to eager-
-load with LEFT JOIN clauses
+params An array of SELECT parameters (esp. the 'eager'
+param)
-     * 
-     * @return Solar_Sql_Select
-     * 
-     */
-eager = null
+params
-    {
-        // get the select object
@@ -1337 +1257 @@
-        );
-        
-
-
-
-
+
+
-            $related = $this->getRelated($name);
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-        }
-        
@@ -1387 +1270 @@
-            );
-        }
+        
+        // all the other pieces
+        $select->distinct($params['distinct'])
+               ->from("{$this->_table_name} AS {$this->_model_name}", $params['cols'])
+               ->multiWhere($params['where'])
+               ->group($params['group'])
+               ->multiHaving($params['having'])
+               ->order($params['order'])
+               ->setPaging($params['paging'])
+               ->limitPage($params['page'])
+               ->bind($params['bind']);
-        
-        // done!
@@ -1647 +1541 @@
-        // no exception thrown, so it must have worked.
-        // if there was an autoincrement column, set its value in the data.
-        $id = $this->_sql->lastInsertId($this->_table_name, $key);
-        foreach ($this->_table_cols as $key => $val) {
-            if ($val['autoinc']) {
-                // set the value and leave the loop (should be only one)
-
-
-
-
+
-                break;
-            }
@@ -1661 +1551 @@
-        // refresh the table data in the record
-        if ($spec instanceof Solar_Sql_Model_Record) {
+            // set the primary column so refresh will work
+            $key = $this->_primary_col;
+            $spec->$key = $data[$key];
+            // now refresh it
-            $spec->refresh();
-            $spec->setStatus('inserted');