classes/plset.php

   1 <?php
   2 /***************************************************************************
   3  *  Copyright (C) 2003-2007 Polytechnique.org                              *
   4  *  http://opensource.polytechnique.org/                                   *
   5  *                                                                         *
   6  *  This program is free software; you can redistribute it and/or modify   *
   7  *  it under the terms of the GNU General Public License as published by   *
   8  *  the Free Software Foundation; either version 2 of the License, or      *
   9  *  (at your option) any later version.                                    *
  10  *                                                                         *
  11  *  This program is distributed in the hope that it will be useful,        *
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of         *
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          *
  14  *  GNU General Public License for more details.                           *
  15  *                                                                         *
  16  *  You should have received a copy of the GNU General Public License      *
  17  *  along with this program; if not, write to the Free Software            *
  18  *  Foundation, Inc.,                                                      *
  19  *  59 Temple Place, Suite 330, Boston, MA  02111-1307  USA                *
  20  ***************************************************************************/
  21
  22 /** UserSet is a light-weight Model/View tool for displaying a set of items
  23  */
  24 class PlSet
  25 {
  26     private $from    = null;
  27     private $groupby = null;
  28     private $joins   = null;
  29     private $where   = null;
  30
  31     private $count   = null;
  32
  33     private $mods      = array();
  34     private $modParams = array();
  35     private $mod       = null;
  36     private $default   = null;
  37
  38     public function __construct($from, $joins = '', $where = '', $groupby = '')
  39     {
  40         $this->from    = $from;
  41         $this->joins   = $joins;
  42         $this->where   = $where;
  43         $this->groupby = $groupby;
  44     }
  45
  46     public function addMod($name, $description, $default = false, array $params = array())
  47     {
  48         $name = strtolower($name);
  49         $this->mods[$name]      = $description;
  50         $this->modParams[$name] = $params;
  51         if ($default) {
  52             $this->default = $name;
  53         }
  54     }
  55
  56     public function rmMod($name)
  57     {
  58         $name = strtolower($name);
  59         unset($this->mods[$name]);
  60     }
  61
  62     private function &query($fields, $from, $joins, $where, $groupby, $order, $limit)
  63     {
  64         if (trim($order)) {
  65             $order = "ORDER BY $order";
  66         }
  67         if (trim($where)) {
  68             $where = "WHERE $where";
  69         }
  70         if (trim($groupby)) {
  71             $groupby = "GROUP BY $groupby";
  72         }
  73         $query = "SELECT  SQL_CALC_FOUND_ROWS
  74                           $fields
  75                     FROM  $from
  76                           $joins
  77                           $where
  78                           $groupby
  79                           $order
  80                           $limit";
  81 //        echo $query;
  82 //        print_r($this);
  83         $it    = XDB::iterator($query);
  84         $count = XDB::query('SELECT FOUND_ROWS()');
  85         $this->count = intval($count->fetchOneCell());
  86         return $it;
  87     }
  88
  89     public function args()
  90     {
  91         $get = $_GET;
  92         unset($get['n']);
  93         return $get;
  94     }
  95
  96     protected function encodeArgs(array $args, $encode = false)
  97     {
  98         $qs = '?';
  99         $sep = $encode ? '&' : '&amp;';
 100         foreach ($args as $k=>$v) {
 101             if (!$encode) {
 102                 $k = urlencode($k);
 103                 $v = urlencode($v);
 104             }
 105             $qs .= "$k=$v$sep";
 106         }
 107         return $encode ? urlencode($qs) : $qs;
 108     }
 109
 110     public function &get($fields, $joins, $where, $groupby, $order, $limitcount = null, $limitfrom = null)
 111     {
 112         if (!is_null($limitcount)) {
 113             if (!is_null($limitfrom)) {
 114                 $limitcount = "$limitfrom,$limitcount";
 115             }
 116             $limitcount = "LIMIT $limitcount";
 117         }
 118         $joins  = $this->joins . ' ' . $joins;
 119         $where  = $where;
 120         if (trim($this->where)) {
 121             if (trim($where)) {
 122                 $where .= ' AND ';
 123             }
 124             $where .= $this->where;
 125         }
 126         if (!$groupby) {
 127             $groupby = $this->groupby;
 128         }
 129         return $this->query($fields, $this->from, $joins, $where, $groupby, $order, $limitcount);
 130     }
 131
 132     public function count()
 133     {
 134         return $this->count;
 135     }
 136
 137     private function &buildView($view, $data)
 138     {
 139         $view = strtolower($view);
 140         if (!$view || !class_exists($view . 'View') || !isset($this->mods[$view])) {
 141             reset($this->mods);
 142             $view = $this->default ? $this->default : key($this->mods);
 143         }
 144         $this->mod = $view;
 145         $class = $view . 'View';
 146         if (!class_exists($class)) {
 147             $view = null;
 148         } else {
 149             $view = new $class($this, $data, $this->modParams[$this->mod]);
 150             if (!$view instanceof PlView) {
 151                 $view = null;
 152             }
 153         }
 154         return $view;
 155     }
 156
 157     public function apply($baseurl, PlatalPage &$page, $view = null, $data = null)
 158     {
 159         $view =& $this->buildView($view, $data);
 160         if (is_null($view)) {
 161             return false;
 162         }
 163         $args = $view->args();
 164         $page->changeTpl('core/plset.tpl');
 165         $page->assign('plset_base', $baseurl);
 166         $page->assign('plset_mods', $this->mods);
 167         $page->assign('plset_mod', $this->mod);
 168         $page->assign('plset_search', $this->encodeArgs($args));
 169         $page->assign('plset_search_enc', $this->encodeArgs($args, true));
 170         foreach ($this->modParams[$this->mod] as $param=>$value) {
 171             $page->assign($this->mod . '_' . $param, $value);
 172         }
 173         $page->assign('plset_content', $view->apply($page));
 174         $page->assign('plset_count', $this->count);
 175         return true;
 176     }
 177 }
 178
 179 interface PlView
 180 {
 181     public function __construct(PlSet &$set, $data, array $params);
 182     public function apply(PlatalPage &$page);
 183     public function args();
 184 }
 185
 186 abstract class MultipageView implements PlView
 187 {
 188     protected $set;
 189
 190     public $pages  = 1;
 191     public $page   = 1;
 192     public $offset = 0;
 193
 194     protected $entriesPerPage = 20;
 195     protected $params = array();
 196
 197     protected $sortkeys = array();
 198     protected $defaultkey = null;
 199
 200     public function __construct(PlSet &$set, $data, array $params)
 201     {
 202         $this->set   =& $set;
 203         $this->page   = Env::i('page', 1);
 204         $this->offset = $this->entriesPerPage * ($this->page - 1);
 205         $this->params = $params;
 206     }
 207
 208     public function joins()
 209     {
 210         return null;
 211     }
 212
 213     public function where()
 214     {
 215         return null;
 216     }
 217
 218     public function groupBy()
 219     {
 220         return null;
 221     }
 222
 223     protected function addSortKey($name, array $keys, $desc, $default = false)
 224     {
 225         $this->sortkeys[$name] = array('keys' => $keys, 'desc' => $desc);
 226         if (!$this->defaultkey || $default) {
 227             $this->defaultkey = $name;
 228         }
 229     }
 230
 231     public function order()
 232     {
 233         $order = Env::v('order', $this->defaultkey);
 234         $invert = ($order{0} == '-');
 235         if ($invert) {
 236             $order = substr($order, 1);
 237         }
 238         $list = array();
 239         foreach ($this->sortkeys[$order]['keys'] as $item) {
 240             $desc = ($item{0} == '-');
 241             if ($desc) {
 242                 $item = substr($item, 1);
 243             }
 244             if ($desc xor $invert) {
 245                 $item .= ' DESC';
 246             }
 247             $list[] = $item;
 248         }
 249         return implode(', ', $list);
 250     }
 251
 252     abstract public function templateName();
 253
 254     public function apply(PlatalPage &$page)
 255     {
 256         $page->assign('order', Env::v('order', $this->defaultkey));
 257         $page->assign('orders', $this->sortkeys);
 258         $page->assign_by_ref('plview', $this);
 259         $page->assign_by_ref('set',
 260                              $this->set->get($this->fields(),
 261                                              $this->joins(),
 262                                              $this->where(),
 263                                              $this->groupBy(),
 264                                              $this->order(),
 265                                              $this->entriesPerPage,
 266                                              $this->offset));
 267         $count = $this->set->count();
 268         $this->pages = intval(ceil($count / $this->entriesPerPage));
 269         return 'include/plview.multipage.tpl';
 270     }
 271
 272     public function args()
 273     {
 274         $list = $this->set->args();
 275         unset($list['page']);
 276         unset($list['order']);
 277         return $list;
 278     }
 279 }
 280
 281 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8:
 282 ?>