lib/plugin/IncludeSiteMap.php

   1 <?php // -*-php-*-
   2 rcs_id('$Id$');
   3 /**
   4  * Copyright 2003,2004 $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  * http://sourceforge.net/tracker/?func=detail&aid=537380&group_id=6121&atid=306121
  25  *
  26  * Submitted by: Cuthbert Cat (cuthbertcat)
  27  * Redesigned by Reini Urban
  28  *
  29  * This is a quick mod of BackLinks to do the job recursively. If your
  30  * site is categorized correctly, and all the categories are listed in
  31  * CategoryCategory, then a RecBackLinks there will produce one BIG(!)
  32  * contents page for the entire site.
  33  * The list is as deep as the recursion level ('reclimit').
  34  *
  35  * 'includepages': passed verbatim to the IncludePage plugin. Default: "words=50"
  36  *                 To disable words=50 use e.g. something like includepages="quiet=0"
  37  * 'reclimit':     Max Recursion depth. Default: 2
  38  * 'direction':    Get BackLinks or forward links (links listed on the page)
  39  * 'firstreversed': If true, get BackLinks for the first page and forward
  40  *                 links for the rest. Only applicable when direction = 'forward'.
  41  * 'excludeunknown': If true (default) then exclude any mentioned pages
  42  *                 which don't exist yet.  Only applicable when direction='forward'.
  43  */
  44
  45 require_once('lib/PageList.php');
  46 require_once('lib/plugin/SiteMap.php');
  47
  48 class WikiPlugin_IncludeSiteMap
  49 extends WikiPlugin_SiteMap
  50 {
  51   function getName () {
  52     return _("IncludeSiteMap");
  53   }
  54
  55   function getDescription () {
  56     return sprintf(_("Include recursively all linked pages starting at %s"),
  57                    $this->_pagename);
  58   }
  59
  60   function getVersion() {
  61       return preg_replace("/[Revision: $]/", '',
  62                           "\$Revision$");
  63   }
  64
  65   function getDefaultArguments() {
  66       return array('exclude'        => '',
  67                    'include_self'   => 0,
  68                    'noheader'       => 0,
  69                    'page'           => '[pagename]',
  70                    'description'    => $this->getDescription(),
  71                    'reclimit'       => 2,
  72                    'info'           => false,
  73                    'direction'      => 'back',
  74                    'firstreversed'  => false,
  75                    'excludeunknown' => true,
  76                    'includepages'   => 'words=50'
  77                    );
  78     }
  79
  80     function run($dbi, $argstr, &$request, $basepage) {
  81       return WikiPlugin_SiteMap::run($dbi, $argstr, $request, $basepage);
  82     }
  83 }
  84
  85 // For emacs users
  86 // Local Variables:
  87 // mode: php
  88 // tab-width: 8
  89 // c-basic-offset: 4
  90 // c-hanging-comment-ender-p: nil
  91 // indent-tabs-mode: nil
  92 // End:
  93 ?>