Changeset 11031

Timestamp:

08/21/08 23:56:53 (3 months ago)

Author:

francois

Message:

DbFinderPlugin Implemented sfDoctrineFinder::join()

Files:

• plugins/DbFinderPlugin/README (modified) (1 diff)
• plugins/DbFinderPlugin/lib/sfDoctrineFinder.php (modified) (16 diffs)
• plugins/DbFinderPlugin/lib/sfModelFinder.php (modified) (1 diff)
• plugins/DbFinderPlugin/lib/sfPropelFinder.php (modified) (1 diff)
• plugins/DbFinderPlugin/test/unit/sfDoctrineFinderInternalsTest.php (modified) (1 diff)
• plugins/DbFinderPlugin/test/unit/sfDoctrineFinderRelationsTest.php (modified) (2 diffs)
• plugins/DbFinderPlugin/test/unit/sfDoctrineFinderTest.php (modified) (1 diff)
• plugins/DbFinderPlugin/test/unit/sfPropelFinderRelationsTest.php (modified) (2 diffs)
• plugins/DbFinderPlugin/test/unit/sfPropelFinderTest.php (modified) (1 diff)

plugins/DbFinderPlugin/README

@@ -573 +573 @@
----------
-
-
-
+
+
+
-* francois: Added `getQueryObject()` to the list of default methods
-
+Finder
-* francois: Moved magic `__call()` to the parent `sfModelFinder` class
-* francois: Implemented `sfDoctrineFinder::relatedTo()` (and fixed a bug in the `sfPropelFinder::relatedTo()` implementation)

plugins/DbFinderPlugin/lib/sfDoctrineFinder.php

@@ -41 +41 @@
-  public function setClass($class, $alias = '')
-  {
-
+
+
+
+
-    $this->class = $class;
-    $this->alias = $alias;
@@ -70 +73 @@
-  }
-  
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
-    if($this->queryPattern)
-    {
@@ -94 +101 @@
-  public function getQueryObject()
-  {
-get
+build
-  }
-  
@@ -135 +142 @@
-   * @param mixed $connection Optional connection object
-   *
-Propel
+Doctrine
-   * @throws Exception If the data is neither a classname nor an array
-   */
@@ -148 +155 @@
-      return self::fromCollection($from);
-    }
-Propel
+Doctrine
-  }
-  
@@ -157 +164 @@
-   * @param string $class Model classname on which the search will be done
-   *
-Propel
+Doctrine
-   */
-  public static function fromArray($array, $class, $pkName)
@@ -332 +339 @@
-  public function count($distinct = false)
-  {
-get
+build
-    $this->cleanup();
-    
@@ -351 +358 @@
-      $this->query->limit($limit);
-    }
-get
+build
-    $this->cleanup();
-    
@@ -511 +518 @@
-    if($forceIndividualDeletes)
-    {
-get
+build
-      $nbDeleted = 0;
-      foreach($objects as $object)
@@ -521 +528 @@
-    else
-    {
-get
+build
-      {
-        // Empty queries don't return the number of deleted rows
@@ -571 +578 @@
-  protected function cleanup()
-  {
+    // Re-enabling the the subquery algorithm.
+    $this->object->getTable()->setAttribute(Doctrine::ATTR_QUERY_LIMIT, Doctrine::LIMIT_RECORDS);
+    
-    if($this->reinit)
-    {
@@ -1021 +1031 @@
-      case 3:
-        // $articleFinder->join('Article.CategoryId', 'Category.Id', 'RIGHT JOIN')
+        // This is mostly for compatibility with Propel
+        $relation = $this->findRelationFromColumns($args[0], $args[1]);
-        $operator = trim(str_replace('join', '', strtolower($args[2])));
+        $relatedClass = $relation->getTable()->getClassnameToReturn();
+        $alias = '';
-        break;
-    }
-    $method = $operator . 'Join';
-    $startClass = $this->getAlias($relation->offsetGet('localTable')->getClassnameToReturn());
-
-
-
+
+
+
+
+
+
-    }
-    else
-    {
-
+
+
-    }
-    
@@ -1101 +1119 @@
-  }
-  
+  public function findRelationFromColumns($col1, $col2)
+  {
+    list($leftClass, $leftColumn, $leftAlias) = $this->getColName($col1, $class = null, $detail = true, $autoAddJoin = false);
+    list($rightClass, $rightColumn, $rightAlias) = $this->getColName($col2, $class = null, $detail = true, $autoAddJoin = false);
+    
+    foreach($this->relatedTables as $table)
+    {
+      foreach ($table->getRelations() as $key => $relation)
+      {
+        if ($relation->getClass() == $rightClass && $relation->getForeign() == $rightColumn && 
+            $relation->offsetGet('localTable')->getClassnameToReturn() == $leftClass && $relation->getLocal() == $leftColumn)
+        {
+          $this->relatedTables[]= Doctrine::getTable($rightClass);
+          $this->relations[$rightClass] = $relation;
+          
+          return $relation;
+        }
+        if ($relation->getClass() == $leftClass && $relation->getForeign() == $leftColumn && 
+            $relation->offsetGet('localTable')->getClassnameToReturn() == $rightClass && $relation->getLocal() == $rightColumn)
+        {
+          $this->relatedTables[]= Doctrine::getTable($leftClass);
+          $this->relations[$leftClass] = $relation;
+          
+          return $relation;
+        }
+
+      }
+    }
+    
+    throw new Exception(sprintf('Cannot determine relation between %s and %s', $col1, $col2));
+  }
+  
-  /**
-   * Behavior-like supplementary getter for supplementary columns added by way of withColumn()
@@ -1146 +1196 @@
-  }
-  
-
+detail = false, $
-  {
-    if(strpos($phpName, '.') !== false)
@@ -1165 +1215 @@
-      if(!$class)
-      {
-        // TODO: guess class
-        $class = $this->getClass();
-      }
@@ -1189 +1238 @@
-    }
-    
-
+
+
+
+
+
+
+
+
+
+
+
+
-  }
-}

plugins/DbFinderPlugin/lib/sfModelFinder.php

@@ -218 +218 @@
-  {
-    // If the connection is a PDO instance, PHP throws an exception when serializing a finder object
-
+a
-    $attributes = get_object_vars($this);
-    unset($attributes['connection']);

plugins/DbFinderPlugin/lib/sfPropelFinder.php

@@ -1317 +1317 @@
-        break;
-    }
+    $operator = trim(str_replace('JOIN', '', strtoupper($operator))) . ' JOIN';
-    $this->criteria->addJoin($column1, $column2, $operator);
-    

plugins/DbFinderPlugin/test/unit/sfDoctrineFinderInternalsTest.php

@@ -66 +66 @@
-class myFinder extends sfDoctrineFinder
-{
-
+detail = false, $
-  {
-
+detail, $
-  }
-}

plugins/DbFinderPlugin/test/unit/sfDoctrineFinderRelationsTest.php

@@ -120 +120 @@
-$databaseManager->initialize();
-
-15
+34
-
-$t->diag('findRelation()');
@@ -219 +219 @@
-$t->is($article->getTitle(), 'bbbbb', 'join() allows to join to another table (one-to-many)');
-
+$nbArticles = sfDoctrineFinder::from('DArticle')->join('Category')->where('Category.Name', 'cat1')->count();
+$t->is($nbArticles, 2, 'join() accepts relation names instead of related class names');
+$nbArticles = sfDoctrineFinder::from('DArticle')->join('DCategory a')->where('a.Name', 'cat1')->count();
+$t->is($nbArticles, 2, 'join() accepts class aliases');
+$nbArticles = sfDoctrineFinder::from('DArticle')->join('Category a')->where('a.Name', 'cat1')->count();
+$t->is($nbArticles, 2, 'join() accepts relation aliases');
+
+$finder = sfDoctrineFinder::from('DArticle')->join('DCategory');
+$finder->count();
+$t->ok(stripos($finder->getLatestQuery(), 'inner join') !== false, 'join($table) defaults to an inner join');
+$finder = sfDoctrineFinder::from('DArticle')->join('DCategory', 'left join');
+$finder->count();
+$t->ok(stripos($finder->getLatestQuery(), 'left join') !== false, 'join($table, $type) accepts a join type as second parameter (like "left join")');
+$finder = sfDoctrineFinder::from('DArticle')->join('DCategory', Criteria::LEFT_JOIN);
+$finder->count();
+$t->ok(stripos($finder->getLatestQuery(), 'left join') !== false, 'join($table, $type) accepts a join type as second parameter (like "Criteria::LEFT_JOIN")');
+$finder = sfDoctrineFinder::from('DArticle')->join('DCategory', 'left');
+$finder->count();
+$t->ok(stripos($finder->getLatestQuery(), 'left join') !== false, 'join($table, $type) accepts a join type as second parameter (like "left")');
+
+$finder = sfDoctrineFinder::from('DArticle')->join('DArticle.CategoryId', 'DCategory.Id', 'inner')->where('Category.Name', 'cat1');
+$t->is($nbArticles, 2, 'join($start, $end, $type) allows to join based on the two members of the relationship');
+sfDoctrineFinder::from('DArticle')->join('DCategory.Id', 'DArticle.CategoryId', 'inner')->where('Category.Name', 'cat1');
+$t->is($nbArticles, 2, 'join($end, $start, $type) allows to join based on the two members of the relationship');
+
+Doctrine_Query::create()->delete()->from('DArticle')->execute();
+Doctrine_Query::create()->delete()->from('DComment')->execute();
+Doctrine_Query::create()->delete()->from('DAuthor')->execute();
+$article1 = new DArticle();
+$article1->setTitle('aaaaa');
+$article1->setCategory($category1);
+$article1->save();
+$author1 = new DAuthor();
+$author1->setName('John');
+$author1->save();
+$comment = new DComment();
+$comment->setContent('foo');
+$comment->setArticleId($article1->getId());
+$comment->setAuthor($author1);
+$comment->save();
+$article = sfDoctrineFinder::from('DArticle')->join('DComment')->join('DAuthor')->where('DAuthor.Name', 'John')->findOne();
+$t->is($article->getTitle(), 'aaaaa', 'you can chain several join() statements');
+$article = sfDoctrineFinder::from('DArticle')->join('DComment')->where('DAuthor.Name', 'John')->findOne();
+$t->is($article->getTitle(), 'aaaaa', 'join() can be omitted if column names are explicit');
+$article = sfDoctrineFinder::from('DArticle')->joinDComment()->joinDAuthor()->where('DAuthor.Name', 'John')->findOne();
+$t->is($article->getTitle(), 'aaaaa', 'joinXXX() does a join according to the XXX column name');
+
+$comment = sfDoctrineFinder::from('DComment')->join('DArticle')->join('DAuthor')->where('DAuthor.Name', 'John')->findOne();
+$t->is($comment->getContent(), 'foo', 'you can add several join() statements');
+$t->is($comment->getArticle()->getTitle(), 'aaaaa', 'you can add several join() statements');
+$t->is($comment->getAuthor()->getName(), 'John', 'you can add several join() statements');
+
+$t->diag('leftJoin(), rightJoin(), innerJoin()');
+
+$finder = sfDoctrineFinder::from('DArticle')->leftJoin('DComment');
+$t->is($finder->getQueryObject()->getDQL(), 'SELECT d.* FROM DArticle d LEFT JOIN d.DComment d1', 'leftJoin($table) ends up in a left join');
+//$finder = sfDoctrineFinder::from('DArticle')->innerJoin('DComment');
+$t->skip('rightJoin($table) ends up in a right join');
+$finder = sfDoctrineFinder::from('DArticle')->innerJoin('DComment');
+$t->is($finder->getQueryObject()->getDQL(), 'SELECT d.* FROM DArticle d INNER JOIN d.DComment d1', 'innerJoin($table) ends up in an inner join');
+
+$finder = sfDoctrineFinder::from('DArticle')->leftJoin('DArticle.Id', 'DComment.ArticleId');
+$t->is($finder->getQueryObject()->getDQL(), 'SELECT d.* FROM DArticle d LEFT JOIN d.DComment ', 'leftJoin($start, $end) creates left join');
+
+$t->diag('with()');
+
+Doctrine_Query::create()->delete()->from('DArticle')->execute();
+Doctrine_Query::create()->delete()->from('DCategory')->execute();
+$category1 = new DCategory();
+$category1->setName('cat1');
+$category1->save();
+$article1 = new DArticle();
+$article1->setTitle('aaaaa');
+$article1->setCategory($category1);
+$article1->save();
+$finder = sfDoctrineFinder::from('DArticle');
+$article = $finder->findOne();
+$sql = $finder->getLatestQuery();
+$category = $article->getCategory();
+//$t->isnt($finder->getLatestQuery(), $sql, 'Calling a getter on a related object issues a new query');

plugins/DbFinderPlugin/test/unit/sfDoctrineFinderTest.php

@@ -78 +78 @@
-
-$finder = sfDoctrineFinder::from('DArticle')->where('Title', 'foo');
-(), 'Doctrine_Query', 'getQuery
+Object(), 'Doctrine_Query', 'getQueryObject
-$finder->findOne();
-$t->is($finder->getLatestQuery(), 'SELECT d.id AS d__id, d.title AS d__title, d.category_id AS d__category_id FROM d_article d WHERE d.title = \'foo\' LIMIT 1', 'getLatestQuery() returns the latest SQL query');

plugins/DbFinderPlugin/test/unit/sfPropelFinderRelationsTest.php

@@ -77 +77 @@
-$databaseManager->initialize();
-
-3
+5
-
-$t->diag('findRelation()');
@@ -167 +167 @@
-$joins = $finder->getCriteria()->getJoins();
-$join = array_pop($joins);
-
+
+
+
+
+
+
+
+
+
+
+
+
-$t->is($join->getLeftColumnName(), 'ID', 'join($table, $type) guesses the left column name');
-$t->is($join->getLeftTableName(), 'article', 'join($table, $type) guesses the left table name');

plugins/DbFinderPlugin/test/unit/sfPropelFinderTest.php

@@ -69 +69 @@
-
-$finder = sfPropelFinder::from('Article')->where('Title', 'foo');
-Criteria(), 'Criteria', 'getCriteria
+QueryObject(), 'Criteria', 'getQueryObject
-$finder->findOne();
-$t->is($finder->getLatestQuery(), 'SELECT article.ID, article.TITLE, article.CATEGORY_ID FROM article WHERE article.TITLE=\'foo\' LIMIT 1', 'getLatestQuery() returns the latest SQL query');