lib/plugin/HelloWorld.php

   1 <?php // -*-php-*-
   2
   3 /**
   4  * Copyright 1999, 2000, 2001, 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 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 demonstration WikiPlugin.
  25  *
  26  * Usage:
  27  * <<HelloWorld?>
  28  * <<HelloWorld
  29  *          salutation="Greetings, "
  30  *          name=Wikimeister
  31  * >>
  32  * <<HelloWorld salutation=Hi >>
  33  * <<HelloWorld name=WabiSabi >>
  34  */
  35
  36 // Constants are defined before the class.
  37 if (!defined('THE_END'))
  38     define('THE_END', "!");
  39
  40 class WikiPlugin_HelloWorld
  41 extends WikiPlugin
  42 {
  43     // Four required functions in a WikiPlugin.
  44
  45     function getName () {
  46         return _("HelloWorld");
  47     }
  48
  49     function getDescription () {
  50         return _("Simple Sample Plugin");
  51
  52     }
  53
  54     // Establish default values for each of this plugin's arguments.
  55     function getDefaultArguments() {
  56         return array('salutation' => "Hello,",
  57                      'name'       => "World");
  58     }
  59
  60     function run($dbi, $argstr, &$request, $basepage) {
  61         extract($this->getArgs($argstr, $request));
  62
  63         // Any text that is returned will not be further transformed,
  64         // so use html where necessary.
  65         $html = HTML::tt(fmt('%s: %s', $salutation, WikiLink($name, 'auto')),
  66                          THE_END);
  67         return $html;
  68     }
  69 };
  70
  71 // Local Variables:
  72 // mode: php
  73 // tab-width: 8
  74 // c-basic-offset: 4
  75 // c-hanging-comment-ender-p: nil
  76 // indent-tabs-mode: nil
  77 // End: