Changeset 10047

Timestamp:

07/01/08 18:49:24 (5 years ago)

Author:

francois

Message:

sfPropelFinderPlugin Added sfPropelFinderPager class, sfPropelFinder::paginate() and sfPropelFinder::groupBy() methods

Files:

• plugins/sfPropelFinderPlugin/README (modified) (2 diffs)
• plugins/sfPropelFinderPlugin/lib/sfPropelFinder.php (modified) (6 diffs)
• plugins/sfPropelFinderPlugin/lib/sfPropelFinderPager.php (added)
• plugins/sfPropelFinderPlugin/package.xml (modified) (1 diff)
• plugins/sfPropelFinderPlugin/test/unit/sfPropelFinderPagerTest.php (added)

plugins/sfPropelFinderPlugin/README

@@ -329 +329 @@
-}}}
-
+=== Getting a paginated list of results ===
+
+{{{
+#!php
+<?php
+// Getting an initialized sfPropelPager object
+$pager = sfPropelFinder::from('Article')->paginate($currentPage = 1, $maxResultsPerPage = 10);
+// You can use the pager object as usual
+printf("Showing results %d to %d on %d\n",
+  $pager->getfirstIndice(),
+  $pager->getLastIndice(),
+  $pager->getNbResults());
+foreach($pager->getResuts() as $article)
+{
+  echo $article->getTitle();
+}
+}}}
+
-=== Deleting objects ===
-
@@ -401 +419 @@
-== Changelog ==
-
-
-
+
+
+
+
- * francois: `sfPropelFinder::from()` now accepts an array of Propel objects
- * francois: Added `sfPropelFinder::findByXXX()` and `sfPropelFinder::findOneByXXX()` methods

plugins/sfPropelFinderPlugin/lib/sfPropelFinder.php

@@ -12 +12 @@
-class sfPropelFinder
-{
+  protected $class = null;
-  protected $peerClass = null;
-  protected $databaseMap = null;
@@ -26 +27 @@
-    if($class)
-    {
-
+
+
+
-    }
-    if($this->peerClass)
@@ -307 +310 @@
-    return $this->findOne($con, $reinitCriteria);
-  }
-
-  protected function guessOrder($direction = 'desc')
-  {
-    $columnNames = array();
-    foreach ($this->getColumnsForPeerClass($this->getPeerClass()) as $c)
-    {
-      $columnNames []= $c->getPhpName();
-    }
-    foreach(sfConfig::get('app_sfPropelFinder_sort_column_guesses', array('UpdatedAt', 'UpdatedOn', 'CreatedAt', 'CreatedOn', 'Id')) as $testColumnName)
-    {
-      if(in_array($testColumnName, $columnNames))
-      {
-        $this->orderBy($testColumnName, $direction);
-        return;
-      }
-    }
-    
-    throw new Exception('Unable to figure out the column to use to order rows');
-  }
-  
-  public function findBy($columnName, $value, $limit = null, $con = null, $reinitCriteria = false)
@@ -356 +340 @@
-    
-    return $ret;
+  }
+  
+  public function delete($con = null, $reinitCriteria = true)
+  {
+    $deleteCriteria = $this->getCriteria();
+    if($deleteCriteria->equals(new Criteria()))
+    {
+      // delete will delete nothing when passed an empty criteria
+      // while it should, in fact, delete all
+      $fieldNames = call_user_func(array($this->getPeerClass(), 'getFieldNames'), BasePeer::TYPE_COLNAME);
+      $firstFieldName = $fieldNames[0];
+      $deleteCriteria->add($firstFieldName, true, Criteria::BINARY_OR);
+    }
+    $ret = call_user_func(array($this->getPeerClass(), 'doDelete'), $deleteCriteria, $con);
+    $this->updateLatestQuery();
+    if($reinitCriteria)
+    {
+      $this->reinitCriteria();
+    }
+    
+    return $ret;
+  }
+  
+  public function paginate($page = 1, $maxPerPage = 10, $con = null)
+  {
+    $pager = new sfPropelFinderPager($this->class, $maxPerPage);
+    $pager->setFinder($this);
+    $pager->setConnection($con);
+    $pager->setPage($page);
+    $pager->init();
+    
+    return $pager;
-  }
-  
@@ -494 +510 @@
-  }
-  
-  public function delete($con = null, $reinitCriteria = true)
-  {
-    $deleteCriteria = $this->getCriteria();
-    if($deleteCriteria->equals(new Criteria()))
-    {
-      // delete will delete nothing when passed an empty criteria
-      // while it should, in fact, delete all
-      $fieldNames = call_user_func(array($this->getPeerClass(), 'getFieldNames'), BasePeer::TYPE_COLNAME);
-      $firstFieldName = $fieldNames[0];
-      $deleteCriteria->add($firstFieldName, true, Criteria::BINARY_OR);
-    }
-    $ret = call_user_func(array($this->getPeerClass(), 'doDelete'), $deleteCriteria, $con);
-    $this->updateLatestQuery();
-    if($reinitCriteria)
-    {
-      $this->reinitCriteria();
-    }
-    
-    return $ret;
-  }
-  
-  // Hydrating
-  
@@ -780 +775 @@
-    return $this;
-  }
+
+  /**
+   * Finder Fluid Interface for Criteria::addGroupByColumn()
+   * Infers $column and $order from $columnName and some optional arguments
+   * Examples:
+   *   $articleFinder->groupBy('CreatedAt')
+   *    => $c->addGroupByColumn(ArticlePeer::CREATED_AT)
+   */
+  public function groupBy($columnName)
+  {
+    $column = $this->getColName($columnName);
+    $this->criteria->addGroupByColumn($column);
+    
+    return $this;
+  }
+  
+  /**
+   * Guess sort column based on their names
+   * Will look primarily for columns named:
+   * 'UpdatedAt', 'UpdatedOn', 'CreatedAt', 'CreatedOn', 'Id'
+   * You can change this sequence by modifying the app_sfPropelFinder_sort_column_guesses value
+   *
+   * @param string $direction 'desc' (default) or 'asc'
+   *
+   * @return sfPropelFinder $this the current finder object
+   */
+  public function guessOrder($direction = 'desc')
+  {
+    $columnNames = array();
+    foreach ($this->getColumnsForPeerClass($this->getPeerClass()) as $c)
+    {
+      $columnNames []= $c->getPhpName();
+    }
+    foreach(sfConfig::get('app_sfPropelFinder_sort_column_guesses', array('UpdatedAt', 'UpdatedOn', 'CreatedAt', 'CreatedOn', 'Id')) as $testColumnName)
+    {
+      if(in_array($testColumnName, $columnNames))
+      {
+        $this->orderBy($testColumnName, $direction);
+        return $this;
+      }
+    }
+    
+    throw new Exception('Unable to figure out the column to use to order rows');
+  }
-  
-  /**

plugins/sfPropelFinderPlugin/package.xml

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