lib/plugin/PageInfo.php

   1 <?php // -*-php-*-
   2 // rcs_id('$Id$');
   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 /**
  24  * An ActionPage plugin which returns extra information about a page.
  25  * This plugin just passes a page revision handle to the Template
  26  * 'info.tmpl', which does all the real work.
  27  */
  28 class WikiPlugin_PageInfo
  29 extends WikiPlugin
  30 {
  31     function getName () {
  32         return _("PageInfo");
  33     }
  34
  35     function getDescription () {
  36         return sprintf(_("Show extra page Info and statistics for %s."),
  37                        '[pagename]');
  38     }
  39
  40     function getDefaultArguments() {
  41         return array('page' => '[pagename]',
  42                      'version' => '[version]');
  43     }
  44
  45     function run($dbi, $argstr, &$request, $basepage) {
  46         $args = $this->getArgs($argstr, $request);
  47         extract($args);
  48
  49         $pagename = $page;
  50         $page = $request->getPage();
  51         $current = $page->getCurrentRevision();
  52
  53         if ($current->getVersion() < 1)
  54             return fmt("I'm sorry, there is no such page as %s.",
  55                        WikiLink($pagename, 'unknown'));
  56
  57         if (!empty($version)) {
  58             if (!($revision = $page->getRevision($version)))
  59                 NoSuchRevision($request, $page, $version);
  60         }
  61         else {
  62             $revision = $current;
  63         }
  64
  65         $template = new Template('info', $request,
  66                                  array('revision' => $revision));
  67         return $template;
  68     }
  69 };
  70
  71 // (c-file-style: "gnu")
  72 // Local Variables:
  73 // mode: php
  74 // tab-width: 8
  75 // c-basic-offset: 4
  76 // c-hanging-comment-ender-p: nil
  77 // indent-tabs-mode: nil
  78 // End:
  79 ?>