Changeset 10805

Timestamp:

08/12/08 14:21:31 (3 months ago)

Author:

francois

Message:

sfPropelFinderPlugin Minor fixes:

• Implemented limit() and offset() in both sfPropelFinder and sfDoctrineFinder
  
• Implemented not in comparison in sfDoctrineFinder::where()
  
• Added finder_methods parameter in generator.yml
  

Files:

• plugins/sfPropelFinderPlugin/README (modified) (1 diff)
• plugins/sfPropelFinderPlugin/README_generator (modified) (3 diffs)
• plugins/sfPropelFinderPlugin/data/generator/DbFinderAdmin/default/template/actions/actions.class.php (modified) (3 diffs)
• plugins/sfPropelFinderPlugin/lib/DbFinder.php (modified) (2 diffs)
• plugins/sfPropelFinderPlugin/lib/sfDoctrineFinder.php (modified) (4 diffs)
• plugins/sfPropelFinderPlugin/lib/sfModelFinder.php (modified) (2 diffs)
• plugins/sfPropelFinderPlugin/lib/sfPropelFinder.php (modified) (1 diff)
• plugins/sfPropelFinderPlugin/lib/sfPropelFinderPager.php (modified) (5 diffs)
• plugins/sfPropelFinderPlugin/test/unit/sfDoctrineFinderTest.php (modified) (5 diffs)
• plugins/sfPropelFinderPlugin/test/unit/sfPropelFinderTest.php (modified) (3 diffs)

plugins/sfPropelFinderPlugin/README

@@ -533 +533 @@
----------
-
-
-
+
+
+
+
+
-* francois: `sfPropelFinder::join()` now defaults to an `INNER JOIN` instead of a `WHERE` statement (will facilitate compatibility with Doctrine)
-* francois: Implemented `sfDoctrine::combine()`

plugins/sfPropelFinderPlugin/README_generator

@@ -15 +15 @@
-        theme:            default
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
-
-Being ORM agnostic, the `DbFinderAdminGenerator` does not accept the `peer_method` parameter. Instead, it supports a `with` parameter, where you can stipulate the classes of all the related objects you want to hydrate to save queries:
-
-    list:
-Title, C
+title, c
-      with:    [Category]
-
@@ -43 +27 @@
-
-    list:
-Title, Category, A
+title, category, a
-      with:    [i18n, Category, Author]
-
-*Note*: The resulting query contains a left join, while `sfPropelAdminGenerator` issues queries with a simple `where` condition. That means that even if you choose to hydrate related `Category` objects, the list view will still display `Article` objects with no `Category`. That's a huge difference with the usual generator based on Propel 1.2, which hides records as soon as you declare a `peer_method`.
+
+The list view uses a finder to retrieve the list of records. By adding method names to the `finder_methods` parameter, you 'filter' the view by these filters. This allows you to changes the display order, restrict results or hydrate supplementary columns to save on queries.
+
+    list:
+      display: [=title, category, author]
+      finder_methods: [withNbComments]
-
-TODO
@@ -53 +43 @@
-* Pake task to generate a DbFinder Admin Module
-* Migrate many-to-many code to DbFinder
-* Implement enough DoctrineFinder to make it work with Doctrine! (mostly `_or()`)

plugins/sfPropelFinderPlugin/data/generator/DbFinderAdmin/default/template/actions/actions.class.php

@@ -39 +39 @@
-<?php endforeach ?>
-<?php endif ?>
-
-
+
+
+
+
-<?php endif ?>
-    $this->pager = $this->finder->paginate($this->getRequestParameter('page', 1), <?php echo $this->getParameterValue('list.max_per_page', 20) ?>);
@@ -378 +380 @@
-        $finder->where('<?php echo $name ?>', '<=', $this->filters['<?php echo $column->getName() ?>']['to']);
-<?php endif; ?>
-        }
-      }
-
@@ -400 +401 @@
-    if ($sort_column = $this->getUser()->getAttribute('sort', null, 'sf_admin/<?php echo $this->getSingularName() ?>/sort'))
-    {
+      $sort_column = sfInflector::camelize($sort_column);
-      $finder->orderBy($sort_column, $this->getUser()->getAttribute('type', null, 'sf_admin/<?php echo $this->getSingularName() ?>/sort'));
-    }

plugins/sfPropelFinderPlugin/lib/DbFinder.php

@@ -479 +479 @@
-  {
-    $this->adapter->withColumn($column, $alias, $type);
+    
+    return $this;
-  }
-  
@@ -491 +493 @@
-  {
-    $this->adapter->distinct();
+    
+    return $this;
+  }
+  
+  /**
+   * Finder Fluid Interface for SQL LIMIT
+   *
+   * @return     DbFinder the current finder object
+   */
+  public function limit($limit)
+  {
+    $this->adapter->limit($limit);
+    
+    return $this;
+  }
+
+  /**
+   * Finder Fluid Interface for SQL OFFSET
+   *
+   * @return     DbFinder the current finder object
+   */
+  public function offset($offset)
+  {
+    $this->adapter->offset($offset);
-    
-    return $this;

plugins/sfPropelFinderPlugin/lib/sfDoctrineFinder.php

@@ -648 +648 @@
-  public function distinct()
-  {
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    
-    return $this;
@@ -715 +739 @@
-    if($comparison == ' NOT IN ')
-    {
-
-
-
+
+
+
+
+
+
+
-    {
-      if($cond == 'or')
@@ -803 +831 @@
-    else
-    {
-
+
+
+
-    }
-    
@@ -907 +937 @@
-    
-    throw new Exception('Unable to figure out the column to use to order rows in sfDoctrineFinder::guessOrder()');
-  }
-  
-  protected static function camelize($arg)
-  {
-    if(is_array($arg))
-    {
-      $ret = array();
-      foreach ($arg as $arg1)
-      {
-        $ret []= self::camelize($arg1);
-      }
-      return $ret;
-    }
-    else
-    {
-      return sfInflector::camelize($arg);
-    }
-  }
-
-  protected static function underscore($arg)
-  {
-    if(is_array($arg))
-    {
-      $ret = array();
-      foreach ($arg as $arg1)
-      {
-        $ret []= self::underscore($arg1);
-      }
-      return $ret;
-    }
-    else
-    {
-      return sfInflector::underscore($arg);
-    }
-  }
-  

plugins/sfPropelFinderPlugin/lib/sfModelFinder.php

@@ -80 +80 @@
-  
-  abstract public function distinct();
+  abstract public function limit($limit);
+  abstract public function offset($offset);
-  abstract public function where();
-  abstract public function orWhere();
@@ -237 +239 @@
-    return array_keys($attributes);
-  }
+  
+  public static function camelize($arg)
+  {
+    if(is_array($arg))
+    {
+      $ret = array();
+      foreach ($arg as $arg1)
+      {
+        $ret []= self::camelize($arg1);
+      }
+      return $ret;
+    }
+    else
+    {
+      return sfInflector::camelize($arg);
+    }
+  }
+
+  public static function underscore($arg)
+  {
+    if(is_array($arg))
+    {
+      $ret = array();
+      foreach ($arg as $arg1)
+      {
+        $ret []= self::underscore($arg1);
+      }
+      return $ret;
+    }
+    else
+    {
+      return sfInflector::underscore($arg);
+    }
+  }
-}

plugins/sfPropelFinderPlugin/lib/sfPropelFinder.php

@@ -925 +925 @@
-  
-  /**
+   * Finder Fluid Interface for Criteria::setLimit()
+   *
+   * @return     sfPropelFinder the current finder object
+   */
+  public function limit($limit)
+  {
+    $this->criteria->setLimit($limit);
+    
+    return $this;
+  }
+  
+  /**
+   * Finder Fluid Interface for Criteria::setOffset()
+   *
+   * @return     sfPropelFinder the current finder object
+   */
+  public function offset($offset)
+  {
+    $this->criteria->setOffset($offset);
+    
+    return $this;
+  }
+  
+  /**
-   * Finder Fluid Interface for Criteria::add()
-   * Infers $column, $value, $comparison from $columnName and some optional arguments

plugins/sfPropelFinderPlugin/lib/sfPropelFinderPager.php

@@ -51 +51 @@
-    $finderForCount = clone $this->getFinder();
-    $count = $finderForCount->
-setO
-setL
+o
+l
-      clearGroupByColumns()->
-      count();
@@ -59 +59 @@
-    
-    $this->finder->
-setO
-setL
+o
+l
-      
-    if (($this->getPage() == 0 || $this->getMaxPerPage() == 0))
@@ -71 +71 @@
-
-      $offset = ($this->getPage() - 1) * $this->getMaxPerPage();
-setO
+o
-
-      if ($hasMaxRecordLimit)
@@ -78 +78 @@
-        if ($maxRecordLimit > $this->getMaxPerPage())
-        {
-setL
+l
-        }
-        else
-        {
-setL
+l
-        }
-      }
-      else
-      {
-setL
+l
-      }
-    }
@@ -104 +104 @@
-
-    return $finderForRetrieve->
-setO
+o
-      findOne();
-  }

plugins/sfPropelFinderPlugin/test/unit/sfDoctrineFinderTest.php

@@ -73 +73 @@
-Doctrine_Query::create()->delete()->from('DArticle')->execute();
-
-92
+103
-
-$t->diag('find()');
@@ -425 +425 @@
-$articles = sfDoctrineFinder::from('DArticle')->where('Title', 'is not null', null)->find();
-$t->is(count($articles), 3, 'where() accepts a text comparator and is permissive on syntax');
- in 
+in
-$t->is(count($articles), 2, 'where() accepts a "in" comparator');
-
+
+
-try
-{
@@ -606 +607 @@
-$t->is(
-  $finder->getLatestQuery(),
-' OR d.title = 'bar') AND d.title = 'foobar'
+bar' AND (d.title = 'foo' OR d.title = 'bar'))
-  'combine() clauses live well with the usual conditions'
-);
@@ -618 +619 @@
-$t->is(
-  $finder->getLatestQuery(),
-d.title = 'foo' OR d.title = 'bar') AND d.title = 'foobar'
+(d.title = 'foo' OR d.title = 'bar') AND d.title = 'foobar')
-  'combine() clauses live well with the usual conditions and appear ordered as they were called'
-);
@@ -661 +662 @@
-  'combine() can combine more than two conditions'
-);
+
+$t->diag('limit() and offset()');
+
+Doctrine_Query::create()->delete()->from('DArticle')->execute();
+$article1 = new DArticle();
+$article1->setTitle('abc');
+$article1->save();
+$article2 = new DArticle();
+$article2->setTitle('def');
+$article2->save();
+$article3 = new DArticle();
+$article3->setTitle('bbc');
+$article3->save();
+
+$articles = sfDoctrineFinder::from('DArticle')->limit(1)->find();
+$t->is(count($articles), 1, 'limit() adds a limit to the SQL clause');
+$article = $articles[0];
+$t->is($article->getTitle(), 'abc', 'limit() adds a limit to the SQL clause');
+$articles = sfDoctrineFinder::from('DArticle')->limit(2)->find();
+$t->is(count($articles), 2, 'limit() adds a limit to the SQL clause');
+$article = $articles[0];
+$t->is($article->getTitle(), 'abc', 'limit() adds a limit to the SQL clause');
+$article = $articles[1];
+$t->is($article->getTitle(), 'def', 'limit() adds a limit to the SQL clause');
+
+$articles = sfDoctrineFinder::from('DArticle')->offset(1)->find();
+$t->is(count($articles), 2, 'offset() adds an offset to the SQL clause');
+$article = $articles[0];
+$t->is($article->getTitle(), 'def', 'offset() adds an offset to the SQL clause');
+$article = $articles[1];
+$t->is($article->getTitle(), 'bbc', 'offset() adds an offset to the SQL clause');
+
+$articles = sfDoctrineFinder::from('DArticle')->offset(1)->limit(1)->find();
+$t->is(count($articles), 1, 'limit() and offset() can be combined');
+$article = $articles[0];
+$t->is($article->getTitle(), 'def', 'limit() and offset() can be combined');

plugins/sfPropelFinderPlugin/test/unit/sfPropelFinderTest.php

@@ -64 +64 @@
-ArticlePeer::doDeleteAll();
-
-22
+33
-
-$t->diag('find()');
@@ -409 +409 @@
-$articles = sfPropelFinder::from('Article')->where('Title', 'is not null', null)->find();
-$t->is(count($articles), 3, 'where() accepts a text comparator and is permissive on syntax');
- in 
+in
-$t->is(count($articles), 2, 'where() accepts a "in" comparator');
+$articles = sfPropelFinder::from('Article')->where('Title', 'not in', array('abc', 'def'))->find();
+$t->is(count($articles), 1, 'where() accepts a "not in" comparator');
-try
-{
@@ -640 +642 @@
-);
-
+$t->diag('limit() and offset()');
+
+ArticlePeer::doDeleteAll();
+$article1 = new Article();
+$article1->setTitle('abc');
+$article1->save();
+$article2 = new Article();
+$article2->setTitle('def');
+$article2->save();
+$article3 = new Article();
+$article3->setTitle('bbc');
+$article3->save();
+
+$articles = sfPropelFinder::from('Article')->limit(1)->find();
+$t->is(count($articles), 1, 'limit() adds a limit to the SQL clause');
+$article = $articles[0];
+$t->is($article->getTitle(), 'abc', 'limit() adds a limit to the SQL clause');
+$articles = sfPropelFinder::from('Article')->limit(2)->find();
+$t->is(count($articles), 2, 'limit() adds a limit to the SQL clause');
+$article = $articles[0];
+$t->is($article->getTitle(), 'abc', 'limit() adds a limit to the SQL clause');
+$article = $articles[1];
+$t->is($article->getTitle(), 'def', 'limit() adds a limit to the SQL clause');
+
+$articles = sfPropelFinder::from('Article')->offset(1)->find();
+$t->is(count($articles), 2, 'offset() adds an offset to the SQL clause');
+$article = $articles[0];
+$t->is($article->getTitle(), 'def', 'offset() adds an offset to the SQL clause');
+$article = $articles[1];
+$t->is($article->getTitle(), 'bbc', 'offset() adds an offset to the SQL clause');
+
+$articles = sfPropelFinder::from('Article')->offset(1)->limit(1)->find();
+$t->is(count($articles), 1, 'limit() and offset() can be combined');
+$article = $articles[0];
+$t->is($article->getTitle(), 'def', 'limit() and offset() can be combined');
-
-$t->diag('relatedTo()');