Changeset 10166

Timestamp:

07/07/08 15:19:42 (5 months ago)

Author:

francois

Message:

sfPropelFinderPlugin Added sfPropelFinder::combine() method to handle complex queries with And and Or

Files:

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

plugins/sfPropelFinderPlugin/README

@@ -123 +123 @@
-}}}
-
-omb
+ha
-
-The methods of the `sfPropelFinder` object return the current finder object, so you can chain them together in a single call, and finish by any of the `find()` methods to launch the query.
@@ -267 +267 @@
-}}}
-
+=== Complex logic ===
+
+{{{
+#!php
+<?php
+// _and() and _or() only allow simple logical operations on a single condition
+// For more complex logic, you have to use combine()
+// It expects an array of named conditions to be combined, and an operator
+// Use the fourth argument of where() to name a condition
+$article = sfPropelFinder::from('Article')->
+  where('Title', '=', 'Foo', 'cond1')->     // creates a condition named 'cond1'
+  where('Title', '=', 'Bar', 'cond2')->     // creates a condition named 'cond2'
+  combine(array('cond1', 'cond2'), 'or')->  // combine 'cond1' and 'cond2' with a logical OR
+  findOne();
+// SELECT article.* FROM article WHERE (article.TITLE = 'foo' OR article.TITLE = 'bar');
+
+// combine accepts more than two conditions at a time
+$articles = sfPropelFinder::from('Article')->
+  where('Title', '=', 'Foo', 'cond1')->
+  where('Title', '=', 'Bar', 'cond2')->
+  where('Title', '=', 'FooBar', 'cond3')->
+  combine(array('cond1', 'cond2', 'cond3'), 'or')->
+  find();
+// SELECT article.* FROM article WHERE (article.TITLE = 'foo' OR article.TITLE = 'bar') OR article.TITLE = 'FooBar';
+
+// combine() itself can return a named condition to be combined later
+// So it allows for any level of logical complexity
+$articles = sfPropelFinder::from('Article')->
+  where('Title', '=', 'Foo', 'cond1')->
+  where('Title', '=', 'Bar', 'cond2')->
+  combine(array('cond1', 'cond2'), 'or', 'TitleFooBar')->
+  where('PublishedAt', '<=', $end, 'cond3')->
+  where('PublishedAt', '>=', $begin, 'cond4')->
+  combine(array('cond2', 'cond3'), 'and', 'PublishedInBounds')->
+  combine(array('TitleFooBar', 'PublishedInBounds'), 'or')->
+  find();
+// SELECT article.* FROM article WHERE (
+//  (article.TITLE = 'foo' OR article.TITLE = 'bar')
+//  OR
+//  (article.PUBLISHED_AT <= $end AND article.PUBLISHED_AT >= $begin)
+// );
+}}}
+
-=== Minimizing queries ===
-
@@ -535 +578 @@
-== TODO / Ideas ==
-
+ * Allow i18n hydration of related objects (#3897)
+ * Handle self-referencing relationships (e.g. parent_id), especially in with()
+ * Handle multiple references to the same table (c.f. getFooRelatedByBarId())
- * Put as a parent class in the PeerBuilder so that every Peer class can be a finder
- * Merge with sfPropelImpersonatorPlugin!
- * Handle complex queries with And and Or
- * Add a `__toString()` method which returns a var_export() of the results, or a description of the conditions if not yet executed
- * Implement iterator interface? That way, the query is only executed upon a foreach or an array access... And the finder can be seen as a collection
@@ -544 +589 @@
-== Changelog ==
-
-
-
+
+
+
- * francois: Added support for `with()` in `findPk()` (and documented the method)
- * francois: Added the ability to do left, right, and inner joins in a simple way

plugins/sfPropelFinderPlugin/lib/sfPropelFinder.php

@@ -712 +712 @@
-   *   $articleFinder->where('Title', 'like', '%foo')
-   *    => $c->add(ArticlePeer::TITLE, '%foo', Criteria::LIKE)
+   *   $articleFinder->where('Title', 'like', '%foo', 'FooTitle')
+   *    => $FooTitle = $c->getNewCriterion(ArticlePeer::TITLE, '%foo', Criteria::LIKE)
-   *
-   * @param      string  $columnName PHPName of the column bearing the condition
-
+
+
+
-   *
-   * @return     sfPropelFinder the current finder object
-   */
-
-
+
+
+
+
-    $column = $this->getColName($columnName);
-
-
-
-
-
+
+
+
+
+
+
+
+
+
-    list($value, $comparison) = sfPropelFinderUtils::getValueAndComparisonFromArguments($arguments);
-
-
+
-    
-    return $this;
@@ -736 +745 @@
-   * Finder Fluid Interface for Criteria::addAnd()
-   * Infers $column, $value, $comparison from $columnName and some optional arguments
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
-    $column = $this->getColName($columnName);
-    if(!is_array($arguments))
-    {
-      $arguments = func_get_args();
-      array_shift($arguments);
-    } 
-    list($value, $comparison) = sfPropelFinderUtils::getValueAndComparisonFromArguments($arguments);
-
-
+
-    
-    return $this;
@@ -766 +765 @@
-   *   $articleFinder->_or('CommentId', 3)
-   *    => $c->addOr(ArticlePeer::COMMENT_ID, 3)
+   *   $articleFinder->_or('Title', 'like', '%foo')
+   *    => $c->addOr(ArticlePeer::TITLE, '%foo', Criteria::LIKE)
-   *
-   * @param      string  $columnName PHPName of the column bearing the condition
-
+
+
-   *
-   * @return     sfPropelFinder the current finder object
-   */
-
-
+
+
+
+
-    $column = $this->getColName($columnName);
-    if(!is_array($arguments))
-    {
-      $arguments = func_get_args();
-      array_shift($arguments);
-    } 
-    list($value, $comparison) = sfPropelFinderUtils::getValueAndComparisonFromArguments($arguments);
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
-  {
-    $criterion = $this->criteria->getNewCriterion($column, $value, $comparison);
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-  /**
-   * We want that the Finder fuild Interface works like:
@@ -1093 +1141 @@
-    if(strpos($name, 'where') === 0)
-    {
-
+
+
-    }
-    if(strpos($name, 'orderBy') === 0)
@@ -1111 +1160 @@
-    if(strpos($name, '_and') === 0)
-    {
-
+
+
-    }
-    if(strpos($name, 'and') === 0)
-    {
-
+
+
+
-    }
-    if(strpos($name, '_or') === 0)
-    {
-
+
+
+
-    }
-    if(strpos($name, 'or') === 0)
-    {
-
+
+
-    }
-    if(strpos($name, 'findBy') === 0)

plugins/sfPropelFinderPlugin/test/unit/sfPropelFinderTest.php

@@ -65 +65 @@
-ArticlePeer::doDeleteAll();
-
-05
+13
-
-$t->diag('find()');
@@ -439 +439 @@
-try
-{
-
-wo
+, 'jkl'
+hree
-}
-catch (Exception $e)
-{
-wo
+hree
-}
-
@@ -461 +461 @@
-$baseSelect = "SELECT $columns FROM article WHERE ";
-
-
+
+
+
-$finder->find();
-$t->is(
@@ -469 +471 @@
-);
-
-
+
+
+
-$finder->find();
-$t->is(
@@ -477 +481 @@
-);
-
-
+
+
+
-$finder->find();
-$t->is(
@@ -485 +491 @@
-);
-
-
+
+
+
-$finder->find();
-$t->is(
@@ -493 +501 @@
-);
-
-
+
+
+
+
-$finder->find();
-$t->is(
@@ -523 +534 @@
-  '_or() works on a multiple jointure'
-);
+
+$t->diag('combine()');
+
+$columns    = "article.ID, article.VERSION, article.TITLE, article.CATEGORY_ID";
+$baseSelect = "SELECT $columns FROM article WHERE ";
+
+$finder = sfPropelFinder::from('Article')->
+  where('Title', '=', 'foo', 'cond1')->
+  where('Title', '=', 'bar');
+$finder->find();
+$t->is(
+  $finder->getLatestQuery(),
+  $baseSelect . "article.TITLE='bar'",
+  'where() called with a named condition does not affect the SQL until it is combined'
+);
+
+$finder = sfPropelFinder::from('Article')->
+  where('Title', '=', 'foo', 'cond1')->
+  where('Title', '=', 'bar', 'cond2')->
+  combine(array('cond1', 'cond2'), 'or');
+$finder->find();
+$t->is(
+  $finder->getLatestQuery(),
+  $baseSelect . "(article.TITLE='foo' OR article.TITLE='bar')",
+  'combine() combines conditions into the main criteria'
+);
+
+$finder = sfPropelFinder::from('Article')->
+  where('Title', '=', 'foo', 'cond1')->
+  where('Title', '=', 'bar', 'cond2')->
+  combine(array('cond1', 'cond2'), 'and');
+$finder->find();
+$t->is(
+  $finder->getLatestQuery(),
+  $baseSelect . "(article.TITLE='foo' AND article.TITLE='bar')",
+  'combine() combines conditions into the main criteria'
+);
+
+$finder = sfPropelFinder::from('Article')->
+  where('Title', '=', 'foo', 'cond1')->
+  where('Title', '=', 'bar', 'cond2')->
+  where('Title', '=', 'foobar')->
+  combine(array('cond1', 'cond2'), 'or');
+$finder->find();
+$t->is(
+  $finder->getLatestQuery(),
+  $baseSelect . "(article.TITLE='foobar' AND (article.TITLE='foo' OR article.TITLE='bar'))",
+  'combine() clauses live well with the usual conditions'
+);
+
+$finder = sfPropelFinder::from('Article')->
+  where('Title', '=', 'foo', 'cond1')->
+  where('Title', '=', 'bar', 'cond2')->
+  combine(array('cond1', 'cond2'), 'or')->
+  where('Title', '=', 'foobar');
+$finder->find();
+$t->is(
+  $finder->getLatestQuery(),
+  $baseSelect . "((article.TITLE='foo' OR article.TITLE='bar') AND article.TITLE='foobar')",
+  'combine() clauses live well with the usual conditions and appear ordered as they were called'
+);
+
+$finder = sfPropelFinder::from('Article')->
+  where('Title', '=', 'foo', 'cond1')->
+  where('Title', '=', 'bar', 'cond2')->
+  where('Title', '=', 'foobar', 'cond3')->
+  combine(array('cond1', 'cond2'), 'or', 'cond4')->
+  combine(array('cond4', 'cond3'), 'and');
+$finder->find();
+$t->is(
+  $finder->getLatestQuery(),
+  $baseSelect . "((article.TITLE='foo' OR article.TITLE='bar') AND article.TITLE='foobar')",
+  'combine() can return a named condition'
+);
+
+$finder = sfPropelFinder::from('Article')->
+  where('Title', '=', 'foo', 'cond1')->
+  where('Title', '=', 'bar', 'cond2')->
+  where('Title', '=', 'foobar', 'cond3')->
+  where('Title', '=', 'boofar', 'cond4')->
+  combine(array('cond1', 'cond2'), 'or', 'cond6')->
+  combine(array('cond3', 'cond4'), 'or', 'cond7')->
+  combine(array('cond6', 'cond7'), 'and');
+$finder->find();
+$t->is(
+  $finder->getLatestQuery(),
+  $baseSelect . "((article.TITLE='foo' OR article.TITLE='bar') AND (article.TITLE='foobar' OR article.TITLE='boofar'))",
+  'combine() allows for imbricated conditions'
+);
+
+$finder = sfPropelFinder::from('Article')->
+  where('Title', '=', 'foo', 'cond1')->
+  where('Title', '=', 'bar', 'cond2')->
+  where('Title', '=', 'foobar', 'cond3')->
+  combine(array('cond1', 'cond2', 'cond3'), 'or');
+$finder->find();
+$t->is(
+  $finder->getLatestQuery(),
+  $baseSelect . "((article.TITLE='foo' OR article.TITLE='bar') OR article.TITLE='foobar')",
+  'combine() can combine more than two conditions'
+);
+
-
-$t->diag('relatedTo()');