X-Git-Url: http://git.polytechnique.org/?a=blobdiff_plain;f=classes%2Fplset.php;h=7b156a217c4215b5dfa367df70affe7ed996f08e;hb=e90c2e8da9eed07bc1319a45ca6bd4ee1c36c5ca;hp=fc96f1735f787fd486557de36b5bc64108a55619;hpb=501a6db205b3355bd9e15de6eac20ca033835201;p=platal.git diff --git a/classes/plset.php b/classes/plset.php index fc96f17..7b156a2 100644 --- a/classes/plset.php +++ b/classes/plset.php @@ -1,6 +1,6 @@ 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) @@ -54,6 +58,13 @@ abstract class PlSet } } + /** 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); @@ -70,11 +81,15 @@ abstract class PlSet unset($this->mods[$name]); } + /** Adds a new sort (on the PlFilter) + */ public function addSort(PlFilterOrder &$order) { $this->orders[] = $order; } + /** Adds a new condition to the PlFilter + */ public function addCond(PlFilterCondition &$cond) { $this->conds->addChild($cond); @@ -87,39 +102,69 @@ abstract class PlSet abstract protected function buildFilter(PlFilterCondition &$cond, $orders); /** This function returns the results of the given filter - * wihtin $limit ; available when the PlFilter getter isn't the usual get + * wihtin $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 */ protected function &getFilterResults(PlFilter &$pf, PlLimit $limit) { - return $pf->get($limit); + $res = $pf->get($limit); + return $res; } - /** 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(); + /** Helper function, calls buildFilter with the adequate condition/orders. + * @param $orders Additional orders to use before the default ones. + * @return A newly created PlFilter. */ - public function &get(PlLimit $limit = null, $orders = array()) + private function buildFilterHelper($orders = array()) { if (!is_array($orders)) { $orders = array($orders); } - $orders = array_merge($orders, $this->orders); - $pf = $this->buildFilter($this->conds, $orders); + return $this->buildFilter($this->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 = $this->getFilterResults($pf, $limit); + $pf = $this->buildFilterHelper($orders); + $it = $this->getFilterResults($pf, $limit); $this->count = $pf->getTotalCount(); 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; @@ -127,6 +172,10 @@ abstract class PlSet 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 = '?'; @@ -146,7 +195,12 @@ abstract class PlSet 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])) { @@ -158,7 +212,7 @@ abstract class PlSet 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; } @@ -166,22 +220,24 @@ abstract class PlSet 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); } @@ -193,8 +249,23 @@ abstract class PlSet interface PlView { - public function __construct(PlSet &$set, $data, array $params); + /** 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(); } @@ -244,10 +315,9 @@ abstract class MultipageView implements PlView /** 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); @@ -300,19 +370,18 @@ abstract class MultipageView implements PlView } /** 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) { foreach ($this->order() as $order) { @@ -341,12 +410,18 @@ abstract class MultipageView implements PlView $page->assign('order', Env::v('order', $this->defaultkey)); $page->assign('orders', $this->sortkeys); $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();