Changeset 9948

Timestamp:

06/27/08 23:18:57 (3 months ago)

Author:

francois

Message:

sfPropelFinderPlugin sfPropelFinder::from() now accepts an array of Propel objects

Files:

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

plugins/sfPropelFinderPlugin/README

@@ -172 +172 @@
-
-Compare it to the code required to get these `Comment` objects without `sfPropelFinder`, and you will understand all the benefits the `relatedTo()` method provide.
+
+Tip: Alternatively, a finder can be initialized from an array of Propel object. The resulting SQL query contains a 'IN ()' clause, so use this possibility with caution.
+
+{{{
+#!php
+<?php
+// Retrieving the last one of the related comments
+$comments = sfPropelFinder::from($article->getComments())->
+  findLast();
+}}}
-
-=== Joins ===
@@ -393 +403 @@
-=== 2008-06-27 | Trunk ===
-
+ * francois: `sfPropelFinder::from()` now accepts an array of Propel objects
- * francois: Added `sfPropelFinder::findByXXX()` and `sfPropelFinder::findOneByXXX()` methods
- * francois: Added `sfPropelFinder::relatedTo()` method

plugins/sfPropelFinderPlugin/lib/sfPropelFinder.php

@@ -127 +127 @@
-  // Finder Initializers
-  
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-  {
-    $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 finder 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 finder can only be initialized from an array of Propel objects');
+        }
+      }
+      $pks []= $object->getPrimaryKey();
+    }
+    if(!$class)
+    {
+      throw new Exception('A finder 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 finder 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;

plugins/sfPropelFinderPlugin/test/unit/sfPropelFinderTest.php

@@ -63 +63 @@
-ArticlePeer::doDeleteAll();
-
-2
+6
-
-$t->diag('find()');
@@ -249 +249 @@
-$finder = new ArticleFinder();
-$article = $finder->findOne();
-(get_class($article)
+a_ok($article
-$finder = new ArticleFinder();
-$articles = $finder->find();
-$t->is(count($articles), 3, 'A finder extending sfPropelFinder can be used directly if defining the $peerClass property');
+
+ArticlePeer::doDeleteAll();
+CategoryPeer::doDeleteAll();
+$category1 = new Category();
+$category1->setName('cat1');
+$category1->save();
+$category2 = new Category();
+$category2->setName('cat2');
+$category2->save();
+$article1 = new Article();
+$article1->setTitle('aaaaa');
+$article1->setCategory($category1);
+$article1->save();
+$article2 = new Article();
+$article2->setTitle('bbbbb');
+$article2->setCategory($category1);
+$article2->save();
+$article3 = new Article();
+$article3->setTitle('ccccc');
+$article3->setCategory($category2);
+$article3->save();
+
+$finder = sfPropelFinder::from($category1->getArticles());
+$articles = $finder->find();
+$t->is(count($articles), 2, 'from() accepts an array of Propel objects');
+$t->isnt(
+  strpos($finder->getLatestQuery(), "WHERE article.ID IN ("),
+  false,
+  'using from() with an array of Propel objects results in a Criteria::IN'
+);
+$t->isa_ok($finder->findOne(), 'Article', 'using from() with an array of Propel objects returns some of these objects');
+$articles = sfPropelFinder::from($category1->getArticles())->where('Title', 'aaaaa')->find();
+$t->is(count($articles), 1, 'A finder initialized from an array accepts further conditions');
-
-$t->diag('count()');