Changeset 10344

Timestamp:

07/17/08 17:49:59 (5 years ago)

Author:

francois

Message:

sfPropelFinderPlugin Implemented sfDoctrineFinder::findBy(), findOneBy(), findPk(), and initialized where()

Files:

• plugins/sfPropelFinderPlugin/README (modified) (1 diff)
• plugins/sfPropelFinderPlugin/lib/DbFinder.php (modified) (4 diffs)
• plugins/sfPropelFinderPlugin/lib/DbFinderUtils.php (added)
• plugins/sfPropelFinderPlugin/lib/sfDoctrineFinder.php (modified) (4 diffs)
• plugins/sfPropelFinderPlugin/lib/sfPropelFinder.php (modified) (4 diffs)
• plugins/sfPropelFinderPlugin/lib/sfPropelFinderUtils.php (modified) (1 diff)
• plugins/sfPropelFinderPlugin/test/unit/DbFinderTest.php (added)
• plugins/sfPropelFinderPlugin/test/unit/sfDoctrineFinderTest.php (modified) (2 diffs)
• plugins/sfPropelFinderPlugin/test/unit/sfPropelFinderTest.php (modified) (3 diffs)

plugins/sfPropelFinderPlugin/README

@@ -603 +603 @@
-=== 2008-07-17 | Trunk ===
-
+ * francois: Implemented `sfDoctrineFinder::findBy()`, `findOneBy()`, `findPk()`, and initialized `where()`
- * francois: Added preliminary support for table aliases (`from('Article a')`) in Doctrine and Propel finders
- * francois: Implemented `sfDoctrineFinder::findOne()`, `findFirst()`, `findLast()` and `orderBy()`

plugins/sfPropelFinderPlugin/lib/DbFinder.php

@@ -49 +49 @@
-  public static function fromClass($class)
-  {
-
-
+
+
+
+
+
+
+
+
+
+
-    {
-      $finder = new sfPropelFinder($class);
-    }
-class
+tmp
-    {
-      $finder = new sfDoctrineFinder($class);
@@ -130 +138 @@
-          else
-          {
-FullyQualified
+Php
-          }
-        }
@@ -152 +160 @@
-      }
-    }
-
-    
-    return self::fromArray($pks, $class, $pkName);
@@ -168 +175 @@
-  {
-    $finder = self::fromClass($class);
-add($pkName, 'in
+where($pkName, ' in 
-    
-    return $finder;

plugins/sfPropelFinderPlugin/lib/sfDoctrineFinder.php

@@ -95 +95 @@
-  }
-  
-  /**
-   * Class initializer
-   *
-   * @param string $from Doctrine classname on which the search will be done
-   * @return sfDoctrineFinder a finder object
-   */
-  public static function fromClass($class)
-  {
-    $me = __CLASS__;
-    $finder = new $me($class);
-    
-    return $finder;
-  }
-  
-  
-  // Finder Executers
-  
@@ -163 +148 @@
-  public function findBy($columnName, $value, $limit = null, $con = null, $reinitCriteria = false)
-  {
-
+
+
+
+
-  }
-
-  public function findOneBy($columnName, $value, $con = null, $reinitCriteria = false)
-  {
-
+
+
+
+
-  }
-  
-  public function findPk($pk, $con = null)
-  {
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-  }
-  
@@ -239 +263 @@
-  
-  /**
+   * Finder Fluid Interface for Doctrine_Query::addWhere()
+   * Infers $column, $value, $comparison from $columnName and some optional arguments
+   * Examples:
+   *   $articleFinder->where('IsPublished')
+   *    => $query->addWhere('a.is_published = ?', array(true))
+   *   $articleFinder->where('CommentId', 3)
+   *    => $query->addwhere('a.comment_id = ?', array(3))
+   *   $articleFinder->where('Title', 'like', '%foo')
+   *    => $query->addWhere('a.title LIKE ?', array('%foo'))
-   *
-   * @param      string  $columnName PHPName of the column bearing the condition
@@ -249 +282 @@
-  public function where()
-  {
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-  }
-

plugins/sfPropelFinderPlugin/lib/sfPropelFinder.php

@@ -133 +133 @@
-    
-    return $this;
-  }
-  
-  // Finder Initializers
-  
-  /**
-   * Mixed initializer
-   * Accepts either a string (Propel class) or an array of Propel objects
-   *
-   * @param mixed $from The data to initialize the finder with
-   * @return sfPropelFinder a finder object
-   * @throws Exception If the data is neither a classname nor an array
-   */
-  public static function from($from)
-  {
-    if (is_string($from))
-    {
-      return self::fromClass($from);
-    }
-    if (is_array($from))
-    {
-      return self::fromCollection($from);
-    }
-    throw new Exception('sfPropelFinder::from() only accepts a Propel object classname or an array of Propel objects');
-  }
-
-  /**
-   * Class initializer
-   *
-   * @param string $from Propel classname on which the search will be done
-   * @return sfPropelFinder a finder object
-   */
-  public static function fromClass($class)
-  {
-    $me = __CLASS__;
-    $finder = new $me($class);
-    
-    return $finder;
-  }
-  
-  /**
-   * Collection initializer
-   *
-   * @param array $from Array of Propel objects of the same class
-   * @param string $class Optional classname of the desired objects
-   * @param string $class Optional column name of the primary key
-   *
-   * @return sfPropelFinder a finder object
-   * @throws Exception If the array is empty, contains not Propel objects or composite objects
-   */
-  public static function fromCollection($collection, $class = '', $pkName = '')
-  {
-    $pks = array();
-    foreach($collection as $object)
-    {
-      if($class != get_class($object))
-      {
-        if($class)
-        {
-          throw new Exception('A sfPropelFinder can only be initialized from an array of objects of a single class');
-        }
-        if($object instanceof BaseObject)
-        {
-          $class = get_class($object);
-        }
-        else
-        {
-          throw new Exception('A sfPropelFinder can only be initialized from an array of Propel objects');
-        }
-      }
-      $pks []= $object->getPrimaryKey();
-    }
-    if(!$class)
-    {
-      throw new Exception('A sfPropelFinder cannot be initialized with an empty array');
-    }
-    
-    $tempObject = new $class();
-    foreach ($tempObject->getPeer()->getTableMap()->getColumns() as $column)
-    {
-      if($column->isPrimaryKey())
-      {
-        if($pkName)
-        {
-          throw new Exception('A sfPropelFinder cannot be initialized from an array of objects with several foreign keys');
-        }
-        else
-        {
-          $pkName = $column->getFullyQualifiedName();
-        }
-      }
-    }
-    
-    return self::fromArray($pks, $class, $pkName);
-  }
-  
-  /**
-   * Array initializer
-   *
-   * @param array $array Array of Primary keys
-   * @param string $class Propel classname on which the search will be done
-   *
-   * @return sfPropelFinder a finder object
-   */
-  public static function fromArray($array, $class, $pkName)
-  {
-    $finder = self::fromClass($class);
-    $finder->add($pkName, $array, Criteria::IN);
-    
-    return $finder;
-  }
-  
@@ -742 +633 @@
-      $namedCondition = null;
-    }
-sfPropel
+Db
-    $this->addCondition('And', $column, $value, $comparison, $namedCondition);
-    
@@ -759 +650 @@
-    $columnName = array_shift($arguments);
-    $column = $this->getColName($columnName);
-sfPropel
+Db
-    $this->addCondition('And', $column, $value, $comparison);
-    
@@ -785 +676 @@
-    $columnName = array_shift($arguments);
-    $column = $this->getColName($columnName);
-sfPropel
+Db
-    $this->addCondition('Or', $column, $value, $comparison);
-    

plugins/sfPropelFinderPlugin/lib/sfPropelFinderUtils.php

@@ -45 +45 @@
-  }
-  
-  public static function getValueAndComparisonFromArguments($arguments = array())
-  {
-    $comparison = Criteria::EQUAL;
-    switch (count($arguments))
-    {
-      case 0:
-        $value = true;
-        break;
-      case 1:
-        $value = array_shift($arguments);
-        break;
-      case 2:
-        $comparison = array_shift($arguments);
-        $comparisonUp = trim(strtoupper($comparison));
-        if(in_array($comparisonUp, array('LIKE', 'NOT LIKE', 'ILIKE', 'NOT ILIKE', 'IN', 'NOT IN', 'IS NULL', 'IS NOT NULL')))
-        {
-          $comparison = ' '.$comparisonUp.' ';
-        }
-        $value = array_shift($arguments);
-        break;
-      default:
-        throw new Exception('sfPropelFinder::whereXXX() can only be called with one or two arguments');
-    }
-
-    return array($value, $comparison);
-  }
-  
-  public static function getPeerClassFromClass($class)
-  {

plugins/sfPropelFinderPlugin/test/unit/sfDoctrineFinderTest.php

@@ -64 +64 @@
-Doctrine_Query::create()->delete()->from('DArticle')->execute();
-
-18
+36
-
-$t->diag('find()');
@@ -156 +156 @@
-$t->isa_ok($article, 'DArticle', 'findLast() returns a single object');
-$t->is($article->getTitle(), 'foo2', 'findLast() returns the last object matching the conditions');
+
+$t->diag('findBy() and findOneBy()');
+
+Doctrine_Query::create()->delete()->from('DArticle')->execute();
+
+$article1 = new DArticle();
+$article1->setTitle('foo');
+$article1->save();
+
+$article2 = new DArticle();
+$article2->setTitle('foo2');
+$article2->save();
+
+$article3 = new DArticle();
+$article3->setTitle('foo');
+$article3->save();
+
+$articles = sfDoctrineFinder::from('DArticle')->findBy('Title', 'foo');
+$t->is(count($articles), 2, 'findBy() adds a condition on a given column');
+foreach ($articles as $article)
+{
+  $t->is($article->getTitle(), 'foo', 'findBy() adds a condition on a given column');
+}
+
+$articles = sfDoctrineFinder::from('DArticle')->findBy('Title', 'foo', 1);
+$t->is(count($articles), 1, 'findBy() accepts a limit parameter');
+
+$article = sfDoctrineFinder::from('DArticle')->findOneBy('Title', 'foo2');
+$t->is($article->getTitle(), 'foo2', 'findOneBy() adds a condition on a given column');
+
+$articles = sfDoctrineFinder::from('DArticle')->findByTitle('foo');
+$t->is(count($articles), 2, 'findByXXX() adds a condition on a given column');
+foreach ($articles as $article)
+{
+  $t->is($article->getTitle(), 'foo', 'findByXXX() adds a condition on a given column');
+}
+
+$articles = sfDoctrineFinder::from('DArticle')->findByTitle('foo', 1);
+$t->is(count($articles), 1, 'findByXXX() accepts a limit parameter');
+
+$article = sfDoctrineFinder::from('DArticle')->findOneByTitle('foo2');
+$t->is($article->getTitle(), 'foo2', 'findOneByXXX() adds a condition on a given column');
+
+$t->diag('findPk()');
+
+Doctrine_Query::create()->delete()->from('DArticle')->execute();
+
+$article1 = new DArticle();
+$article1->setTitle('foo');
+$article1->save();
+
+$article2 = new DArticle();
+$article2->setTitle('foo2');
+$article2->save();
+
+$article3 = new DArticle();
+$article3->setTitle('foo3');
+$article3->save();
+
+$finder = new sfDoctrineFinder('DArticle');
+$article = $finder->findPk($article2->getId());
+$t->is($article->getTitle(), 'foo2', 'findPk() returns the object with the primary key matching the argument');
+$t->ok(!is_array($article), 'findPk() returns a single object when passed a single primary key');
+$finder = new sfDoctrineFinder('DArticle');
+$article = $finder->findPk(76543787654);
+$t->is($article, null, 'findPk() returns null if the primary key is not found');
+$finder = new sfDoctrineFinder('DArticle');
+$articles = $finder->findPk(array($article2->getId(), $article1->getId()));
+$t->isa_ok($articles, 'Doctrine_Collection', 'findPk() returns a collection of objects when passed an array of primary keys');
+$t->is(count($articles), 2, 'findPk() returns the objects with the primary keys matching the arguments');
+
+$t->skip('findPk() is compatible with with()');
+//$article = $finder->with('Category')->findPk($article2->getId());
+//$t->cmp_ok(strpos($finder->getLatestQuery(), 'SELECT article.ID, article.VERSION, article.TITLE, article.CATEGORY_ID, category.ID, category.NAME FROM article, category'), '===', 0, 'findPk() is compatible with with()');
+
+Doctrine_Query::create()->delete()->from('DArticle')->execute();
+
+$article1 = new DArticle();
+$article1->setTitle('foo');
+$article1->save();
+$articlei18n1 = new DArticleI18n();
+$articlei18n1->setCulture('fr');
+$articlei18n1->setContent('Bar');
+$articlei18n1->setId($article1->getId());
+$articlei18n1->save();
+try
+{
+  $articleI18n = sfDoctrineFinder::from('DArticleI18n')->findPk($articlei18n1->getId());
+  $t->fail('findPk() expects an array of values for objects with composite primary keys');
+}
+catch(Exception $e)
+{
+  $t->pass('findPk() expects an array of values for objects with composite primary keys');
+}
+$articleI18n = sfDoctrineFinder::from('DArticleI18n')->findPk(array($articlei18n1->getId(), $articlei18n1->getCulture()));
+$t->is_deeply($articleI18n->toArray(), $articlei18n1->toArray(), 'findPk() retrieves objects with composite primary keys based on an array of Pks');

plugins/sfPropelFinderPlugin/test/unit/sfPropelFinderTest.php

@@ -65 +65 @@
-ArticlePeer::doDeleteAll();
-
-5
+6
-
-$t->diag('find()');
@@ -156 +156 @@
-$t->is($article->getTitle(), 'foo2', 'findLast() returns the last object matching the conditions');
-
-
+()
-
-ArticlePeer::doDeleteAll();
@@ -411 +411 @@
-$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');
+$articles = sfPropelFinder::from('Article')->where('Title', ' in ', array('abc', 'def'))->find();
+$t->is(count($articles), 2, 'where() accepts a "in" comparator');
-try
-{