lib/plugin/ListSubpages.php

   1 <?php // -*-php-*-
   2 rcs_id('$Id$');
   3 /*
   4  Copyright 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  * ListSubpages:  Lists the names of all SubPages of the current page.
  25  *                Based on UnfoldSubpages.
  26  * Usage:   <?plugin ListSubpages noheader=1 info=pagename,hits,mtime ?>
  27  */
  28 require_once('lib/PageList.php');
  29
  30 class WikiPlugin_ListSubpages
  31 extends WikiPlugin
  32 {
  33     function getName() {
  34         return _("ListSubpages");
  35     }
  36
  37     function getDescription () {
  38         return _("Lists the names of all SubPages of the current page.");
  39     }
  40
  41     function getVersion() {
  42         return preg_replace("/[Revision: $]/", '',
  43                             "\$Revision$");
  44     }
  45
  46     function getDefaultArguments() {
  47         return array_merge
  48             (
  49              PageList::supportedArgs(),
  50                array('noheader' => false, // no header
  51                      'basepage' => false, // subpages of which page, default: current
  52                      'maxpages' => '',    // maximum number of pages to include, change that to limit
  53                      //'exclude'  => '',
  54                      /*'relative' => false, */
  55                      'info'     => ''
  56                      ));
  57     }
  58     // info arg allows multiple columns
  59     // info=mtime,hits,summary,version,author,locked,minor,count
  60     // exclude arg allows multiple pagenames exclude=HomePage,RecentChanges
  61
  62     function run($dbi, $argstr, &$request, $basepage) {
  63         $args = $this->getArgs($argstr, $request);
  64         if ($args['basepage'])
  65             $pagename = $args['basepage'];
  66         else
  67             $pagename = $request->getArg('pagename');
  68
  69         // FIXME: explodePageList from stdlib doesn't seem to work as
  70         // expected when there are no subpages. (see also
  71         // UnfoldSubPages plugin)
  72         $subpages = explodePageList($pagename . SUBPAGE_SEPARATOR . '*');
  73         if (! $subpages) {
  74             return $this->error(_("The current page has no subpages defined."));
  75         }
  76         extract($args);
  77
  78         $content = HTML();
  79         //$subpages = array_reverse($subpages); // TODO: why?
  80         if ($maxpages) {
  81             $subpages = array_slice ($subpages, 0, $maxpages);
  82         }
  83
  84         $descrip = fmt("SubPages of %s:",
  85                        WikiLink($pagename, 'auto'));
  86         if ($info) {
  87             $info = explode(",", $info);
  88             if (in_array('count',$info))
  89                 $args['types']['count'] = new _PageList_Column_ListSubpages_count('count', _("#"), 'center');
  90         }
  91         $pagelist = new PageList($info, $exclude, $args);
  92         if (!$noheader)
  93             $pagelist->setCaption($descrip);
  94
  95         foreach ($subpages as $page) {
  96             // A page cannot include itself. Avoid doublettes.
  97             static $included_pages = array();
  98             if (in_array($page, $included_pages)) {
  99                 $content->pushContent(HTML::p(sprintf(_("recursive inclusion of page %s ignored"),
 100                                                       $page)));
 101                 continue;
 102             }
 103             array_push($included_pages, $page);
 104             //if ($relative) {
 105             // TODO: add relative subpage name display to PageList class
 106             //}
 107             $pagelist->addPage($page);
 108
 109             array_pop($included_pages);
 110         }
 111         $content->pushContent($pagelist);
 112         return $content;
 113     }
 114 };
 115
 116 // how many backlinks for this subpage
 117 class _PageList_Column_ListSubpages_count extends _PageList_Column {
 118     function _getValue($page, &$revision_handle) {
 119         $iter = $page->getBackLinks();
 120         $count = $iter->count();
 121         return $count;
 122     }
 123 }
 124
 125 // $Log: not supported by cvs2svn $
 126 // Revision 1.6  2004/11/23 15:17:19  rurban
 127 // better support for case_exact search (not caseexact for consistency),
 128 // plugin args simplification:
 129 //   handle and explode exclude and pages argument in WikiPlugin::getArgs
 130 //     and exclude in advance (at the sql level if possible)
 131 //   handle sortby and limit from request override in WikiPlugin::getArgs
 132 // ListSubpages: renamed pages to maxpages
 133 //
 134 // Revision 1.5  2004/09/13 14:59:56  rurban
 135 // info=count: number of backlinks for this subpage
 136 //
 137 // Revision 1.4  2004/08/18 11:15:11  rurban
 138 // added basepage argument. Default current
 139 //
 140 // Revision 1.3  2004/02/17 12:11:36  rurban
 141 // 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, ...)
 142 //
 143 // Revision 1.2  2003/11/30 18:23:48  carstenklapp
 144 // Code housekeeping: PEAR coding standards reformatting only.
 145 //
 146 // Revision 1.1  2003/11/23 16:33:02  carstenklapp
 147 // New plugin to list names of SubPages of the currrent
 148 // page. (Unfortunately this plugin reveals a bug in
 149 // stdlib/explodePageList(), the function doesn't seem to work as
 150 // expected when there are no subpages (see also UnfoldSubPages plugin).
 151 //
 152
 153 // For emacs users
 154 // Local Variables:
 155 // mode: php
 156 // tab-width: 8
 157 // c-basic-offset: 4
 158 // c-hanging-comment-ender-p: nil
 159 // indent-tabs-mode: nil
 160 // End:
 161 ?>