2 /***************************************************************************
3 * Copyright (C) 2003-2010 Polytechnique.org *
4 * http://opensource.polytechnique.org/ *
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. *
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. *
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 *
19 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA *
20 ***************************************************************************/
23 /** UserSet is a light-weight Model/View tool for displaying a set of items
27 const DEFAULT_MAX_RES
= 20;
29 protected $conds = null
;
30 protected $orders = array();
31 protected $limit = null
;
33 protected $count = null
;
35 // A list of available views
36 private $mods = array();
37 // An array of $view_name => array($parameters)
38 private $modParams = array();
39 // The current view name
41 // The default view name
42 private $default = null
;
44 public function __construct(PlFilterCondition
&$cond, $orders = null
)
46 if ($cond instanceof PFC_And
) {
49 $this->conds
= new PFC_And($cond);
52 if (!is_null($orders) && $orders instanceof PlFilterOrder
) {
53 $this->addSort($orders);
54 } else if (is_array($orders)){
55 foreach ($orders as $order) {
56 $this->addSort($order);
61 /** Adds a new view (minifiche, trombi, map)
62 * @param $name The name of the view (cf buildView)
63 * @param $description A user-friendly name for the view
64 * @param $default Whether this is the default view
65 * @param $params Parameters used to tune the view (display promo, order by
68 public function addMod($name, $description, $default = false
, array $params = array())
70 $name = strtolower($name);
71 $this->mods
[$name] = $description;
72 $this->modParams
[$name] = $params;
74 $this->default = $name;
78 public function rmMod($name)
80 $name = strtolower($name);
81 unset($this->mods
[$name]);
84 /** Adds a new sort (on the PlFilter)
86 public function addSort(PlFilterOrder
&$order)
88 $this->orders
[] = $order;
91 /** Adds a new condition to the PlFilter
93 public function addCond(PlFilterCondition
&$cond)
95 $this->conds
->addChild($cond);
98 /** This function builds the right kind of PlFilter from given data
99 * @param $cond The PlFilterCondition for the filter
100 * @param $orders An array of PlFilterOrder for the filter
102 abstract protected function buildFilter(PlFilterCondition
&$cond, $orders);
104 /** This function returns the results of the given filter
105 * wihtin $limit; can be use to replace the default $pf->get call.
106 * @param &$pf The filter
107 * @param $limit The PlLimit
108 * @return The results of the filter
110 protected function &getFilterResults(PlFilter
&$pf, PlLimit
$limit)
112 $res = $pf->get($limit);
116 /** This function returns the values of the set, and sets $count with the
117 * total number of results.
118 * @param $limit A PlLimit for selecting users
119 * @param $orders An optional array of PFO to use before the "default" ones
120 * @return The result of $pf->get();
122 public function &get(PlLimit
$limit = null
, $orders = array())
124 if (!is_array($orders)) {
125 $orders = array($orders);
128 $orders = array_merge($orders, $this->orders
);
130 $pf = $this->buildFilter($this->conds
, $orders);
132 if (is_null($limit)) {
133 $limit = new PlLimit(self
::DEFAULT_MAX_RES
, 0);
135 $it = $this->getFilterResults($pf, $limit);
136 $this->count
= $pf->getTotalCount();
140 /** Return an array containing all pertinent parameters for this page
141 * Generated from $_GET, after some cleanup (remove 'n' (plat/al field
142 * for the handler path)
144 public function args()
151 /** Convert an array into an URL query (?foo=bar)
152 * @param $args An associative array to convert to a query string
153 * @param $encode Whether to url-encode the string
155 protected function encodeArgs(array $args, $encode = false
)
159 foreach ($args as $k=>$v) {
166 return $encode ?
urlencode($qs) : $qs;
169 public function count()
174 /** Builds the view class from the given parameters
175 * @param $view A string ('profile' for 'ProfileView'); if null,
176 * the default view is used.
177 * @return A new PlView instance.
179 private function &buildView($view)
181 $view = strtolower($view);
182 if (!$view ||
!class_exists($view . 'View') ||
!isset($this->mods
[$view])) {
184 $view = $this->default ?
$this->default : key($this->mods
);
187 $class = $view . 'View';
188 if (!class_exists($class)) {
191 $view = new $class($this, $this->modParams
[$this->mod
]);
192 if (!$view instanceof PlView
) {
199 /** Creates the view: sets the page template, assigns Smarty vars.
200 * @param $baseurl The base URL for this (for instance, "search/")
201 * @param $page The page in which the view should be loaded
202 * @param $view The name of the view; if null, the default one will be used.
204 public function apply($baseurl, PlPage
&$page, $view = null
)
206 $view =& $this->buildView($view);
207 if (is_null($view)) {
210 $args = $view->args();
211 $page->coreTpl('plset.tpl');
212 $page->assign('plset_base', $baseurl);
213 $page->assign('plset_mods', $this->mods
);
214 $page->assign('plset_mod', $this->mod
);
215 $page->assign('plset_args', $this->encodeArgs($args));
216 $page->assign('plset_args_enc', $this->encodeArgs($args, true
));
217 foreach ($this->modParams
[$this->mod
] as $param=>$value) {
218 $page->assign($this->mod
. '_' . $param, $value);
220 $page->assign('plset_content', $view->apply($page));
221 $page->assign('plset_count', $this->count
);
228 /** Constructs a new PlView
229 * @param $set The set
230 * @param $params Parameters to tune the view (sort by score, include promo...)
232 public function __construct(PlSet
&$set, array $params);
234 /** Applies the view to a page
235 * The content of the set is fetched here.
236 * @param $page Page to which the view will be applied
237 * @return The name of the global view template (for displaying the view,
238 * not the items of the set)
240 public function apply(PlPage
&$page);
242 /** As PlSet->args(), returns the ?foo=bar part of the URL for generating
243 * this PlSet, after adding the necessary components and removing useless ones.
245 public function args();
248 /** This class describes an Order as used in a PlView :
249 * - It is based on a PlFilterOrder
250 * - It has a short identifier
251 * - It has a full name, to display on the page
257 public $displaytext = null
;
259 /** Build a PlViewOrder
260 * @param $name Name of the order (key)
261 * @param $displaytext Text to display
262 * @param $pfos Array of PlFilterOrder for the order
264 public function __construct($name, $pfos, $displaytext = null
)
267 if (is_null($displaytext)) {
268 $this->displaytext
= ucfirst($name);
270 $this->displaytext
= $displaytext;
276 abstract class MultipageView
implements PlView
284 protected $entriesPerPage = 20;
285 protected $params = array();
287 protected $sortkeys = array();
288 protected $defaultkey = null
;
290 protected $bound_field = null
;
292 /** Builds a MultipageView
293 * @param $set The associated PlSet
294 * @param $params Parameters of the view
296 public function __construct(PlSet
&$set, array $params)
299 $this->page
= Env
::i('page', 1);
300 $this->offset
= $this->entriesPerPage
* ($this->page
- 1);
301 $this->params
= $params;
304 /** Add an order to the view
306 protected function addSort(PlViewOrder
&$pvo, $default = false
)
308 $this->sortkeys
[$pvo->name
] = $pvo;
309 if (!$this->defaultkey ||
$default) {
310 $this->defaultkey
= $pvo->name
;
314 /** Returns a list of PFO objects in accordance with the user's choice
316 public function order()
318 $order = Env
::v('order', $this->defaultkey
);
319 $invert = ($order{0} == '-');
321 $order = substr($order, 1);
324 $ordering = $this->sortkeys
[$order];
326 foreach ($ordering->pfos
as $pfo) {
330 return $ordering->pfos
;
333 /** Returns information on the order of bounds
334 * @return * 1 if normal bounds
335 * * -1 if inversed bounds
336 * * 0 if bounds shouldn't be displayed
338 public function bounds()
343 public function limit()
345 return new PlLimit($this->entriesPerPage
, $this->offset
);
348 /** Name of the template to use for displaying items of the view
349 * e.g plview.minifiche.tpl, plview.trombi.pl, ...
351 abstract public function templateName();
353 /** Returns the value of a boundary of the current view (in order
354 * to show "from C to F")
355 * @param $obj The boundary result whose value must be shown to the user
356 * (e.g a Profile, ...)
359 abstract protected function getBoundValue($obj);
361 public function apply(PlPage
&$page)
363 foreach ($this->order() as $order) {
364 if (!is_null($order)) {
365 $this->set
->addSort($order);
368 $res = $this->set
->get($this->limit());
370 $show_bounds = $this->bounds();
372 $start = current($res);
374 if ($show_bounds == 1) {
375 $first = $this->getBoundValue($start);
376 $last = $this->getBoundValue($end);
377 } elseif ($show_bounds == -1) {
378 $first = $this->getBoundValue($end);
379 $last = $this->getBoundValue($start);
381 $page->assign('first', $first);
382 $page->assign('last', $last);
385 $page->assign('show_bounds', $show_bounds);
386 $page->assign('order', Env
::v('order', $this->defaultkey
));
387 $page->assign('orders', $this->sortkeys
);
388 $page->assign_by_ref('plview', $this);
389 if (is_array($res)) {
390 $page->assign('set_keys', array_keys($res));
392 $page->assign_by_ref('set', $res);
393 $count = $this->set
->count();
394 $this->pages
= intval(ceil($count / $this->entriesPerPage
));
395 return PlPage
::getCoreTpl('plview.multipage.tpl');
398 /** Arguments are those needed by the set, minus 'page' and 'order' which
399 * will be set to new values in the html links.
401 public function args()
403 $list = $this->set
->args();
404 unset($list['page']);
405 unset($list['order']);
410 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8: