lib/plugin/IncludePages.php

   1 <?php // -*-php-*-
   2 rcs_id('$Id$');
   3 /*
   4  * Copyright 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  * IncludePages: Include a list of multiple pages, based on IncludePage.
  25  * usage:   <?plugin IncludePages pages=<!plugin-list BackLinks !> ?>
  26  * author:  ReiniUrban
  27  */
  28
  29 include_once("lib/plugin/IncludePage.php");
  30
  31 class WikiPlugin_IncludePages
  32 extends WikiPlugin_IncludePage
  33 {
  34     function getName() {
  35         return _("IncludePages");
  36     }
  37
  38     function getDescription() {
  39         return _("Include multiple pages.");
  40     }
  41
  42     function getVersion() {
  43         return preg_replace("/[Revision: $]/", '',
  44                             "\$Revision$");
  45     }
  46
  47     function getDefaultArguments() {
  48         return array_merge(
  49                            array( 'pages'   => false,  // the pages to include
  50                                   'exclude' => false), // the pages to exclude
  51                            WikiPlugin_IncludePage::getDefaultArguments()
  52                            );
  53     }
  54
  55     function run($dbi, $argstr, &$request, $basepage) {
  56         $args = $this->getArgs($argstr, $request);
  57         $html = HTML();
  58         if (empty($args['pages']))
  59             return $html;
  60         $include = new WikiPlugin_IncludePage();
  61
  62         if (is_string($args['exclude']) and !empty($args['exclude'])) {
  63             $args['exclude'] = explodePageList($args['exclude']);
  64             $argstr = preg_replace("/exclude=\S*\s/", "", $argstr);
  65         } elseif (is_array($args['exclude'])) {
  66             $argstr = preg_replace("/exclude=<\?plugin-list.*?\>/", "", $argstr);
  67         }
  68         if (is_string($args['pages']) and !empty($args['pages'])) {
  69             $args['pages'] = explodePageList($args['pages']);
  70             $argstr = preg_replace("/pages=\S*\s/", "", $argstr);
  71         } elseif (is_array($args['pages'])) {
  72             $argstr = preg_replace("/pages=<\?plugin-list.*?\>/", "", $argstr);
  73         }
  74
  75         foreach ($args['pages'] as $page) {
  76             if (empty($args['exclude']) or !in_array($page, $args['exclude'])) {
  77                 $html = HTML($html, $include->run($dbi, "page='$page' ".$argstr, $request, $basepage));
  78             }
  79         }
  80         return $html;
  81     }
  82 };
  83
  84 // For emacs users
  85 // Local Variables:
  86 // mode: php
  87 // tab-width: 8
  88 // c-basic-offset: 4
  89 // c-hanging-comment-ender-p: nil
  90 // indent-tabs-mode: nil
  91 // End:
  92 ?>