lib/plugin/AllPages.php

   1 <?php // -*-php-*-
   2 rcs_id('$Id: AllPages.php,v 1.20 2004-02-22 23:20:33 rurban Exp $');
   3 /**
   4  Copyright 1999, 2000, 2001, 2002 $ThePhpWikiProgrammingTeam
   5
   6  This file is part of PhpWiki.
   7
   8  PhpWiki is free software; you can redistribute it and/or modify
   9  it under the terms of the GNU General Public License as published by
  10  the Free Software Foundation; either version 2 of the License, or
  11  (at your option) any later version.
  12
  13  PhpWiki is distributed in the hope that it will be useful,
  14  but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  GNU General Public License for more details.
  17
  18  You should have received a copy of the GNU General Public License
  19  along with PhpWiki; if not, write to the Free Software
  20  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  */
  22
  23 require_once('lib/PageList.php');
  24
  25 /**
  26  */
  27 class WikiPlugin_AllPages
  28 extends WikiPlugin
  29 {
  30     function getName () {
  31         return _("AllPages");
  32     }
  33
  34     function getDescription () {
  35         return _("List all pages in this wiki.");
  36     }
  37
  38     function getVersion() {
  39         return preg_replace("/[Revision: $]/", '',
  40                             "\$Revision: 1.20 $");
  41     }
  42
  43     function getDefaultArguments() {
  44         return array('noheader'      => false,
  45                      'include_empty' => false,
  46                      'exclude'       => '',
  47                      'info'          => '',
  48                      'sortby'        => 'pagename',   // +mtime,-pagename
  49                      'limit'         => 0,
  50                      'debug'         => false
  51                      );
  52     }
  53     // info arg allows multiple columns
  54     // info=mtime,hits,summary,version,author,locked,minor,markup or all
  55     // exclude arg allows multiple pagenames exclude=HomePage,RecentChanges
  56     // sortby: [+|-] pagename|mtime|hits
  57
  58     function run($dbi, $argstr, &$request, $basepage) {
  59         extract($this->getArgs($argstr, $request));
  60         // Todo: extend given _GET args
  61         if ($sorted = $request->getArg('sortby'))
  62             $sortby = $sorted;
  63         elseif ($sortby)
  64             $request->setArg('sortby',$sortby);
  65
  66         $pagelist = new PageList($info, $exclude, $this->getArgs($argstr, $request));
  67         //if (!$sortby) $sorted='pagename';
  68         if (!$noheader)
  69             $pagelist->setCaption(_("Pages in this wiki (%d total):"));
  70
  71         // deleted pages show up as version 0.
  72         if ($include_empty)
  73             $pagelist->_addColumn('version');
  74
  75         //if (defined('DEBUG') and DEBUG) $debug = true;
  76         if ($debug)
  77             $timer = new DebugTimer;
  78         $pagelist->addPages( $dbi->getAllPages($include_empty, $sortby, $limit) );
  79         if ($debug) {
  80             return HTML($pagelist,
  81                         HTML::p(fmt("Elapsed time: %s s", $timer->getStats())));
  82         } else {
  83             return $pagelist;
  84         }
  85     }
  86
  87     function getmicrotime(){
  88         list($usec, $sec) = explode(" ",microtime());
  89         return (float)$usec + (float)$sec;
  90     }
  91 };
  92
  93 // $Log: not supported by cvs2svn $
  94 // Revision 1.19  2004/02/17 12:11:36  rurban
  95 // added missing 4th basepage arg at plugin->run() to almost all plugins. This caused no harm so far, because it was silently dropped on normal usage. However on plugin internal ->run invocations it failed. (InterWikiSearch, IncludeSiteMap, ...)
  96 //
  97 // Revision 1.18  2004/01/25 07:58:30  rurban
  98 // PageList sortby support in PearDB and ADODB backends
  99 //
 100 // Revision 1.17  2003/02/27 20:10:30  dairiki
 101 // Disable profiling output when DEBUG is defined but false.
 102 //
 103 // Revision 1.16  2003/02/21 04:08:26  dairiki
 104 // New class DebugTimer in prepend.php to help report timing.
 105 //
 106 // Revision 1.15  2003/01/18 21:19:25  carstenklapp
 107 // Code cleanup:
 108 // Reformatting; added copyleft, getVersion, getDescription
 109 //
 110
 111 // Local Variables:
 112 // mode: php
 113 // tab-width: 8
 114 // c-basic-offset: 4
 115 // c-hanging-comment-ender-p: nil
 116 // indent-tabs-mode: nil
 117 // End:
 118 ?>