lib/plugin/PageTrail.php

   1 <?php
   2
   3 /**
   4  * Copyright 1999,2000,2001,2002,2005 $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 along
  19  * with PhpWiki; if not, write to the Free Software Foundation, Inc.,
  20  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  21  */
  22
  23 /**
  24  * A simple PageTrail WikiPlugin.
  25  * Put this at the begin/end of each page to store the trail,
  26  * or better in a template (body or bottom) to support it for all pages.
  27  * But Cache should be turned off then.
  28  *
  29  * Usage:
  30  * <<PageTrail>>
  31  * <<PageTrail numberlinks=5>>
  32  * <<PageTrail invisible=1>>
  33  */
  34
  35 if (!defined('PAGETRAIL_ARROW'))
  36     define('PAGETRAIL_ARROW', " => ");
  37
  38 class WikiPlugin_PageTrail
  39     extends WikiPlugin
  40 {
  41     public $def_numberlinks = 5;
  42
  43     function getName()
  44     {
  45         return _("PageTrail");
  46     }
  47
  48     function getDescription()
  49     {
  50         return _("Display PageTrail.");
  51     }
  52
  53     // default values
  54     function getDefaultArguments()
  55     {
  56         return array('numberlinks' => $this->def_numberlinks,
  57             'invisible' => false,
  58             'duplicates' => false,
  59         );
  60     }
  61
  62     function run($dbi, $argstr, &$request, $basepage)
  63     {
  64         extract($this->getArgs($argstr, $request));
  65
  66         if ($numberlinks > 10 || $numberlinks < 0) {
  67             $numberlinks = $this->def_numberlinks;
  68         }
  69
  70         // Get name of the current page we are on
  71         $thispage = $request->getArg('pagename');
  72         $Pages = $request->session->get("PageTrail");
  73         if (!is_array($Pages)) $Pages = array();
  74
  75         if (!isset($Pages[0]) or ($duplicates || ($thispage != $Pages[0]))) {
  76             array_unshift($Pages, $thispage);
  77             $request->session->set("PageTrail", $Pages);
  78         }
  79
  80         $numberlinks = min(count($Pages), $numberlinks);
  81         if (!$invisible and $numberlinks) {
  82             $html = HTML::div(array('class' => 'pagetrail'));
  83             $html->pushContent(WikiLink($Pages[$numberlinks - 1], 'auto'));
  84             for ($i = $numberlinks - 2; $i >= 0; $i--) {
  85                 if (!empty($Pages[$i]))
  86                     $html->pushContent(PAGETRAIL_ARROW,
  87                         WikiLink($Pages[$i], 'auto'));
  88             }
  89             return $html;
  90         } else
  91             return HTML();
  92     }
  93 }
  94
  95 // Local Variables:
  96 // mode: php
  97 // tab-width: 8
  98 // c-basic-offset: 4
  99 // c-hanging-comment-ender-p: nil
 100 // indent-tabs-mode: nil
 101 // End: