Changeset 1572

Timestamp:

21.02.2010 23:24:20 (5 months ago)

Author:

francois

Message:

[1.5] Added cache for getParent() (refs #854)

Location:

branches/1.5

Files:

• generator/lib/behavior/nestedset/NestedSetBehaviorObjectBuilderModifier.php (modified) (14 diffs)
• test/testsuite/generator/behavior/nestedset/NestedSetBehaviorObjectBuilderModifierTest.php (modified) (2 diffs)

branches/1.5/generator/lib/behavior/nestedset/NestedSetBehaviorObjectBuilderModifier.php

@@ -83 +83 @@
  * @var        null|PropelObjectCollection
  */
-protected \$nestedSetChildren = null;
+protected \$collNestedSetChildren = null;
+
+/**
+ * Internal cache for parent node
+ * @var        null|$objectClassname
+ */
+protected \$aNestedSetParent = null;
+
 ";
         }
@@ -112 +119 @@
         public function objectClearReferences($builder)
         {
-                return "\$this->clearNestedSetChildren();";
+                return "\$this->collNestedSetChildren = null;
+\$this->aNestedSetParent = null;";
         }
         
@@ -147 +155 @@
                 
                 $this->addHasParent($script);
+                $this->addSetParent($script);
                 $this->addGetParent($script);
                 
@@ -459 +468 @@
         }
 
+        protected function addSetParent(&$script)
+        {
+                $objectClassname = $this->objectClassname;
+                $script .= "
+/**
+ * Sets the cache for parent node of the current object.
+ * Warning: this does not move the current object in the tree.
+ * Use moveTofirstChildOf() or moveToLastChildOf() for that purpose
+ *
+ * @param      $objectClassname \$parent
+ * @return     $objectClassname The current object, for fluid interface
+ */
+public function setParent(\$parent = null)
+{
+        \$this->aNestedSetParent = \$parent;
+        return \$this;
+}
+";
+        }
+
+
         protected function addGetParent(&$script)
         {
                 $script .= "
 /**
- * Gets ancestor for the given node if it exists
+ * Gets parent node for the current object if it exists
  * The result is cached so further calls to the same method don't issue any queries
  *
@@ -471 +501 @@
 public function getParent(PropelPDO \$con = null)
 {
-        if(!\$this->hasParent()) {
-                return null;
-        } else {
-                return {$this->queryClassname}::create()
+        if (\$this->aNestedSetParent === null && \$this->hasParent()) {
+                \$this->aNestedSetParent = {$this->queryClassname}::create()
                         ->ancestorsOf(\$this)
                         ->orderByLevel(true)
-                        ->findOne();
-        }
+                        ->findOne(\$con);
+        }
+        return \$this->aNestedSetParent;
 }
 ";
@@ -591 +620 @@
                 $script .= "
 /**
- * Clears out the \$nestedSetChildren collection
+ * Clears out the \$collNestedSetChildren collection
  *
  * This does not modify the database; however, it will remove any associated objects, causing
@@ -600 +629 @@
 public function clearNestedSetChildren()
 {
-        \$this->nestedSetChildren = null;
+        \$this->collNestedSetChildren = null;
 }
 ";
@@ -609 +638 @@
                 $script .= "
 /**
- * Initializes the \$nestedSetChildren collection.
+ * Initializes the \$collNestedSetChildren collection.
  *
  * @return     void
@@ -615 +644 @@
 public function initNestedSetChildren()
 {
-        \$this->nestedSetChildren = new PropelObjectCollection();
-        \$this->nestedSetChildren->setModel('" . $this->builder->getNewStubObjectBuilder($this->table)->getClassname() . "');
+        \$this->collNestedSetChildren = new PropelObjectCollection();
+        \$this->collNestedSetChildren->setModel('" . $this->builder->getNewStubObjectBuilder($this->table)->getClassname() . "');
 }
 ";
@@ -627 +656 @@
                 $script .= "
 /**
- * Adds an element to the internal \$nestedSetChildren collection.
+ * Adds an element to the internal \$collNestedSetChildren collection.
  * Beware that this doesn't insert a node in the tree.
  * This method is only used to facilitate children hydration.
@@ -637 +666 @@
 public function addNestedSetChild($objectName)
 {
-        if (\$this->nestedSetChildren === null) {
+        if (\$this->collNestedSetChildren === null) {
                 \$this->initNestedSetChildren();
         }
-        if (!\$this->nestedSetChildren->contains($objectName)) { // only add it if the **same** object is not already associated
-                \$this->nestedSetChildren[]= $objectName;
-                // {$objectName}->setParent(\$this);
+        if (!\$this->collNestedSetChildren->contains($objectName)) { // only add it if the **same** object is not already associated
+                \$this->collNestedSetChildren[]= $objectName;
+                {$objectName}->setParent(\$this);
         }
 }
@@ -678 +707 @@
 public function getChildren(\$criteria = null, PropelPDO \$con = null)
 {
-        if(null === \$this->nestedSetChildren || null !== \$criteria) {
-                if (\$this->isLeaf() || (\$this->isNew() && null === \$this->nestedSetChildren)) {
+        if(null === \$this->collNestedSetChildren || null !== \$criteria) {
+                if (\$this->isLeaf() || (\$this->isNew() && null === \$this->collNestedSetChildren)) {
                         // return empty collection
                         \$this->initNestedSetChildren();
                 } else {
-                        \$nestedSetChildren = $queryClassname::create(null, \$criteria)
+                        \$collNestedSetChildren = $queryClassname::create(null, \$criteria)
                         ->childrenOf(\$this)
                         ->orderByBranch()
                                 ->find(\$con);
                         if (null !== \$criteria) {
-                                return \$nestedSetChildren;
+                                return \$collNestedSetChildren;
                         }
-                        \$this->nestedSetChildren = \$nestedSetChildren;
-                }
-        }
-        return \$this->nestedSetChildren;
+                        \$this->collNestedSetChildren = \$collNestedSetChildren;
+                }
+        }
+        return \$this->collNestedSetChildren;
 }
 ";
@@ -713 +742 @@
 public function countChildren(\$criteria = null, PropelPDO \$con = null)
 {
-        if(null === \$this->nestedSetChildren || null !== \$criteria) {
-                if (\$this->isLeaf() || (\$this->isNew() && null === \$this->nestedSetChildren)) {
+        if(null === \$this->collNestedSetChildren || null !== \$criteria) {
+                if (\$this->isLeaf() || (\$this->isNew() && null === \$this->collNestedSetChildren)) {
                         return 0;
                 } else {
@@ -722 +751 @@
                 }
         } else {
-                return count(\$this->nestedSetChildren);
+                return count(\$this->collNestedSetChildren);
         }
 }

branches/1.5/test/testsuite/generator/behavior/nestedset/NestedSetBehaviorObjectBuilderModifierTest.php

@@ -286 +286 @@
         }
 
+        public function testGetParentCache()
+        {
+                list($t1, $t2, $t3, $t4, $t5, $t6, $t7) = $this->initTree();
+                /* Tree used for tests
+                 t1
+                 |  \
+                 t2 t3
+                    |  \
+                    t4 t5
+                       |  \
+                       t6 t7
+                */
+                $con = Propel::getConnection();
+                $count = $con->getQueryCount();
+                $parent = $t5->getParent($con);
+                $parent = $t5->getParent($con);
+                $this->assertEquals($count + 1, $con->getQueryCount(), 'getParent() only issues a query once');
+                $this->assertEquals('t3', $parent->getTitle(), 'getParent() returns the parent Node');
+        }
+
         public function testHasPrevSibling()
         {
@@ -354 +374 @@
                 $this->assertEquals($t6->getNextSibling($this->con), $t7, 'getNextSibling() correctly retrieves next sibling');
                 $this->assertNull($t7->getNextSibling($this->con), 'getNextSibling() returns null for last siblings');
+        }
+        
+        public function testAddNestedSetChildren()
+        {
+                $t0 = new Table9();
+                $t1 = new Table9();
+                $t2 = new Table9();
+                $t0->addNestedSetChild($t1);
+                $t0->addNestedSetChild($t2);
+                $this->assertEquals(2, $t0->countChildren(), 'addNestedSetChild() adds the object to the internal children collection');
+                $this->assertEquals($t0, $t1->getParent(), 'addNestedSetChild() sets the object as th parent of the parameter');
+                $this->assertEquals($t0, $t2->getParent(), 'addNestedSetChild() sets the object as th parent of the parameter');
         }