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
29 function getDescription()
31 return _("List the most popular pages.");
34 function getDefaultArguments()
38 PageList::supportedArgs(),
39 array('pagename' => '[pagename]', // hackish
41 'limit' => 20, // limit <0 returns least popular pages
49 // info arg allows multiple columns
50 // info=mtime,hits,summary,version,author,locked,minor
51 // exclude arg allows multiple pagenames exclude=HomePage,RecentChanges
52 // sortby: only pagename or hits. mtime not!
54 function run($dbi, $argstr, &$request, $basepage)
56 $args = $this->getArgs($argstr, $request);
58 if (strstr($sortby, 'mtime')) {
59 trigger_error(_("sortby=mtime not supported with MostPopular"),
63 $columns = $info ? explode(",", $info) : array();
64 array_unshift($columns, 'hits');
66 if (!$request->getArg('count')) {
67 //$args['count'] = $dbi->numPages(false,$exclude);
68 $allpages = $dbi->mostPopular(0, $sortby);
69 $args['count'] = $allpages->count();
71 $args['count'] = $request->getArg('count');
74 $pages = $dbi->mostPopular($limit, $sortby);
75 $pagelist = new PageList($columns, $exclude, $args);
76 while ($page = $pages->next()) {
77 $hits = $page->get('hits');
78 // don't show pages with no hits if most popular pages wanted
79 if ($hits == 0 && $limit > 0) {
82 $pagelist->addPage($page);
88 $pagelist->setCaption(fmt("The %d most popular pages of this wiki:", $limit));
89 } elseif ($limit < 0) {
90 $pagelist->setCaption(fmt("The %d least popular pages of this wiki:", -$limit));
92 $pagelist->setCaption(_("Visited pages on this wiki, ordered by popularity:"));
104 // c-hanging-comment-ender-p: nil
105 // indent-tabs-mode: nil