Changeset 10765

Timestamp:

08/11/08 11:01:20 (3 months 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;