Changeset 1317

Timestamp:

11/27/11 12:00:43 (19 months ago)

Author:

vakopian

Message:

reviewed by alex. added unit tests. Fixes #79

Location:

framework/branches/2.0

Files:

• assets/_core/php/examples/includes/examples.inc.php (modified) (1 diff)
• assets/_core/php/examples/qcubed_query/qqselect.php (added)
• includes/qcubed/_core/codegen/templates/db_orm/class_gen/qcubed_query_methods.tpl (modified) (3 diffs)
• includes/qcubed/_core/framework/QQuery.class.php (modified) (25 diffs)
• includes/qcubed/_core/tests/qcubed-unit/BasicOrmTests.php (modified) (1 diff)
• includes/qcubed/_core/tests/qcubed-unit/ExpandAsArrayTests.php (modified) (1 diff)

framework/branches/2.0/assets/_core/php/examples/includes/examples.inc.php

@@ -51 +51 @@
                         self::AddCoreExampleFile($intIndex, '/qcubed_query/expandasarray.php * ExpandAsArray: Multiple related tables in one swift query');
                         self::AddCoreExampleFile($intIndex, '/qcubed_query/alias.php * SQL Aliases for QQuery');
+                        self::AddCoreExampleFile($intIndex, '/qcubed_query/qqselect.php * Picking database columns for QQuery');
                         self::AddCoreExampleFile($intIndex, '/qcubed_query/subsql.php * Custom SQL Subqueries for QQuery');
                         self::AddCoreExampleFile($intIndex, '/qcubed_query/intro.php * Performing Custom SQL Queries');

framework/branches/2.0/includes/qcubed/_core/codegen/templates/db_orm/class_gen/qcubed_query_methods.tpl

@@ -37 +37 @@
                         }
                         if ($blnAddAllFieldsToSelect) {
-                                <%= $objTable->ClassName %>::GetSelectFields($objQueryBuilder);
+                                <%= $objTable->ClassName %>::GetSelectFields($objQueryBuilder, null, QQuery::extractSelectClause($objOptionalClauses));
                         }
                         $objQueryBuilder->AddFromItem('<%= $objTable->Name %>');
@@ -215 +215 @@
                  * @param string $strPrefix optional prefix to add to the SELECT fields
                  */
-                public static function GetSelectFields(QQueryBuilder $objBuilder, $strPrefix = null) {
+                public static function GetSelectFields(QQueryBuilder $objBuilder, $strPrefix = null, QQSelect $objSelect = null) {
                         if ($strPrefix) {
                                 $strTableName = $strPrefix;
@@ -224 +224 @@
                         }
 
+            if ($objSelect) {
+<% foreach ($objTable->PrimaryKeyColumnArray as $objColumn) { %>
+                            $objBuilder->AddSelectItem($strTableName, '<%= $objColumn->Name %>', $strAliasPrefix . '<%= $objColumn->Name %>');
+<% } %>
+                $objSelect->AddSelectItems($objBuilder, $strTableName, $strAliasPrefix);
+            } else {
 <% foreach ($objTable->ColumnArray as $objColumn) { %>
-                        $objBuilder->AddSelectItem($strTableName, '<%= $objColumn->Name %>', $strAliasPrefix . '<%= $objColumn->Name %>');
+                            $objBuilder->AddSelectItem($strTableName, '<%= $objColumn->Name %>', $strAliasPrefix . '<%= $objColumn->Name %>');
 <% } %>
-                }
+            }
+                }

framework/branches/2.0/includes/qcubed/_core/framework/QQuery.class.php

@@ -82 +82 @@
                 }
 
-                abstract public function GetColumnAliasHelper(QQueryBuilder $objBuilder, $blnExpandSelection);
-                abstract public function GetColumnAlias(QQueryBuilder $objBuilder, $blnExpandSelection = false, QQCondition $objJoinCondition = null);
+                abstract public function GetColumnAliasHelper(QQueryBuilder $objBuilder, $blnExpandSelection, QQSelect $objSelect = null);
+                abstract public function GetColumnAlias(QQueryBuilder $objBuilder, $blnExpandSelection = false, QQCondition $objJoinCondition = null, QQSelect $objSelect = null);
         }
 
@@ -166 +166 @@
                 }
 
-                public function GetTable(QQueryBuilder $objBuilder, $blnExpandSelection = false, QQCondition $objJoinCondition = null) {
+                public function GetTable(QQueryBuilder $objBuilder, $blnExpandSelection = false, QQCondition $objJoinCondition = null, QQSelect $objSelect = null) {
                         // Make sure our Root Tables Match
                         if ($this->_RootTableName != $objBuilder->RootTableName)
@@ -177 +177 @@
                                 // Use the Helper to Iterate Through the Parent Chain and get the Parent Alias
                                 try {
-                                        $strParentAlias = $this->objParentNode->GetColumnAliasHelper($objBuilder, $blnExpandSelection);
+                                        $strParentAlias = $this->objParentNode->GetColumnAliasHelper($objBuilder, $blnExpandSelection, QQ::Select());
 
                                         if ($this->strTableName) {
@@ -185 +185 @@
 
                                                 if ($blnExpandSelection)
-                                                        call_user_func(array($this->strClassName, 'GetSelectFields'), $objBuilder, $strJoinTableAlias);
+                                                        call_user_func(array($this->strClassName, 'GetSelectFields'), $objBuilder, $strJoinTableAlias, $objSelect);
                                         }
                                 } catch (QCallerException $objExc) {
@@ -196 +196 @@
                 }
 
-                public function GetTableAlias(QQueryBuilder $objBuilder, $blnExpandSelection = false, QQCondition $objJoinCondition = null) {
-                        $strTable = $this->GetTable($objBuilder, $blnExpandSelection, $objJoinCondition);
+                public function GetTableAlias(QQueryBuilder $objBuilder, $blnExpandSelection = false, QQCondition $objJoinCondition = null, QQSelect $objSelect = null) {
+                        $strTable = $this->GetTable($objBuilder, $blnExpandSelection, $objJoinCondition, $objSelect);
                         return $objBuilder->GetTableAlias($strTable);
                 }
@@ -210 +210 @@
                 }
 
-                public function GetColumnAlias(QQueryBuilder $objBuilder, $blnExpandSelection = false, QQCondition $objJoinCondition = null) {
-                        $strTableAlias = $this->GetTableAlias($objBuilder, $blnExpandSelection, $objJoinCondition);
+                public function GetColumnAlias(QQueryBuilder $objBuilder, $blnExpandSelection = false, QQCondition $objJoinCondition = null, QQSelect $objSelect = null) {
+                        $strTableAlias = $this->GetTableAlias($objBuilder, $blnExpandSelection, $objJoinCondition, $objSelect);
                         // Pull the Begin and End Escape Identifiers from the Database Adapter
                         return $this->MakeColumnAlias($objBuilder, $strTableAlias);
@@ -221 +221 @@
                 }
 
-                public function GetColumnAliasHelper(QQueryBuilder $objBuilder, $blnExpandSelection) {
+                public function GetColumnAliasHelper(QQueryBuilder $objBuilder, $blnExpandSelection, QQSelect $objSelect = null) {
                         // Are we at the Parent Node?
                         if (is_null($this->objParentNode))
@@ -229 +229 @@
                                 try {
                                         // No -- First get the Parent Alias
-                                        $strParentAlias = $this->objParentNode->GetColumnAliasHelper($objBuilder, $blnExpandSelection);
+                                        $strParentAlias = $this->objParentNode->GetColumnAliasHelper($objBuilder, $blnExpandSelection, QQ::Select());
 
                                         $strJoinTableAlias = $strParentAlias . '__' . $this->strAlias;
@@ -241 +241 @@
                                 // Next, Expand the Selection Fields for this Table (if applicable)
                                 if ($blnExpandSelection) {
-                                        call_user_func(array($this->strClassName, 'GetSelectFields'), $objBuilder, $strJoinTableAlias);
+                                        call_user_func(array($this->strClassName, 'GetSelectFields'), $objBuilder, $strJoinTableAlias, $objSelect);
                                 }
 
@@ -372 +372 @@
                 }
 
-                public function GetColumnAlias(QQueryBuilder $objBuilder, $blnExpandSelection = false, QQCondition $objJoinCondition = null) {
-                        $this->GetTableAlias($objBuilder, $blnExpandSelection, $objJoinCondition);
+                public function GetColumnAlias(QQueryBuilder $objBuilder, $blnExpandSelection = false, QQCondition $objJoinCondition = null, QQSelect $objSelect = null) {
+                        $this->GetTableAlias($objBuilder, $blnExpandSelection, $objJoinCondition, $objSelect);
                         return null;
                 }
@@ -408 +408 @@
                 }
 
-                public function GetColumnAlias(QQueryBuilder $objBuilder, $blnExpandSelection = false, QQCondition $objJoinCondition = null) {
+                public function GetColumnAlias(QQueryBuilder $objBuilder, $blnExpandSelection = false, QQCondition $objJoinCondition = null, QQSelect $objSelect = null) {
                         // Make sure our Root Tables Match
                         if ($this->_RootTableName != $objBuilder->RootTableName)
@@ -424 +424 @@
                         else {
                                 // Use the Helper to Iterate Through the Parent Chain and get the Parent Alias
-                                $strParentAlias = $this->objParentNode->GetColumnAliasHelper($objBuilder, $blnExpandSelection);
+                                $strParentAlias = $this->objParentNode->GetColumnAliasHelper($objBuilder, $blnExpandSelection, QQ::Select());
 
                                 if ($this->strTableName) {
@@ -432 +432 @@
 
                                         if ($blnExpandSelection)
-                                                call_user_func(array($this->strClassName, 'GetSelectFields'), $objBuilder, $strParentAlias . '__' . $this->strName);
+                                                call_user_func(array($this->strClassName, 'GetSelectFields'), $objBuilder, $strParentAlias . '__' . $this->strName, $objSelect);
                                 }
 
@@ -442 +442 @@
                 }
                 
-                public function GetColumnAliasHelper(QQueryBuilder $objBuilder, $blnExpandSelection) {
+                public function GetColumnAliasHelper(QQueryBuilder $objBuilder, $blnExpandSelection, QQSelect $objSelect = null) {
                         // Are we at the Parent Node?
                         if (is_null($this->objParentNode))
@@ -449 +449 @@
                         else {
                                 // No -- First get the Parent Alias
-                                $strParentAlias = $this->objParentNode->GetColumnAliasHelper($objBuilder, $blnExpandSelection);
+                                $strParentAlias = $this->objParentNode->GetColumnAliasHelper($objBuilder, $blnExpandSelection, QQ::Select());
 
                                 // Next, Join the Appropriate Table
@@ -1070 +1070 @@
                 }
 
-                static public function Expand($objNode, QQCondition $objJoinCondition = null) {
+                static public function Expand($objNode, QQCondition $objJoinCondition = null, QQSelect $objSelect = null) {
 //                      if (gettype($objNode) == 'string')
 //                              return new QQExpandVirtualNode(new QQVirtualNode($objNode));
@@ -1077 +1077 @@
                                 return new QQExpandVirtualNode($objNode);
                         else
-                                return new QQExpand($objNode, $objJoinCondition);
-                }
-
-                static public function ExpandAsArray($objNode) {
-                        return new QQExpandAsArray($objNode);
+                                return new QQExpand($objNode, $objJoinCondition, $objSelect);
+                }
+
+                static public function ExpandAsArray($objNode, QQSelect $objSelect = null) {
+                        return new QQExpandAsArray($objNode, $objSelect);
+                }
+
+                static public function Select(/* array and/or parameterized list of QQNode objects*/) {
+                        return new QQSelect(func_get_args());
                 }
 
@@ -1090 +1094 @@
                 static public function Distinct() {
                         return new QQDistinct();
+                }
+
+                /**
+                 * @param QQClause[]|QQClause|null $objClauses QQClause object or array of QQClause objects
+                 * @return QQSelect QQSelect clause containing all the nodes from all the QQSelect clauses from $objClauses,
+                 * or null if $objClauses contains no QQSelect clauses
+                 */
+                public static function extractSelectClause($objClauses) {
+                        if ($objClauses instanceof QQSelect)
+                                return $objClauses;
+
+                        if (is_array($objClauses)) {
+                                $hasSelects = false;
+                                $objSelect = QQuery::Select();
+                                foreach ($objClauses as $objClause) {
+                                        if ($objClause instanceof QQSelect) {
+                                                $hasSelects = true;
+                                                $objSelect->Merge($objClause);
+                                        }
+                                }
+                                if (!$hasSelects)
+                                        return null;
+                                return $objSelect;
+                        }
+                        return null;
                 }
 
@@ -1167 +1196 @@
                         $this->strSql = $strSql;
                 }
-                public function GetColumnAlias(QQueryBuilder $objBuilder, $blnExpandSelection = false, QQCondition $objJoinCondition = null) {
+                public function GetColumnAlias(QQueryBuilder $objBuilder, $blnExpandSelection = false, QQCondition $objJoinCondition = null, QQSelect $objSelect = null) {
                         $strSql = $this->strSql;
                         for ($intIndex = 1; $intIndex < count($this->objParentQueryNodes); $intIndex++) {
@@ -1185 +1214 @@
                         $this->objSubQueryDefinition = $objSubQueryDefinition;
                 }
-                public function GetColumnAlias(QQueryBuilder $objBuilder, $blnExpandSelection = false, QQCondition $objJoinCondition = null) {
+                public function GetColumnAlias(QQueryBuilder $objBuilder, $blnExpandSelection = false, QQCondition $objJoinCondition = null, QQSelect $objSelect = null) {
                         if ($this->objSubQueryDefinition) {
                                 $objBuilder->SetVirtualNode($this->strName, $this->objSubQueryDefinition);
@@ -1377 +1406 @@
                 protected $objNode;
                 protected $objJoinCondition;
-
-                public function __construct($objNode, QQCondition $objJoinCondition = null) {
+                protected $objSelect;
+
+                public function __construct($objNode, QQCondition $objJoinCondition = null, QQSelect $objSelect  = null) {
                         // Check against root and table QQNodes
                         if ($objNode instanceof QQAssociationNode)
@@ -1389 +1419 @@
                         $this->objNode = $objNode;
                         $this->objJoinCondition = $objJoinCondition;
-                }
-                public function UpdateQueryBuilder(QQueryBuilder $objBuilder) {
-                        $this->objNode->GetColumnAlias($objBuilder, true, $this->objJoinCondition);
+                        $this->objSelect = $objSelect;
+                }
+                public function UpdateQueryBuilder(QQueryBuilder $objBuilder) {
+                        $this->objNode->GetColumnAlias($objBuilder, true, $this->objJoinCondition, $this->objSelect);
                 }
                 public function __toString() {
@@ -1453 +1484 @@
                 /** @var QQNode|QQAssociationNode */
                 protected $objNode;
-                public function __construct($objNode) {
+                protected $objSelect;
+                public function __construct($objNode, QQSelect $objSelect = null) {
                         // Ensure that this is an QQAssociationNode
                         if ((!($objNode instanceof QQAssociationNode)) && (!($objNode instanceof QQReverseReferenceNode)))
@@ -1459 +1491 @@
                                 
                         $this->objNode = $objNode;
+                        $this->objSelect = $objSelect;
                 }
                 public function UpdateQueryBuilder(QQueryBuilder $objBuilder) {
                         if ($this->objNode instanceof QQAssociationNode)
-                                $this->objNode->_ChildTableNode->GetColumnAlias($objBuilder, true);
+                                $this->objNode->_ChildTableNode->GetColumnAlias($objBuilder, true, null, $this->objSelect);
                         else
-                                $this->objNode->GetColumnAlias($objBuilder, true);
+                                $this->objNode->GetColumnAlias($objBuilder, true, null, $this->objSelect);
                         $objBuilder->AddExpandAsArrayNode($this->objNode);
                 }
@@ -1514 +1547 @@
                 public function __toString() {
                         return 'QQGroupBy Clause';
+                }
+        }
+
+        class QQSelect extends QQClause {
+                protected $arrNodeObj = array();
+
+                public function __construct($arrNodeObj) {
+                        $this->arrNodeObj = $arrNodeObj;
+                }
+
+                public function UpdateQueryBuilder(QQueryBuilder $objBuilder) {
+                }
+
+                public function AddSelectItems(QQueryBuilder $objBuilder, $strTableName, $strAliasPrefix) {
+                        foreach ($this->arrNodeObj as $objNode) {
+                                $objBuilder->AddSelectItem($strTableName, $objNode->_Name, $strAliasPrefix . $objNode->_Name);
+                        }
+                }
+
+                public function Merge(QQSelect $objSelect = null) {
+                        if ($objSelect) foreach ($objSelect->arrNodeObj as $objNode)
+                                array_push($this->arrNodeObj, $objNode);
+                }
+
+                public function __toString() {
+                        return 'QQSelectColumn Clause';
                 }
         }

framework/branches/2.0/includes/qcubed/_core/tests/qcubed-unit/BasicOrmTests.php

@@ -129 +129 @@
                 $this->assertEqual($targetPerson, null, "QuerySingle should return null for a not-found record");               
         }
+
+        public function testQuerySelectSubset() {
+                $objPersonArray = Person::LoadAll(QQ::Select(QQN::Person()->FirstName));
+                foreach ($objPersonArray as $objPerson) {
+                        $this->assertNull($objPerson->LastName, "LastName should be null, since it was not selected");
+                        $this->assertNotNull($objPerson->Id, "Id should not be null since it's always added to the select list");
+                }
+        }
 }
 ?>

framework/branches/2.0/includes/qcubed/_core/tests/qcubed-unit/ExpandAsArrayTests.php

@@ -60 +60 @@
                 $this->verifyObjectPropertyHelper($targetProject->_MilestoneArray, 'Name', 'Milestone H');
         }
+
+        public function testSelectSubsetInExpand() {
+                $objPersonArray = Person::QueryArray(
+                        QQ::OrCondition(
+                                QQ::Like(QQN::Person()->ProjectAsManager->Name, '%ACME%'),
+                                QQ::Like(QQN::Person()->ProjectAsManager->Name, '%HR%')
+                        ),
+                        // Let's expand on the Project, itself
+                        QQ::Clause(
+                                QQ::Select(QQN::Person()->LastName),
+                                QQ::Expand(QQN::Person()->ProjectAsManager, null, QQ::Select(QQN::Person()->ProjectAsManager->Spent)),
+                                QQ::OrderBy(QQN::Person()->LastName, QQN::Person()->FirstName)
+                        )
+                );
+
+                foreach ($objPersonArray as $objPerson) {
+                        $this->assertNull($objPerson->FirstName, "FirstName should be null, since it was not selected");
+                        $this->assertNotNull($objPerson->Id, "Id should not be null since it's always added to the select list");
+                        $this->assertNotNull($objPerson->_ProjectAsManager->Id, "ProjectAsManager->Id should not be null since id's are always added to the select list");
+                        $this->assertNull($objPerson->_ProjectAsManager->Name, "ProjectAsManager->Name should be null since it was not selected");
+                }
+        }
+
+        public function testSelectSubsetInExpandAsArray() {
+                $objPersonArray = Person::LoadAll(
+                        QQ::Clause(
+                                QQ::Select(QQN::Person()->FirstName),
+                                QQ::ExpandAsArray(QQN::Person()->Address, QQ::Select(QQN::Person()->Address->Street, QQN::Person()->Address->City)),
+                                QQ::ExpandAsArray(QQN::Person()->ProjectAsManager, QQ::Select(QQN::Person()->ProjectAsManager->StartDate)),
+                                QQ::ExpandAsArray(QQN::Person()->ProjectAsManager->Milestone, QQ::Select(QQN::Person()->ProjectAsManager->Milestone->Name))
+                        )
+                );
+
+                foreach ($objPersonArray as $objPerson) {
+                        $this->assertNull($objPerson->LastName, "LastName should be null, since it was not selected");
+                        $this->assertNotNull($objPerson->Id, "Id should not be null since it's always added to the select list");
+                        if (sizeof($objPerson->_AddressArray) > 0) {
+                                foreach ($objPerson->_AddressArray as $objAddress) {
+                                        $this->assertNotNull($objAddress->Id, "Address->Id should not be null since it's always added to the select list");
+                                        $this->assertNull($objAddress->PersonId, "Address->PersonId should be null, since it was not selected");
+                                }
+                        }
+                        if (sizeof($objPerson->_ProjectAsManagerArray) > 0) {
+                                foreach($objPerson->_ProjectAsManagerArray as $objProject) {
+                                        $this->assertNotNull($objProject->Id, "Project->Id should not be null since it's always added to the select list");
+                                        $this->assertNull($objProject->Name, "Project->Name should be null, since it was not selected");
+                                        if (sizeof($objProject->_MilestoneArray) > 0) {
+                                                foreach ($objProject->_MilestoneArray as $objMilestone) {
+                                                        $this->assertNotNull($objMilestone->Id, "Milestone->Id should not be null since it's always added to the select list");
+                                                        $this->assertNull($objMilestone->ProjectId, "Milestone->ProjectId should be null, since it was not selected");
+                                                }
+                                        }
+                                }
+                        }
+                }
+        }
 }
 ?>