Changeset 10545

Timestamp:

07/31/08 17:18:52 (4 months ago)

Author:

francois

Message:

sfPropelFinderPlugin Added sfPropelFinder::groupByClass() to ease PostgreSQL grouping (based on a patch by mrhyde) (closes #4105)

Files:

• plugins/sfPropelFinderPlugin/README (modified) (2 diffs)
• plugins/sfPropelFinderPlugin/lib/sfPropelFinder.php (modified) (2 diffs)
• plugins/sfPropelFinderPlugin/test/unit/sfPropelFinderTest.php (modified) (2 diffs)

plugins/sfPropelFinderPlugin/README

@@ -427 +427 @@
-  orderBy('NbComments')->
-  find();
+$articles = sfPropelFinder::from('Article')->
+  join('Comment')->
+  groupBy('Article.Id')->
+  withColumn('COUNT(comment.ID)', 'NbComments')->
+  find();
-
-// Lastly, the supplementary columns added with withColumn() are considered string by default
@@ -608 +613 @@
-=== 2008-07-31 | Trunk ===
-
+ * mrhyde: Added `sfPropelFinder::groupByClass()` to ease PostgreSQL grouping
- * francois: Fixed problem with table alias and PostgreSQL (based on a patch by mrhyde)
- * mrhyde: Fixed problem with group by clauses being ripped off by pager

plugins/sfPropelFinderPlugin/lib/sfPropelFinder.php

@@ -848 +848 @@
-  
-  /**
+   * Finder Fluid Interface for Criteria::addGroupByColumn() but this times we add all columns from given class.
+   * Examples:
+   *   $articleFinder->groupBy('Article')
+   *    => $c->addGroupByColumn(ArticlePeer::ID);$c->addGroupByColumn(ArticlePeer::TITLE);$c->addGroupByColumn(ArticlePeer::CREATED_AT);...
+   * @param string $class
+   *
+   * @return sfPropelFinder
+   */
+  public function groupByClass($class)
+  {
+    $peerClass = sfPropelFinderUtils::getPeerClassFromClass($class);
+    $columns = call_user_func(array($peerClass, 'getFieldNames'), BasePeer::TYPE_COLNAME);
+    foreach ($columns as $column)
+    {
+      $this->criteria->addGroupByColumn($column);
+    }
+    
+    return $this;
+  }
+   
+  /**
-   * Guess sort column based on their names
-   * Will look primarily for columns named:
@@ -1081 +1102 @@
-      return $this->orderBy(substr($name, 7), $arguments);
-    }
+    if(strpos($name, 'groupBy') === 0)
+    {
+      return $this->groupBy(substr($name, 7), $arguments);
+    }
-    if(strpos($name, 'join') === 0)
-    {

plugins/sfPropelFinderPlugin/test/unit/sfPropelFinderTest.php

@@ -65 +65 @@
-ArticlePeer::doDeleteAll();
-
-16
+20
-
-$t->diag('find()');
@@ -752 +752 @@
-$t->is($article->getTitle(), 'ccccc', 'orderByXXX() takes an order as argument');
-
+$t->diag('groupBy()');
+
+ArticlePeer::doDeleteAll();
+CommentPeer::doDeleteAll();
+
+$article1 = new Article();
+$article1->setTitle('bbbbb');
+$article1->setCategory($category1);
+$article1->save();
+$author1 = new Author();
+$author1->setName('John');
+$author1->save();
+$comment = new Comment();
+$comment->setContent('foo');
+$comment->setArticleId($article1->getId());
+$comment->setAuthor($author1);
+$comment->save();
+
+$finder = sfPropelFinder::from('Article')->
+  join('Comment')->
+  groupBy('Article.Id')->
+  withColumn('COUNT(comment.ID)', 'NbComments');
+$article = $finder->findOne();
+$t->is($finder->getLatestQuery(), 'SELECT article.ID, article.TITLE, article.CATEGORY_ID, COUNT(comment.ID) AS NbComments FROM article, comment WHERE article.ID=comment.ARTICLE_ID GROUP BY article.ID LIMIT 1', 'groupBy() accepts a column name and issues a GROUP BY clause');
+
+$finder = sfPropelFinder::from('Article')->
+  join('Comment')->
+  withColumn('Article.Id', 'foo')->
+  groupBy('foo')->
+  withColumn('COUNT(comment.ID)', 'NbComments');
+$article = $finder->findOne();
+$t->is($finder->getLatestQuery(), 'SELECT article.ID, article.TITLE, article.CATEGORY_ID, article.ID AS foo, COUNT(comment.ID) AS NbComments FROM article, comment WHERE article.ID=comment.ARTICLE_ID GROUP BY foo LIMIT 1', 'groupBy() accepts a column alias and issues a GROUP BY clause');
+
+$finder = sfPropelFinder::from('Article')->
+  join('Comment')->
+  groupByArticle_Id()->
+  withColumn('COUNT(comment.ID)', 'NbComments');
+$article = $finder->findOne();
+$t->is($finder->getLatestQuery(), 'SELECT article.ID, article.TITLE, article.CATEGORY_ID, COUNT(comment.ID) AS NbComments FROM article, comment WHERE article.ID=comment.ARTICLE_ID GROUP BY article.ID LIMIT 1', 'groupByXXX() accepts a column name and issues a GROUP BY clause');
+
+$t->diag('groupByClass()');
+
+ArticlePeer::doDeleteAll();
+CommentPeer::doDeleteAll();
+
+$article1 = new Article();
+$article1->setTitle('bbbbb');
+$article1->setCategory($category1);
+$article1->save();
+$author1 = new Author();
+$author1->setName('John');
+$author1->save();
+$comment = new Comment();
+$comment->setContent('foo');
+$comment->setArticleId($article1->getId());
+$comment->setAuthor($author1);
+$comment->save();
+
+$finder = sfPropelFinder::from('Article')->
+  join('Comment')->
+  groupByClass('Article')->
+  withColumn('COUNT(comment.ID)', 'NbComments');
+$article = $finder->findOne();
+$t->is($finder->getLatestQuery(), 'SELECT article.ID, article.TITLE, article.CATEGORY_ID, COUNT(comment.ID) AS NbComments FROM article, comment WHERE article.ID=comment.ARTICLE_ID GROUP BY article.ID,article.TITLE,article.CATEGORY_ID LIMIT 1', 'groupByClass() accepts a model class name and issues a GROUP BY clause on all columns');
+
-$t->diag('set()');
-