<?php
/***************************************************************************
- * Copyright (C) 2003-2010 Polytechnique.org *
+ * Copyright (C) 2003-2011 Polytechnique.org *
* http://opensource.polytechnique.org/ *
* *
* This program is free software; you can redistribute it and/or modify *
protected $limit = null;
protected $count = null;
+ protected $total_count = null;
+ protected $groups = false;
+ // Handle the "restrict to values of the current order"
+ protected $restrict_to = null;
+
+ // A list of available views
private $mods = array();
+ // An array of $view_name => array($parameters)
private $modParams = array();
+ // The current view name
private $mod = null;
+ // The default view name
private $default = null;
- public function __construct(PlFilterCondition &$cond, $orders = null)
+ public function __construct(PlFilterCondition $cond, $orders = null)
{
if ($cond instanceof PFC_And) {
$this->conds = $cond;
}
}
+ /** Adds a new view (minifiche, trombi, map)
+ * @param $name The name of the view (cf buildView)
+ * @param $description A user-friendly name for the view
+ * @param $default Whether this is the default view
+ * @param $params Parameters used to tune the view (display promo, order by
+ * score...)
+ */
public function addMod($name, $description, $default = false, array $params = array())
{
$name = strtolower($name);
unset($this->mods[$name]);
}
- public function addSort(PlFilterOrder &$order)
+ /** Adds a new sort (on the PlFilter)
+ */
+ public function addSort(PlFilterOrder $order)
{
$this->orders[] = $order;
}
- public function addCond(PlFilterCondition &$cond)
+ /** Adds a new condition to the PlFilter
+ */
+ public function addCond(PlFilterCondition $cond)
{
$this->conds->addChild($cond);
}
+ /** Restricts a PlFilter to values of a given PlFilterOrder
+ */
+ public function restrictTo($value)
+ {
+ $this->restrict_to = $value;
+ }
+
/** This function builds the right kind of PlFilter from given data
* @param $cond The PlFilterCondition for the filter
* @param $orders An array of PlFilterOrder for the filter
+ * @return a PlFilter
*/
- abstract protected function buildFilter(PlFilterCondition &$cond, $orders);
+ abstract protected function buildFilter(PlFilterCondition $cond, $orders);
- /** This function returns the values of the set
- * @param $limit A PlLimit for selecting users
- * @param $orders An optional array of PFO to use before the "default" ones
- * @return The result of $pf->get();
+ /** This function returns the results of the given filter
+ * within $limit; can be use to replace the default $pf->get call.
+ * @param $pf The filter
+ * @param $limit The PlLimit
+ * @return The results of the filter
*/
- public function &get(PlLimit $limit = null, $orders = array())
+ protected function &getFilterResults(PlFilter $pf, PlLimit $limit)
+ {
+ $res = $pf->get($limit);
+ return $res;
+ }
+
+ /** Helper function, calls buildFilter with the adequate condition/orders.
+ * @param $orders Additional orders to use before the default ones.
+ * @return A newly created PlFilter.
+ */
+ private function buildFilterHelper($orders = array(), $extra_cond=null)
{
if (!is_array($orders)) {
$orders = array($orders);
}
-
$orders = array_merge($orders, $this->orders);
- $pf = $this->buildFilter($this->conds, $orders);
+ if ($extra_cond != null) {
+ $conds = clone $this->conds;
+ $conds->addChild($extra_cond);
+ } else {
+ $conds = $this->conds;
+ }
+ return $this->buildFilter($conds, $orders);
+ }
+ /** This function returns the values of the set, and sets $count with the
+ * total number of results.
+ * @param $limit A PlLimit for selecting users
+ * @param $orders An optional array of PFO to use before the "default" ones
+ * @return The result of $pf->get();
+ */
+ public function &get(PlLimit $limit = null, $orders = array())
+ {
if (is_null($limit)) {
$limit = new PlLimit(self::DEFAULT_MAX_RES, 0);
}
- $it = $pf->get($limit);
- $this->count = $pf->getTotalCount();
+ $pf_res = $this->buildFilterHelper($orders);
+ $pf_groups = $pf_res;
+ $this->total_count = $pf_res->getTotalCount();
+ if ($this->restrict_to != null
+ && count($this->orders)
+ && $this->orders[0] instanceof PlFilterGroupableOrder)
+ {
+ $main_order = $this->orders[0];
+ $pf_res = $this->buildFilterHelper($orders, $main_order->getCondition($this->restrict_to));
+ }
+
+ $it = $this->getFilterResults($pf_res, $limit);
+ $this->count = $pf_res->getTotalCount();
+ if ($pf_groups->hasGroups()) {
+ $this->groups = $pf_groups->getGroups();
+ } else {
+ $this->groups = null;
+ }
return $it;
}
+ /** This function returns the ids of the set, and sets $count with the
+ * total number of results.
+ * @param $limit A PlLimit for selecting profiles
+ * @param $orders An optional array of PFO to use before the "default" ones
+ * @return The result of $pf->getId();
+ */
+ public function &getIds(PlLimit $limit = null, $orders = array())
+ {
+ if (is_null($limit)) {
+ $limit = new PlLimit(self::DEFAULT_MAX_RES, 0);
+ }
+ $pf = $this->buildFilterHelper($orders);
+ $result = $pf->getIds($limit);
+ $this->count = count($result);
+ return $result;
+ }
+
+ /** Return an array containing all pertinent parameters for this page
+ * Generated from $_GET, after some cleanup (remove 'n' (plat/al field
+ * for the handler path)
+ */
public function args()
{
$get = $_GET;
return $get;
}
+ /** Convert an array into an URL query (?foo=bar)
+ * @param $args An associative array to convert to a query string
+ * @param $encode Whether to url-encode the string
+ */
protected function encodeArgs(array $args, $encode = false)
{
$qs = '?';
return $this->count;
}
- private function &buildView($view, $data)
+ /** Builds the view class from the given parameters
+ * @param $view A string ('profile' for 'ProfileView'); if null,
+ * the default view is used.
+ * @return A new PlView instance.
+ */
+ private function &buildView($view)
{
$view = strtolower($view);
if (!$view || !class_exists($view . 'View') || !isset($this->mods[$view])) {
if (!class_exists($class)) {
$view = null;
} else {
- $view = new $class($this, $data, $this->modParams[$this->mod]);
+ $view = new $class($this, $this->modParams[$this->mod]);
if (!$view instanceof PlView) {
$view = null;
}
return $view;
}
- public function apply($baseurl, PlPage &$page, $view = null, $data = null)
+ /** Creates the view: sets the page template, assigns Smarty vars.
+ * @param $baseurl The base URL for this (for instance, "search/")
+ * @param $page The page in which the view should be loaded
+ * @param $view The name of the view; if null, the default one will be used.
+ */
+ public function apply($baseurl, PlPage $page, $view = null)
{
- $view =& $this->buildView($view, $data);
+ $view =& $this->buildView($view);
if (is_null($view)) {
return false;
}
$args = $view->args();
- if (!isset($args['rechercher'])) {
- $args['rechercher'] = 'Chercher';
- }
$page->coreTpl('plset.tpl');
$page->assign('plset_base', $baseurl);
$page->assign('plset_mods', $this->mods);
$page->assign('plset_mod', $this->mod);
- $page->assign('plset_search', $this->encodeArgs($args));
- $page->assign('plset_search_enc', $this->encodeArgs($args, true));
+ $page->assign('plset_args', $this->encodeArgs($args));
+ $page->assign('plset_args_enc', $this->encodeArgs($args, true));
foreach ($this->modParams[$this->mod] as $param=>$value) {
$page->assign($this->mod . '_' . $param, $value);
}
$page->assign('plset_content', $view->apply($page));
$page->assign('plset_count', $this->count);
+ $page->assign('plset_total_count', $this->total_count);
+ $page->assign('plset_has_groups', $this->groups != null);
+ $page->assign('plset_groups', $this->groups);
return true;
}
}
interface PlView
{
- public function __construct(PlSet &$set, $data, array $params);
- public function apply(PlPage &$page);
+ /** Constructs a new PlView
+ * @param $set The set
+ * @param $params Parameters to tune the view (sort by score, include promo...)
+ */
+ public function __construct(PlSet $set, array $params);
+
+ /** Applies the view to a page
+ * The content of the set is fetched here.
+ * @param $page Page to which the view will be applied
+ * @return The name of the global view template (for displaying the view,
+ * not the items of the set)
+ */
+ public function apply(PlPage $page);
+
+ /** As PlSet->args(), returns the ?foo=bar part of the URL for generating
+ * this PlSet, after adding the necessary components and removing useless ones.
+ */
public function args();
}
public $pages = 1;
public $page = 1;
+ public $restrict = null;
public $offset = 0;
protected $entriesPerPage = 20;
/** Builds a MultipageView
* @param $set The associated PlSet
- * @param $data Data for the PlSet
* @param $params Parameters of the view
*/
- public function __construct(PlSet &$set, $data, array $params)
+ public function __construct(PlSet $set, array $params)
{
$this->set =& $set;
$this->page = Env::i('page', 1);
+ $this->restrict = Env::s('restrict', null);
$this->offset = $this->entriesPerPage * ($this->page - 1);
$this->params = $params;
}
/** Add an order to the view
*/
- protected function addSort(PlViewOrder &$pvo, $default = false)
+ protected function addSort(PlViewOrder $pvo, $default = false)
{
$this->sortkeys[$pvo->name] = $pvo;
if (!$this->defaultkey || $default) {
}
/** Name of the template to use for displaying items of the view
+ * e.g plview.minifiche.tpl, plview.trombi.pl, ...
*/
abstract public function templateName();
/** Returns the value of a boundary of the current view (in order
* to show "from C to F")
* @param $obj The boundary result whose value must be shown to the user
+ * (e.g a Profile, ...)
* @return The bound
*/
abstract protected function getBoundValue($obj);
- /** Applies the view to a page
- * @param $page Page to which the view will be applied
- */
- public function apply(PlPage &$page)
+ public function apply(PlPage $page)
{
foreach ($this->order() as $order) {
if (!is_null($order)) {
$this->set->addSort($order);
}
}
+ if ($this->restrict != null) {
+ $this->set->restrictTo($this->restrict);
+ }
$res = $this->set->get($this->limit());
$show_bounds = $this->bounds();
$page->assign('show_bounds', $show_bounds);
$page->assign('order', Env::v('order', $this->defaultkey));
$page->assign('orders', $this->sortkeys);
+ $page->assign('restrict', $this->restrict);
$page->assign_by_ref('plview', $this);
+ if (is_array($res)) {
+ $page->assign('set_keys', array_keys($res));
+ }
$page->assign_by_ref('set', $res);
$count = $this->set->count();
$this->pages = intval(ceil($count / $this->entriesPerPage));
return PlPage::getCoreTpl('plview.multipage.tpl');
}
+ /** Arguments are those needed by the set, minus 'page' and 'order' which
+ * will be set to new values in the html links.
+ */
public function args()
{
$list = $this->set->args();
unset($list['page']);
unset($list['order']);
+ unset($list['restrict']);
return $list;
}
}
-// vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8:
+// vim:set et sw=4 sts=4 sws=4 foldmethod=marker fenc=utf-8:
?>
projects / platal.git / blobdiff