4 * Copyright 1999, 2000, 2001, 2002 $ThePhpWikiProgrammingTeam
5 * Copyright 2009 Marc-Etienne Vargenau, Alcatel-Lucent
7 * This file is part of PhpWiki.
9 * PhpWiki is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * PhpWiki is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License along
20 * with PhpWiki; if not, write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
24 require_once 'lib/PageList.php';
26 class WikiPlugin_MostPopular
30 return _("MostPopular");
33 function getDescription () {
34 return _("List the most popular pages.");
37 function getDefaultArguments() {
40 PageList::supportedArgs(),
41 array('pagename' => '[pagename]', // hackish
43 'limit' => 20, // limit <0 returns least popular pages
51 // info arg allows multiple columns
52 // info=mtime,hits,summary,version,author,locked,minor
53 // exclude arg allows multiple pagenames exclude=HomePage,RecentChanges
54 // sortby: only pagename or hits. mtime not!
56 function run($dbi, $argstr, &$request, $basepage) {
57 $args = $this->getArgs($argstr, $request);
59 if (strstr($sortby,'mtime')) {
60 trigger_error(_("sortby=mtime not supported with MostPopular"),
64 $columns = $info ? explode(",", $info) : array();
65 array_unshift($columns, 'hits');
67 if (! $request->getArg('count')) {
68 //$args['count'] = $dbi->numPages(false,$exclude);
69 $allpages = $dbi->mostPopular(0, $sortby);
70 $args['count'] = $allpages->count();
72 $args['count'] = $request->getArg('count');
75 $pages = $dbi->mostPopular($limit, $sortby);
76 $pagelist = new PageList($columns, $exclude, $args);
77 while ($page = $pages->next()) {
78 $hits = $page->get('hits');
79 // don't show pages with no hits if most popular pages wanted
80 if ($hits == 0 && $limit > 0) {
83 $pagelist->addPage($page);
89 $pagelist->setCaption(fmt("The %d most popular pages of this wiki:", $limit));
90 } elseif ($limit < 0) {
91 $pagelist->setCaption(fmt("The %d least popular pages of this wiki:", -$limit));
93 $pagelist->setCaption(_("Visited pages on this wiki, ordered by popularity:"));
105 // c-hanging-comment-ender-p: nil
106 // indent-tabs-mode: nil