From: Raphaël Barrois <raphael.barrois@polytechnique.org>
Date: Tue, 19 Jan 2010 21:39:08 +0000 (+0100)
Subject: Add PlFilter, PFC, PFO
X-Git-Tag: core/1.1.0~95
X-Git-Url: http://git.polytechnique.org/?a=commitdiff_plain;h=285fb262c9740106026de6d456d85c7b652046ec;p=platal.git

Add PlFilter, PFC, PFO

Signed-off-by: Raphaël Barrois <raphael.barrois@polytechnique.org>
---

diff --git a/classes/plfilter.php b/classes/plfilter.php
new file mode 100644
index 0000000..6cdeb70
--- /dev/null
+++ b/classes/plfilter.php
@@ -0,0 +1,101 @@
+<?php
+/***************************************************************************
+ *  Copyright (C) 2003-2010 Polytechnique.org                              *
+ *  http://opensource.polytechnique.org/                                   *
+ *                                                                         *
+ *  This program is free software; you can redistribute it and/or modify   *
+ *  it under the terms of the GNU General Public License as published by   *
+ *  the Free Software Foundation; either version 2 of the License, or      *
+ *  (at your option) any later version.                                    *
+ *                                                                         *
+ *  This program is distributed in the hope that it will be useful,        *
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of         *
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          *
+ *  GNU General Public License for more details.                           *
+ *                                                                         *
+ *  You should have received a copy of the GNU General Public License      *
+ *  along with this program; if not, write to the Free Software            *
+ *  Foundation, Inc.,                                                      *
+ *  59 Temple Place, Suite 330, Boston, MA  02111-1307  USA                *
+ ***************************************************************************/
+
+class PlSqlJoin
+{
+    private $mode;
+    private $table;
+    private $condition;
+
+    const MODE_LEFT  = 'LEFT';
+    const MODE_RIGHT = 'RIGHT';
+    const MODE_INNER = 'INNER';
+
+    public function __construct($mode, $table, $condition)
+    {
+        if ($mode != self::MODE_LEFT && $mode != self::MODE_RIGHT && $mode != self::MODE_INNER) {
+            Platal::page()->kill("Join mode error : unknown mode $mode");
+            return;
+        }
+        $this->mode = $mode;
+        $this->table = $table;
+        $this->condition = $condition;
+    }
+
+    public function mode()
+    {
+        return $this->mode;
+    }
+
+    public function table()
+    {
+        return $this->table;
+    }
+
+    public function condiftion()
+    {
+        return $this->condition;
+    }
+}
+
+abstract class PlFilter
+{
+    public abstract function filter(array $objects, $count = null, $offset = null);
+
+    public abstract function setCondition(PlFilterCondition &$cond);
+
+    public abstract function addSort(PlFilterOrder &$sort);
+
+    private function replaceJoinMetas($cond, $key)
+    {
+        return str_replace(array('$ME'), array($key), $cond);
+    }
+
+    private function formatJoin(array $joins)
+    {
+        $str = '';
+        foreach ($joins as $key => $join) {
+            if (! $join instanceof PlSqlJoin) {
+                Platal::page()->kill("Error : not a join : $join");
+            }
+            $mode  = $join->mode();
+            $table = $join->table();
+            $str .= ' ' . $mode . ' JOIN ' . $table . ' AS ' . $key;
+            if ($join->condition() != null) {
+                $str .= ' ON (' . $this->replaceJoinMetas($join->condition(), $key) . ')';
+            }
+            $str .= "\n";
+        }
+        return $str;
+    }
+
+    private function buildJoins()
+    {
+        $joins = array();
+        foreach (self::$joinMethods as $method) {
+            $joins = array_merge($joins, $this->$method());
+        }
+        return $this->formatJoin($joins);
+    }
+
+}
+
+?>
diff --git a/classes/plfiltercondition.php b/classes/plfiltercondition.php
new file mode 100644
index 0000000..91545e9
--- /dev/null
+++ b/classes/plfiltercondition.php
@@ -0,0 +1,172 @@
+<?php
+/***************************************************************************
+ *  Copyright (C) 2003-2010 Polytechnique.org                              *
+ *  http://opensource.polytechnique.org/                                   *
+ *                                                                         *
+ *  This program is free software; you can redistribute it and/or modify   *
+ *  it under the terms of the GNU General Public License as published by   *
+ *  the Free Software Foundation; either version 2 of the License, or      *
+ *  (at your option) any later version.                                    *
+ *                                                                         *
+ *  This program is distributed in the hope that it will be useful,        *
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of         *
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          *
+ *  GNU General Public License for more details.                           *
+ *                                                                         *
+ *  You should have received a copy of the GNU General Public License      *
+ *  along with this program; if not, write to the Free Software            *
+ *  Foundation, Inc.,                                                      *
+ *  59 Temple Place, Suite 330, Boston, MA  02111-1307  USA                *
+ ***************************************************************************/
+
+// {{{ interface PlFilterCondition
+interface PlFilterCondition
+{
+    const COND_TRUE  = 'TRUE';
+    const COND_FALSE = 'FALSE';
+
+    public function buildCondition(PlFilter &$pf);
+}
+// }}}
+
+// {{{ class PFC_OneChild
+abstract class PFC_OneChild implements PlFilterCondition
+{
+    protected $child;
+
+    public function __construct($child = null)
+    {
+        if (!is_null($child) && ($child instanceof PlFilterCondition)) {
+            $this->setChild($child);
+        }
+    }
+
+    public function setChild(PlFilterCondition &$cond)
+    {
+        $this->child =& $cond;
+    }
+}
+// }}}
+
+// {{{ class PFC_NChildren
+abstract class PFC_NChildren implements PlFilterCondition
+{
+    protected $children = array();
+
+    public function __construct()
+    {
+        $children = func_get_args();
+        foreach ($children as &$child) {
+            if (!is_null($child) && ($child instanceof PlFilterCondition)) {
+                $this->addChild($child);
+            }
+        }
+    }
+
+    public function addChild(PlFilterCondition &$cond)
+    {
+        $this->children[] =& $cond;
+    }
+
+    protected function catConds(array $cond, $op, $fallback)
+    {
+        if (count($cond) == 0) {
+            return $fallback;
+        } else if (count($cond) == 1) {
+            return $cond[0];
+        } else {
+            return '(' . implode(') ' . $op . ' (', $cond) . ')';
+        }
+    }
+}
+// }}}
+
+// {{{ class PFC_True
+class PFC_True implements PlFilterCondition
+{
+    public function buildCondition(PlFilter &$uf)
+    {
+        return self::COND_TRUE;
+    }
+}
+// }}}
+
+// {{{ class PFC_False
+class PFC_False implements PlFilterCondition
+{
+    public function buildCondition(PlFilter &$uf)
+    {
+        return self::COND_FALSE;
+    }
+}
+// }}}
+
+// {{{ class PFC_Not
+class PFC_Not extends PFC_OneChild
+{
+    public function buildCondition(PlFilter &$uf)
+    {
+        $val = $this->child->buildCondition($uf);
+        if ($val == self::COND_TRUE) {
+            return self::COND_FALSE;
+        } else if ($val == self::COND_FALSE) {
+            return self::COND_TRUE;
+        } else {
+            return 'NOT (' . $val . ')';
+        }
+    }
+}
+// }}}
+
+// {{{ class PFC_And
+class PFC_And extends PFC_NChildren
+{
+    public function buildCondition(PlFilter &$uf)
+    {
+        if (empty($this->children)) {
+            return self::COND_FALSE;
+        } else {
+            $true = self::COND_FALSE;
+            $conds = array();
+            foreach ($this->children as &$child) {
+                $val = $child->buildCondition($uf);
+                if ($val == self::COND_TRUE) {
+                    $true = self::COND_TRUE;
+                } else if ($val == self::COND_FALSE) {
+                    return self::COND_FALSE;
+                } else {
+                    $conds[] = $val;
+                }
+            }
+            return $this->catConds($conds, 'AND', $true);
+        }
+    }
+}
+// }}}
+
+// {{{ class PFC_Or
+class PFC_Or extends PFC_NChildren
+{
+    public function buildCondition(PlFilter &$uf)
+    {
+        if (empty($this->children)) {
+            return self::COND_TRUE;
+        } else {
+            $true = self::COND_TRUE;
+            $conds = array();
+            foreach ($this->children as &$child) {
+                $val = $child->buildCondition($uf);
+                if ($val == self::COND_TRUE) {
+                    return self::COND_TRUE;
+                } else if ($val == self::COND_FALSE) {
+                    $true = self::COND_FALSE;
+                } else {
+                    $conds[] = $val;
+                }
+            }
+            return $this->catConds($conds, 'OR', $true);
+        }
+    }
+}
+// }}}
+?>
diff --git a/classes/plfilterorder.php b/classes/plfilterorder.php
new file mode 100644
index 0000000..09e5911
--- /dev/null
+++ b/classes/plfilterorder.php
@@ -0,0 +1,47 @@
+<?php
+/***************************************************************************
+ *  Copyright (C) 2003-2010 Polytechnique.org                              *
+ *  http://opensource.polytechnique.org/                                   *
+ *                                                                         *
+ *  This program is free software; you can redistribute it and/or modify   *
+ *  it under the terms of the GNU General Public License as published by   *
+ *  the Free Software Foundation; either version 2 of the License, or      *
+ *  (at your option) any later version.                                    *
+ *                                                                         *
+ *  This program is distributed in the hope that it will be useful,        *
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of         *
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          *
+ *  GNU General Public License for more details.                           *
+ *                                                                         *
+ *  You should have received a copy of the GNU General Public License      *
+ *  along with this program; if not, write to the Free Software            *
+ *  Foundation, Inc.,                                                      *
+ *  59 Temple Place, Suite 330, Boston, MA  02111-1307  USA                *
+ ***************************************************************************/
+
+abstract class PlFilterOrder
+{
+    protected $desc = false;
+    public function __construct($desc = false)
+    {
+        $this->desc = $desc;
+    }
+
+    public function buildSort(PlFilter &$pf)
+    {
+        $sel = $this->getSortTokens($pf);
+        if (!is_array($sel)) {
+            $sel = array($sel);
+        }
+        if ($this->desc) {
+            foreach ($sel as $k => $s) {
+                $sel[$k] = $s . ' DESC';
+            }
+        }
+        return $sel;
+    }
+
+    abstract protected function getSortTokens(PlFilter &$pf);
+}
+
+?>