Changeset 10765

Timestamp:

08/11/08 11:01:20 (5 years ago)

Author:

francois

Message:

sfPropelFinderPlugin Refactoring

• Added abstract sfModelFinder class to keep all abstract methods out of DbFinder
  
• Refactored DbFinder to allow agnostic finders on model objects to extend it
  
• Fixed problem with lacking PHPDoc on DbFinder methods
  
• Now custom finders must extend DbFinder to be ORM agnostic
  

Files:

• plugins/sfPropelFinderPlugin/README (modified) (2 diffs)
• plugins/sfPropelFinderPlugin/lib/DbFinder.php (modified) (5 diffs)
• plugins/sfPropelFinderPlugin/lib/DbFinderUtils.php (deleted)
• plugins/sfPropelFinderPlugin/lib/sfDoctrineFinder.php (modified) (4 diffs)
• plugins/sfPropelFinderPlugin/lib/sfModelFinder.php (added)
• plugins/sfPropelFinderPlugin/lib/sfPropelFinder.php (modified) (5 diffs)
• plugins/sfPropelFinderPlugin/test/unit/DbFinderTest.php (modified) (4 diffs)

plugins/sfPropelFinderPlugin/README

@@ -447 +447 @@
-### Writing your own business logic into a finder
-
- or its adapters ('sfPropelFinder`, `sfDoctrineFinder`) and to define a protected `$class` property. 
-
-PropelFinder` to retrieve Propel `Article` objects. This new finder has access to a protected `$criteria` property, which
-
-sfPropel
+, and to define a protected `$class` property.
+
+ModelFinder` to retrieve Propel `Article` objects. This new finder has access to a protected query object by way of `getQueryObject()`. This object
+
+Db
-    {
-      protected $class = 'Article';
@@ -531 +531 @@
----------
-
-
-
+
+
+
+
-* francois: Implemented `sfDoctrineFinder::delete()`
-* francois: Turned README into Markdown syntax, and changed the main name to `DbFinder`

plugins/sfPropelFinderPlugin/lib/DbFinder.php

@@ -9 +9 @@
- * file that was distributed with this source code.
- */
-
-
+
+
+
+
+
+
+
+
+
-{
-  const 
@@ -16 +23 @@
-    PROPEL   = "Propel";
-  
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    }
-  }
-  
-  // Finder Initializers
-
+
-  /**
-   * Mixed initializer
-Propel class) or an array of Prop
+Model object class) or an array of mod
-   *
-   * @param mixed $from The data to initialize the finder with
@@ -55 +112 @@
-  
-  /**
+   * Array initializer
+   *
+   * @param array $array Array of Primary keys
+   * @param string $class Model classname on which the search will be done
+   *
+   * @return DbFinder a finder object
+   */
+  public static function fromArray($array, $class, $pkName)
+  {
+    $finder = self::fromClass($class);
+    $finder->where($pkName, 'in', $array);
+    
+    return $finder;
+  }
+  
+  /**
-   * Class initializer
-   *
@@ -72 +145 @@
-      $realClass = $class;
-    }
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    {
-      $tmp = new $realClass;
@@ -88 +179 @@
-      }
-    }
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-      {
-
-
-
-
-
+
-      }
-      else
-      {
-throw new Exception('DbFinder::fromClass() only accepts a model object of a finder classname'
+return self::fromClass($class
-      }
-    }
-    
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
-    }
-    else
-    {
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
-  }
-  
-  // Finder accessors
-  
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-  
-  // Finder executers
-  
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-  // Hydrating
-  
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-  
-  // Finder Filters
-  
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-  
-  // Finder utilities
-  
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-}

plugins/sfPropelFinderPlugin/lib/sfDoctrineFinder.php

@@ -10 +10 @@
- */
- 
-Db
+sfModel
-{
-  protected
@@ -18 +18 @@
-    $object        = null,
-    $reinit        = true,
+    $query         = null,
-    $queryListener = null,
-    $withClasses   = array(),
@@ -60 +61 @@
-    return $this;
-  }
+  
+  public function getQuery()
+  {
+    return $this->query;
+  }
+  
+  // Finder initializers
+  
+  /**
+   * Mixed initializer
+   * Accepts either a string (Model object class) or an array of model objects
+   *
+   * @param mixed $from The data to initialize the finder with
+   * @param mixed $connection Optional connection object
+   *
+   * @return sfPropelFinder a finder object
+   * @throws Exception If the data is neither a classname nor an array
+   */
+  public static function from($from, $connection = null)
+  {
+    if (is_string($from))
+    {
+      return self::fromClass($from, $connection);
+    }
+    if (is_array($from) || $from instanceof Doctrine_Collection)
+    {
+      return self::fromCollection($from);
+    }
+    throw new Exception('sfPropelFinder::from() only accepts a model object classname or an array of model objects');
+  }
+  
+  /**
+   * Array initializer
+   *
+   * @param array $array Array of Primary keys
+   * @param string $class Model 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->where($pkName, 'in', $array);
+    
+    return $finder;
+  }
+  
+  /**
+   * Class initializer
+   *
+   * @param string $from Model classname on which the search will be done
+   * @param mixed $connection Optional connection object
+   *
+   * @return sfDoctrineFinder a finder object
+   */
+  public static function fromClass($class, $connection = null)
+  {
+    if(strpos($class, ' ') !== false)
+    {
+      list($realClass, $alias) = explode(' ', $class);
+    }
+    else
+    {
+      $realClass = $class;
+    }
+    if(class_exists($realClass))
+    {
+      $tmp = new $realClass;
+      if($tmp instanceof Doctrine_Record)
+      {
+        $me = __CLASS__;
+        $finder = new $me($class, $connection);
+      }
+      else
+      {
+        throw new Exception('sfDoctrineFinder::fromClass() only accepts a Doctrine model classname');
+      }
+    }
+    else
+    {
+       throw new Exception('sfDoctrineFinder::fromClass() only accepts a Doctrine model classname');
+    }
+    
+    return $finder;
+  }
+  
+  /**
+   * Collection initializer
+   *
+   * @param array $from Array of model 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 sfDoctrineFinder a finder object
+   * @throws Exception If the array is empty, contains not model 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 sfDoctrineFinder can only be initialized from an array of objects of a single class');
+        }
+        if($object instanceof Doctrine_Record)
+        {
+          $class = get_class($object);
+        }
+        else
+        {
+          throw new Exception('A sfDoctrineFinder can only be initialized from an array of Doctrine objects');
+        }
+      }
+      $identifier = array_values($object->identifier());
+      if(count($identifier) == 1)
+      {
+        $identifier = array_shift($identifier);
+      }
+      $pks []= $identifier;
+    }
+    if(!$class)
+    {
+      throw new Exception('A sfDoctrineFinder cannot be initialized with an empty array');
+    }
+    $tempObject = new $class();
+    foreach ($tempObject->getTable()->getColumns() as $name => $column)
+    {
+      if(array_key_exists('primary', $column))
+      {
+        if($pkName)
+        {
+          throw new Exception('A sfDoctrineFinder cannot be initialized from an array of objects with several foreign keys');
+        }
+        else
+        {
+          $pkName = $name;
+        }
+      }
+    }
+    
+    return self::fromArray($pks, $class, $pkName);
+  }
+  
-  
-  public function initialize($connection, $class, $alias)
@@ -521 +668 @@
-      $namedCondition = null;
-    }
-DbFinderUtils
+self
-    $this->addCondition($column, $comparison, $value);
-    

plugins/sfPropelFinderPlugin/lib/sfPropelFinder.php

@@ -10 +10 @@
- */
- 
-Db
+sfModel
-{
-  protected 
@@ -59 +59 @@
-    return $this;
-  }
+
+  // Finder Initializers
+  
+  /**
+   * Mixed initializer
+   * Accepts either a string (Model object class) or an array of model objects
+   *
+   * @param mixed $from The data to initialize the finder with
+   * @param mixed $connection Optional connection object
+   *
+   * @return sfPropelFinder a finder object
+   * @throws Exception If the data is neither a classname nor an array
+   */
+  public static function from($from, $connection = null)
+  {
+    if (is_string($from))
+    {
+      return self::fromClass($from, $connection);
+    }
+    if (is_array($from) || $from instanceof Doctrine_Collection)
+    {
+      return self::fromCollection($from);
+    }
+    throw new Exception('sfPropelFinder::from() only accepts a model object classname or an array of model objects');
+  }
+  
+  /**
+   * Array initializer
+   *
+   * @param array $array Array of Primary keys
+   * @param string $class Model 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->where($pkName, 'in', $array);
+    
+    return $finder;
+  }
+  
+  /**
+   * Class initializer
+   *
+   * @param string $from Model classname on which the search will be done
+   * @param mixed $connection Optional connection object
+   *
+   * @return sfPropelFinder a finder object
+   */
+  public static function fromClass($class, $connection = null)
+  {
+    if(strpos($class, ' ') !== false)
+    {
+      list($realClass, $alias) = explode(' ', $class);
+    }
+    else
+    {
+      $realClass = $class;
+    }
+    if(class_exists($realClass))
+    {
+      $tmp = new $realClass;
+      if($tmp instanceof BaseObject)
+      {
+        $me = __CLASS__;
+        $finder = new $me($class, $connection);
+      }
+      else
+      {
+        throw new Exception('sfPropelFinder::fromClass() only accepts a Propel model classname');
+      }
+    }
+    else
+    {
+       throw new Exception('sfPropelFinder::fromClass() only accepts a Propel model classname');
+    }
+    
+    return $finder;
+  }
+  
+  /**
+   * Collection initializer
+   *
+   * @param array $from Array of model 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 model 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->getPhpName();
+        }
+      }
+    }
+    
+    return self::fromArray($pks, $class, $pkName);
+  }
+  
-
-  public function initialize()
@@ -821 +957 @@
-      $namedCondition = null;
-    }
-DbFinderUtils
+self
-    $this->addCondition('And', $column, $value, $comparison, $namedCondition);
-    
@@ -839 +975 @@
-    $columnName = array_shift($arguments);
-    $column = $this->getColName($columnName);
-DbFinderUtils
+self
-    $this->addCondition('And', $column, $value, $comparison);
-    
@@ -865 +1001 @@
-    $columnName = array_shift($arguments);
-    $column = $this->getColName($columnName);
-DbFinderUtils
+self
-    $this->addCondition('Or', $column, $value, $comparison);
-    

plugins/sfPropelFinderPlugin/test/unit/DbFinderTest.php

@@ -61 +61 @@
-ArticlePeer::doDeleteAll();
-
-9
+18
-
-$t->diag('from()');
@@ -71 +71 @@
-$finder = DbFinder::from('DArticle');
-$article = $finder->findOne();
-
+
+
-$t->ok($article instanceof Doctrine_Record, 'A DbFinder initialized from a Doctrine class returns Doctrine_Record objects');
-
@@ -80 +81 @@
-$finder = DbFinder::from('Article');
-$article = $finder->findOne();
-
+
+
-$t->ok($article instanceof BaseObject, 'A DbFinder initialized from a Propel class returns BaseObject objects');
-
@@ -114 +116 @@
-$t->is($finderAsHtml, $expected, 'toHTML() executes the finder and returns a string with an HTML table with column phpNames as column headers');
-
-fooFinder extends sfPropel
+ArticleFinder extends Db
-{
-  protected $class = 'Article';
+  
+  public function published()
+  {
+    return $this;
+  }
-}
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+