From 7c44b8bc211c768efdb3be75c5a7057bf0e5663e Mon Sep 17 00:00:00 2001
From: =?utf8?q?Rapha=C3=ABl=20Barrois?= <raphael.barrois@polytechnique.org>
Date: Mon, 23 Aug 2010 00:14:39 +0200
Subject: [PATCH] Add "groups" to PlFilter.
MIME-Version: 1.0
Content-Type: text/plain; charset=utf8
Content-Transfer-Encoding: 8bit

Would return the list of (name, nb_res) for a given field

Signed-off-by: Raphaël Barrois <raphael.barrois@polytechnique.org>
---
 classes/plfilter.php | 38 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 38 insertions(+)

diff --git a/classes/plfilter.php b/classes/plfilter.php
index 7771fa4..c1139df 100644
--- a/classes/plfilter.php
+++ b/classes/plfilter.php
@@ -152,12 +152,18 @@ class PlSqlJoin
 // }}}
 
 // {{{ class PlFilterOrder
+/** Base class for ordering results of a query.
+ * Parameters for the ordering must be given to the constructor ($desc for a
+ *     descending order).
+ * The getSortTokens function is used to get actual ordering part of the query.
+ */
 abstract class PlFilterOrder
 {
     protected $desc = false;
     public function __construct($desc = false)
     {
         $this->desc = $desc;
+        $this->_tokens = null;
     }
 
     public function toggleDesc()
@@ -173,6 +179,7 @@ abstract class PlFilterOrder
     public function buildSort(PlFilter &$pf)
     {
         $sel = $this->getSortTokens($pf);
+        $this->_tokens = $sel;
         if (!is_array($sel)) {
             $sel = array($sel);
         }
@@ -184,10 +191,31 @@ abstract class PlFilterOrder
         return $sel;
     }
 
+    /** This function must return the tokens to use for ordering
+     * @param &$pf The PlFilter whose results must be ordered
+     * @return The name of the field to use for ordering results
+     */
     abstract protected function getSortTokens(PlFilter &$pf);
 }
 // }}}
 
+// {{{ class PlFilterGroupableOrder
+/** Extension of a PlFilterOrder, for orders where the value on which ordering
+ * is done could be used for grouping results (promo, country, ...)
+ */
+class PlFilterGroupableOrder extends PlFilterOrder
+{
+    /** This function will be called when trying to retrieve groups;
+     * the returned token will be used to group the values.
+     * It will always be called AFTER getSortTokens().
+     */
+    public function getGroupToken(PlFilter &$pf)
+    {
+        return $this->_tokens;
+    }
+}
+// }}}
+
 // {{{ class PFO_Random
 class PFO_Random extends PlFilterOrder
 {
@@ -380,6 +408,16 @@ abstract class PlFilter
 
     public abstract function getTotalCount();
 
+    /** Whether this PlFilter can return grouped results through
+     * $this->getGroups();
+     */
+    public abstract function hasGroups();
+
+    /** Used to retrieve value/amount resulting from grouping by the first
+     * given order.
+     */
+    public abstract function getGroups();
+
     /** Get objects, selecting only those within a limit
      * @param $limit The portion of the matching objects to select
      */
-- 
2.1.4