lib/plugin/IncludePages.php

   1 <?php // -*-php-*-
   2
   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 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  * IncludePages: Include a list of multiple pages, based on IncludePage.
  25  * usage:   <<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 getDefaultArguments() {
  43         return array_merge(array( 'pages'   => false,  // the pages to include
  44                                   'exclude' => false), // the pages to exclude
  45                            WikiPlugin_IncludePage::getDefaultArguments()
  46                           );
  47     }
  48
  49     function run($dbi, $argstr, &$request, $basepage) {
  50         $args = $this->getArgs($argstr, $request);
  51         $html = HTML();
  52         if (empty($args['pages'])) {
  53             return $html;
  54         }
  55         $include = new WikiPlugin_IncludePage();
  56
  57         if (is_string($args['exclude']) and !empty($args['exclude'])) {
  58             $args['exclude'] = explodePageList($args['exclude']);
  59             $argstr = preg_replace("/exclude=\S*\s/", "", $argstr);
  60         } elseif (is_array($args['exclude'])) {
  61             $argstr = preg_replace("/exclude=<\?plugin-list.*?\>/", "", $argstr);
  62         }
  63         if (is_string($args['pages']) and !empty($args['pages'])) {
  64             $args['pages'] = explodePageList($args['pages']);
  65             $argstr = preg_replace("/pages=\S*\s/", "", $argstr);
  66         } elseif (is_array($args['pages'])) {
  67             $argstr = preg_replace("/pages=<\?plugin-list.*?\>/", "", $argstr);
  68         }
  69
  70         // IncludePage plugin has no "pages" argument.
  71         // Remove it to avoid warning.
  72         $argstr = preg_replace('/pages=".*?"/', "", $argstr);
  73         $argstr = preg_replace('/pages=\S*\s/', "", $argstr);
  74         $argstr = preg_replace('/pages=\S*/', "", $argstr);
  75
  76         foreach ($args['pages'] as $page) {
  77             if (empty($args['exclude']) or !in_array($page, $args['exclude'])) {
  78                 $html = HTML($html, $include->run($dbi, "page='$page' ".$argstr, $request, $basepage));
  79             }
  80         }
  81         return $html;
  82     }
  83 };
  84
  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: