Changeset 10779

Timestamp:

08/11/08 15:57:28 (3 months ago)

Author:

francois

Message:

sfPropelFinderPlugin [BC Break] Removed _and() (synonym for where()) and renamed _or() to orWhere(), Implemented sfDoctrineFinder::orWhere()

Files:

• plugins/sfPropelFinderPlugin/README (modified) (5 diffs)
• plugins/sfPropelFinderPlugin/lib/DbFinder.php (modified) (5 diffs)
• plugins/sfPropelFinderPlugin/lib/sfDoctrineFinder.php (modified) (10 diffs)
• plugins/sfPropelFinderPlugin/lib/sfDoctrineFinderListener.php (modified) (2 diffs)
• plugins/sfPropelFinderPlugin/lib/sfModelFinder.php (modified) (1 diff)
• plugins/sfPropelFinderPlugin/lib/sfPropelFinder.php (modified) (6 diffs)
• plugins/sfPropelFinderPlugin/test/unit/sfDoctrineFinderTest.php (modified) (2 diffs)
• plugins/sfPropelFinderPlugin/test/unit/sfPropelFinderTest.php (modified) (4 diffs)

plugins/sfPropelFinderPlugin/README

@@ -81 +81 @@
-      where('PublishedAt', '<', time())->
-      find();
-Or even better, use the _and() and _or() methods for SQL-like code
+For OR conditions, use orWhere() instead of where()
-    $articles = $articleFinder->
-      where('Title', 'foo')->
- _and
-  _or
+where
+orWhere
-      find();
-    
@@ -116 +116 @@
-
-    // everything chained together
-_and
+where
-    // You can write it in several lines, too
-    $articles = DbFinder::from('Article')->
-      where('Title', 'like', '%world')->
- _and
+where
-      orderBy('CreatedAt')->
-      find();
@@ -237 +237 @@
-### Complex logic
-
-_and
+where
-    // For more complex logic, you have to use combine()
-    // It expects an array of named conditions to be combined, and an operator
@@ -533 +533 @@
-### 2008-08-11 | Trunk
-
+* francois: Implemented `sfDoctrineFinder::orWhere()`
+* francois: [BC Break] Removed `_and()` (synonym for `where()`) and renamed `_or()` to `orWhere()`
+* mrhyde:   Fixed problem with `sfPropelFinder`, symfony cache, and Propel 1.3
-* francois: Refactored `DbFinder` to allow agnostic finders on model objects to extend it, and to fix problem with lacking PHPDoc on `DbFinder` methods
-* francois: Added abstract `sfModelFinder` class to keep all abstract methods out of `DbFinder`
@@ -558 +561 @@
-### 2008-07-07 | 0.3.0 Beta
-
-* mrhyde:   Fixed problem with `sfPropelFinder`, symfony cache, and Propel 1.3
-* francois: Added `sfPropelFinder::combine()` method to handle complex queries with And and Or
-* francois: Added support for `with()` in `findPk()` (and documented the method)

plugins/sfPropelFinderPlugin/lib/DbFinder.php

@@ -523 +523 @@
-  
-  /**
-   * Finder Fluid Interface for AND in a WHERE
-   * Infers $column, $value, $comparison from $columnName and some optional arguments
-   *
-   * @see     where()
-   * @return  DbDinder the current finder object
-   */
-  public function _and()
-  {
-    call_user_func_array(array($this->adapter, '_and'), func_get_arg());
-    
-    return $this;
-  }
-  
-  /**
-   * Finder Fluid Interface for OR in a WHERE
-   * Infers $column, $value, $comparison from $columnName and some optional arguments
-   * Examples:
-_or
+orWhere
-   *    => WHERE ... OR article.COMMENT_ID = 3
-_or
+orWhere
-   *    => WHERE ... OR article.TITLE LIKE '%foo'
-   *
@@ -551 +537 @@
-   * @return     DbFinder the current finder object
-   */
-_or
-
-_or
+orWhere
+
+orWhere
-    
-    return $this;
@@ -735 +721 @@
-      return call_user_func_array(array($this, 'where'), $arguments);
-    }
+    if(strpos($name, 'orWhere') === 0)
+    {
+      array_unshift($arguments, substr($name, 7));
+      return call_user_func_array(array($this, 'orWhere'), $arguments);
+    }
-    if(strpos($name, 'orderBy') === 0)
-    {
@@ -749 +740 @@
-      array_unshift($arguments, substr($name, 4));
-      return call_user_func_array(array($this, 'join'), $arguments);
-
-    }
-    if(($pos = strpos($name, 'Join')) > 0)
@@ -757 +747 @@
-      return call_user_func_array(array($this, 'join'), $arguments);
-    }
-    if(strpos($name, '_and') === 0)
-    {
-      array_unshift($arguments, substr($name, 4));
-      return call_user_func_array(array($this, '_and'), $arguments);
-    }
-    if(strpos($name, 'and') === 0)
-    {
-      array_unshift($arguments, substr($name, 3));
-      return call_user_func_array(array($this, '_and'), $arguments);
-
-    }
-    if(strpos($name, '_or') === 0)
-    {
-      array_unshift($arguments, substr($name, 3));
-      return call_user_func_array(array($this, '_or'), $arguments);
-
-    }
-    if(strpos($name, 'or') === 0)
-    {
-      array_unshift($arguments, substr($name, 2));
-      return call_user_func_array(array($this, '_or'), $arguments);
-    }
-    if(strpos($name, 'findBy') === 0)
-    {

plugins/sfPropelFinderPlugin/lib/sfDoctrineFinder.php

@@ -19 +19 @@
-    $reinit        = true,
-    $query         = null,
+    $queryPattern  = '',
+    $queryArgs     = array(),
+    $argNumber     = 0,
-    $queryListener = null,
-    $withClasses   = array(),
@@ -64 +67 @@
-  public function getQuery()
-  {
+    return $this->buildQuery();
+  }
+  
+  public function buildquery()
+  {
+    if($this->queryPattern)
+    {
+      $this->query->addWhere($this->queryPattern, $this->queryArgs);
+      $this->queryPattern = '';
+      $this->queryArgs = array();
+    }
+    
-    return $this->query;
-  }
@@ -279 +294 @@
-  public function count($distinct = false)
-  {
-query
+getQuery()
-    $this->cleanup();
-    
@@ -298 +313 @@
-      $this->query->limit($limit);
-    }
-query
+getQuery()
-    $this->cleanup();
-    
@@ -458 +473 @@
-    if($forceIndividualDeletes)
-    {
-query
+getQuery()
-      $nbDeleted = 0;
-      foreach($objects as $object)
@@ -468 +483 @@
-    else
-    {
-query
+getQuery()
-      {
-        // Empty queries don't return the number of deleted rows
@@ -674 +689 @@
-  }
-  
-
-
+
+
+
+
+
+
-    if($comparison == ' IN ')
-    {
+      if($operator == 'or')
+      {
+        throw new Exception('sfDoctrineFinder cannot OR a condition with an IN');
+      }
-      $this->query->whereIn($column, $value);
-    }
-    else
-    {
+      // The operator of the first condition is ignored
+      $operator = $this->queryPattern ? $operator : '';
-      if(is_null($value))
-      {
-->addWhere(sprintf('%s %s', $column, $comparison)
+Pattern .= sprintf(' %s %s %s', $operator, $column, $comparison
-      }
-      else
-      {
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
-  }
-
@@ -715 +730 @@
-   * @return     sfDoctrineFinder the current finder object
-   */
-
-
-
+
+
+
+
+
+
+
-    
-    return $this;
@@ -1001 +1020 @@
-      return call_user_func_array(array($this, 'where'), $arguments);
-    }
+    if(strpos($name, 'orWhere') === 0)
+    {
+      array_unshift($arguments, substr($name, 7));
+      return call_user_func_array(array($this, 'orWhere'), $arguments);
+    }
-    if(strpos($name, 'orderBy') === 0)
-    {
@@ -1015 +1039 @@
-      return call_user_func_array(array($this, 'join'), $arguments);
-    }
-    if(strpos($name, '_and') === 0)
-    {
-      array_unshift($arguments, substr($name, 4));
-      return call_user_func_array(array($this, '_and'), $arguments);
-    }
-    if(strpos($name, 'and') === 0)
-    {
-      array_unshift($arguments, substr($name, 3));
-      return call_user_func_array(array($this, '_and'), $arguments);
-
-    }
-    if(strpos($name, '_or') === 0)
-    {
-      array_unshift($arguments, substr($name, 3));
-      return call_user_func_array(array($this, '_or'), $arguments);
-
-    }
-    if(strpos($name, 'or') === 0)
-    {
-      array_unshift($arguments, substr($name, 2));
-      return call_user_func_array(array($this, '_or'), $arguments);
-    }
-    if(strpos($name, 'findBy') === 0)
-    {

plugins/sfPropelFinderPlugin/lib/sfDoctrineFinderListener.php

@@ -34 +34 @@
-  public function preQuery(Doctrine_Event $event)
-  {
-.';'
+
-  }
-  
@@ -46 +46 @@
-  {
-    $query = $event->getQuery();
-
-
+
+
+
+
+
+
-  }
-  

plugins/sfPropelFinderPlugin/lib/sfModelFinder.php

@@ -81 +81 @@
-  abstract public function distinct();
-  abstract public function where();
-
-
+
-  abstract public function combine($conditions, $operator = 'and', $namedCondition = null);
-  abstract public function relatedTo($object);

plugins/sfPropelFinderPlugin/lib/sfPropelFinder.php

@@ -964 +964 @@
-
-  /**
-   * Finder Fluid Interface for Criteria::addAnd()
-   * Infers $column, $value, $comparison from $columnName and some optional arguments
-   *
-   * @see     where()
-   * @return     sfPropelFinder the current finder object
-   */
-  public function _and()
-  {
-    $arguments = func_get_args();
-    $columnName = array_shift($arguments);
-    $column = $this->getColName($columnName);
-    list($value, $comparison) = self::getValueAndComparisonFromArguments($arguments);
-    $this->addCondition('And', $column, $value, $comparison);
-    
-    return $this;
-  }
-
-  /**
-   * Finder Fluid Interface for Criteria::addOr()
-   * Infers $column, $value, $comparison from $columnName and some optional arguments
-   * Examples:
-_or
+orWhere
-   *    => $c->addOr(ArticlePeer::COMMENT_ID, 3)
-_or
+orWhere
-   *    => $c->addOr(ArticlePeer::TITLE, '%foo', Criteria::LIKE)
-   *
@@ -996 +978 @@
-   * @return     sfPropelFinder the current finder object
-   */
-_or
+orWhere
-  {
-    $arguments = func_get_args();
@@ -1070 +1052 @@
-  /**
-   * We want that the Finder fuild Interface works like:
-_andB->_orC()->_orD()->_and
+whereB->orWhereC()->orWhereD()->where
-   *   SQL : where A=? AND (B=? OR (C=? OR (D=? AND E=?)))
-   * So we have to add condition starting by the last one!
@@ -1489 +1471 @@
-      return call_user_func_array(array($this, 'where'), $arguments);
-    }
+    if(strpos($name, 'orWhere') === 0)
+    {
+      array_unshift($arguments, substr($name, 7));
+      return call_user_func_array(array($this, 'orWhere'), $arguments);
+    }
-    if(strpos($name, 'orderBy') === 0)
-    {
@@ -1503 +1490 @@
-      array_unshift($arguments, substr($name, 4));
-      return call_user_func_array(array($this, 'join'), $arguments);
-      
-    }
-    if(($pos = strpos($name, 'Join')) > 0)
@@ -1511 +1497 @@
-      return call_user_func_array(array($this, 'join'), $arguments);
-    }
-    if(strpos($name, '_and') === 0)
-    {
-      array_unshift($arguments, substr($name, 4));
-      return call_user_func_array(array($this, '_and'), $arguments);
-    }
-    if(strpos($name, 'and') === 0)
-    {
-      array_unshift($arguments, substr($name, 3));
-      return call_user_func_array(array($this, '_and'), $arguments);
-
-    }
-    if(strpos($name, '_or') === 0)
-    {
-      array_unshift($arguments, substr($name, 3));
-      return call_user_func_array(array($this, '_or'), $arguments);
-
-    }
-    if(strpos($name, 'or') === 0)
-    {
-      array_unshift($arguments, substr($name, 2));
-      return call_user_func_array(array($this, '_or'), $arguments);
-    }
-    if(strpos($name, 'findBy') === 0)
-    {

plugins/sfPropelFinderPlugin/test/unit/sfDoctrineFinderTest.php

@@ -73 +73 @@
-Doctrine_Query::create()->delete()->from('DArticle')->execute();
-
-77
+84
-
-$t->diag('find()');
@@ -476 +476 @@
-$articles = sfDoctrineFinder::from('DArticle')->whereTitle('like', '%bc')->find();
-$t->is(count($articles), 2, 'whereXXX() accepts a comparator as first argument when two arguments are given');
+
+$t->diag('orWhere()');
+
+$columns    = "d.id AS d__id, d.title AS d__title, d.category_id AS d__category_id";
+$baseSelect = "SELECT $columns FROM d_article d WHERE ";
+
+$finder = sfDoctrineFinder::from('DArticle')->
+  where('Title', 'foo')->
+  orWhere('Title', 'bar');
+$finder->find();
+$t->is(
+  $finder->getLatestQuery(),
+  $baseSelect . "(d.title = 'foo' OR d.title = 'bar')",
+  'orWhere() adds a SQL OR clause when called on a column where there is already a condition'
+);
+
+$finder = sfDoctrineFinder::from('DArticle')->
+  where('Title', 'foo')->
+  orWhere('CategoryId', 1);
+$finder->find();
+$t->is(
+  $finder->getLatestQuery(),
+  $baseSelect . "(d.title = 'foo' OR d.category_id = '1')",
+  'orWhere() adds a SQL OR clause when called on a column where there is no condition yet'
+);
+
+$finder = sfDoctrineFinder::from('DArticle')->
+  where('Title', 'foo')->
+  where('Title', 'bar');
+$finder->find();
+$t->is(
+  $finder->getLatestQuery(),
+  $baseSelect . "(d.title = 'foo' AND d.title = 'bar')",
+  'where() adds a SQL AND clause when called on a column where there is already a condition'
+);
+
+$finder = sfDoctrineFinder::from('DArticle')->
+  where('Title', 'foo')->
+  where('CategoryId', 1);
+$finder->find();
+$t->is(
+  $finder->getLatestQuery(),
+  $baseSelect . "(d.title = 'foo' AND d.category_id = '1')",
+  'where() adds a SQL AND clause when called on a column where there is no condition yet'
+);
+
+$finder = sfDoctrineFinder::from('DArticle')->
+  where('CategoryId', 1)->
+  where('Title', 'foo')->
+  orWhere('Title', 'bar');
+$finder->find();
+$t->is(
+  $finder->getLatestQuery(),
+  $baseSelect . "(d.category_id = '1' AND (d.title = 'foo' OR d.title = 'bar'))",
+  'where() and orWhere() can be combined on the same finder'
+);
+
+/*
+$finder = sfDoctrineFinder::from('DArticle')->
+  joinCategory()->
+  where('Category.Name', 'foo')->
+  orWhere('Category.Name', 'bar');
+$finder->find();
+$t->is(
+  $finder->getLatestQuery(),
+  "SELECT $columns FROM article, category WHERE (category.NAME='foo' OR category.NAME='bar') AND article.CATEGORY_ID=category.ID",
+  'orWhere() works on a simple jointure'
+);
+
+$finder = sfDoctrineFinder::from('DComment')->
+  joinArticle()->
+  joinAuthor()->
+  where('Article.Title', 'foo')->
+  orWhere('Author.Name', 'bar');
+$finder->find();
+$t->is(
+  $finder->getLatestQuery(),
+  "SELECT comment.ID, comment.CONTENT, comment.ARTICLE_ID, comment.AUTHOR_ID FROM comment, article, author WHERE (article.TITLE='foo' OR author.NAME='bar') AND comment.ARTICLE_ID=article.ID AND comment.AUTHOR_ID=author.ID",
+  'orWhere() works on a multiple jointure'
+);
+*/
+
+$t->skip('orWhere() works on a simple jointure');
+$t->skip('orWhere() works on a multiple jointure');

plugins/sfPropelFinderPlugin/test/unit/sfPropelFinderTest.php

@@ -460 +460 @@
-$t->is(count($articles), 2, 'whereXXX() accepts a comparator as first argument when two arguments are given');
-
-_and() and _or
+orWhere
-
-$columns    = "article.ID, article.TITLE, article.CATEGORY_ID";
@@ -467 +467 @@
-$finder = sfPropelFinder::from('Article')->
-  where('Title', 'foo')->
-_or
+orWhere
-$finder->find();
-$t->is(
-  $finder->getLatestQuery(),
-  $baseSelect . "(article.TITLE='foo' OR article.TITLE='bar')",
-_or
+orWhere
-);
-
-$finder = sfPropelFinder::from('Article')->
-  where('Title', 'foo')->
-_or
+orWhere
-$finder->find();
-$t->is(
-  $finder->getLatestQuery(),
-  $baseSelect . "(article.TITLE='foo' OR article.CATEGORY_ID=1)",
-_or
+orWhere
-);
-
-$finder = sfPropelFinder::from('Article')->
-  where('Title', 'foo')->
-_and
+where
-$finder->find();
-$t->is(
-  $finder->getLatestQuery(),
-  $baseSelect . "(article.TITLE='foo' AND article.TITLE='bar')",
-_and
+where
-);
-
-$finder = sfPropelFinder::from('Article')->
-  where('Title', 'foo')->
-_and
+where
-$finder->find();
-$t->is(
-  $finder->getLatestQuery(),
-  $baseSelect . "(article.TITLE='foo' AND article.CATEGORY_ID=1)",
-_and
+where
-);
-
-$finder = sfPropelFinder::from('Article')->
-  where('CategoryId', 1)->
-_and
-_or
+where
+orWhere
-$finder->find();
-$t->is(
-  $finder->getLatestQuery(),
-  $baseSelect . "(article.CATEGORY_ID=1 AND (article.TITLE='foo' OR article.TITLE='bar'))",
-_and() and _or
+where() and orWhere
-);
-
@@ -519 +519 @@
-  joinCategory()->
-  where('Category.Name', 'foo')->
-_or
+orWhere
-$finder->find();
-$t->is(
-  $finder->getLatestQuery(),
-  "SELECT $columns FROM article, category WHERE (category.NAME='foo' OR category.NAME='bar') AND article.CATEGORY_ID=category.ID",
-_or
+orWhere
-);
-
@@ -531 +531 @@
-  joinAuthor()->
-  where('Article.Title', 'foo')->
-_or
+orWhere
-$finder->find();
-$t->is(
-  $finder->getLatestQuery(),
-  "SELECT comment.ID, comment.CONTENT, comment.ARTICLE_ID, comment.AUTHOR_ID FROM comment, article, author WHERE (article.TITLE='foo' OR author.NAME='bar') AND comment.ARTICLE_ID=article.ID AND comment.AUTHOR_ID=author.ID",
-_or
+orWhere
-);
-