Changeset 10118

Timestamp:

07/04/08 14:50:48 (5 months ago)

Author:

francois

Message:

sfPropelFinderPlugin Cleaning up:

• Added a prove.php test file to launch all tests at once in a test harness
  
• Moved utility methods as static methods of a third-party class to take some weight off the main class
  
• Expanded TODO a bit
  

Files:

• plugins/sfPropelFinderPlugin/README (modified) (1 diff)
• plugins/sfPropelFinderPlugin/lib/sfPropelFinder.php (modified) (19 diffs)
• plugins/sfPropelFinderPlugin/lib/sfPropelFinderUtils.php (added)
• plugins/sfPropelFinderPlugin/package.xml (modified) (1 diff)
• plugins/sfPropelFinderPlugin/test/prove.php (added)

plugins/sfPropelFinderPlugin/README

@@ -473 +473 @@
-}}}
-
-
+/ Ideas 
-
- * Put as a parent class in the PeerBuilder so that every Peer class can be a finder
- * Merge with sfPropelImpersonatorPlugin!
- * Add support for `with()` in `findPk()` (and document the method)
+ * Add the ability to do left, right, inner joins, etc.
+ * Make `join()` useless if there is an explicit `where()` on the table afterwards
+ * Change `with()` and `join()` to accept only one relation at a time, but with the ability to set the local and foreign parts of the relation. maybe replace the current multiple ability of these methods by `joins()` and `withs()`
+ * 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
+ * Column finder, which provides an easy interface to Creole (and PDO) for retrieval of columns instead of objects?
-
-== Changelog ==
-
-
-
+
+
+
+
- * francois: Preferring `ClassName.ColumnName` over `ClassName.ColumnName` for complete column names
- * francois: Added Propel 1.3 compatibility

plugins/sfPropelFinderPlugin/lib/sfPropelFinder.php

@@ -423 +423 @@
-    }
-  }
-  
-  
-  public function doFind($criteria, $con = null)
@@ -497 +496 @@
-            }
-          }
-$this->
+sfPropelFinderUtils::
-          $objectsInJoin []= $withObj;
-          if ($isNewObject)
@@ -555 +554 @@
-      call_user_func(array($tempClass->getPeer(), 'addSelectColumns'), $c);
-      // if join() wasn't called previously on this class, do a simple join
-$this->
+sfPropelFinderUtils::
-      {
-        list($column1, $column2) = $this->getRelation($className);
-        $c->addJoin($column1, $column2);
-$this->
+sfPropelFinderUtils::
-      }
-    }
@@ -570 +569 @@
-      if($peerClass && !in_array($peerClass, $this->relations))
-      {
-$this->
+sfPropelFinderUtils::
-        $c->addJoin($column1, $column2);
-        $this->relations[]= $peerClass;
@@ -578 +577 @@
-    
-    return $c;
-  }
-  
-  protected function relateObjects($new, $existingObjects, $isNew)
-  {
-    // brute force (to be optimized later)
-    foreach ($existingObjects as $existingObject)
-    {
-      $methodName = 'add'.get_class($existingObject);
-      if(method_exists($new, $methodName))
-      {
-        if($isNew)
-        {
-          call_user_func(array($new, 'init'.get_class($existingObject).'s'));
-        }
-        call_user_func(array($new, $methodName), $existingObject);
-        break;
-      }
-    }
-  }
-  
@@ -701 +682 @@
-      array_shift($arguments);
-    } 
-$this->
+sfPropelFinderUtils::
-
-    $this->addCondition('and', $column, $value, $comparison );
@@ -728 +709 @@
-      array_shift($arguments);
-    } 
-$this->
+sfPropelFinderUtils::
-
-    $this->addCondition('and', $column, $value, $comparison);
@@ -755 +736 @@
-      array_shift($arguments);
-    } 
-$this->
+sfPropelFinderUtils::
-    $this->addCondition('or', $column, $value, $comparison);
-    
@@ -798 +779 @@
-  }
-  
-  protected 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);
-  }
-  
-  /**
-   * Finder fluid method to restrict results to a related object
@@ -834 +788 @@
-  {
-    $relatedObjectTableName = $object->getPeer()->getTableMap()->getName();
-$this->
+sfPropelFinderUtils::
-    {
-      if($c->getRelatedTableName() == $relatedObjectTableName)
@@ -912 +866 @@
-  {
-    $columnNames = array();
-$this->
+sfPropelFinderUtils::
-    {
-      $columnNames []= $c->getPhpName();
@@ -941 +895 @@
-  {
-    list($column1, $column2) = $this->getRelation($relatedClass);
-$this->
+sfPropelFinderUtils::
-    if(!is_array($arguments))
-    {
@@ -968 +922 @@
-      // try to find one to many relationship
-      if($relation = $this->findRelation(
-$this->
-$this->
+sfPropelFinderUtils::
+sfPropelFinderUtils::
-      {
-        return array_reverse($relation);
@@ -979 +933 @@
-  protected function findRelation($phpName, $peerClass)
-  {
-$this->
+sfPropelFinderUtils::
-    {
-      if ($c->isForeignKey())
@@ -985 +939 @@
-        if(!$this->databaseMap->containsTable($c->getRelatedTableName()))
-        {
-$this->
+sfPropelFinderUtils::
-          $mapBuilder->doBuild();
-        }
@@ -1001 +955 @@
-  }
-  
-  protected function getPeerClassFromClass($class)
-  {
-    $tmp = new $class();
-    return get_class($tmp->getPeer());
-    $tmp->__destroy();
-  }
-
-  protected function getClassFromPeerClass($peerClass)
-  {
-    $omClass = call_user_func(array($peerClass, 'getOMClass'));
-    return substr('.'.$omClass, strrpos('.'.$omClass, '.') + 1);
-  }
-  
-  /**
-   * Behavior-like supplementary getter for supplementary columns added by way of withColumn()
@@ -1039 +980 @@
-  }
-  
-  protected function getColumnsForPeerClass($peerClass)
-  {
-    if(class_exists($peerClass))
-    {
-      $tableMap = call_user_func(array($peerClass, 'getTableMap'));
-      return $tableMap->getColumns();
-    }
-    return false;
-  }
-  
-  protected function getColName($phpName, $peerClass = null, $withPeerClass = false)
-  {
@@ -1059 +990 @@
-      // Table.Column
-      list($class, $phpName) = explode('.', $phpName);
-$this->
+sfPropelFinderUtils::
-    }
-    else if(strpos($phpName, '_') !== false)
@@ -1067 +998 @@
-      $class = substr($phpName, 0, $limit);
-      $phpName = substr($phpName, $limit + 1);
-$this->
+sfPropelFinderUtils::
-    }
-    if(!$peerClass)

plugins/sfPropelFinderPlugin/package.xml

@@ -29 +29 @@
-        <file name="sfPropelFinder.php" role="data"/>
-        <file name="sfPropelFinderPager.php" role="data"/>
+        <file name="sfPropelFinderUtils.php" role="data"/>
-      </dir>
-    </dir>