include/classes/Savant2/Savant2/Plugin.php

   1 <?php
   2
   3 /**
   4 *
   5 * Abstract Savant2_Plugin class.
   6 *
   7 * You have to extend this class for it to be useful; e.g., "class
   8 * Savant2_Plugin_example extends Savant2_Plugin".
   9 *
  10 * $Id: Plugin.php,v 1.2 2005/08/09 22:19:39 pmjones Exp $
  11 *
  12 * @author Paul M. Jones <pmjones@ciaweb.net>
  13 *
  14 * @package Savant2
  15 *
  16 * @license LGPL http://www.gnu.org/copyleft/lesser.html
  17 *
  18 * This program is free software; you can redistribute it and/or modify
  19 * it under the terms of the GNU Lesser General Public License as
  20 * published by the Free Software Foundation; either version 2.1 of the
  21 * License, or (at your option) any later version.
  22 *
  23 * This program is distributed in the hope that it will be useful, but
  24 * WITHOUT ANY WARRANTY; without even the implied warranty of
  25 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  26 * Lesser General Public License for more details.
  27 *
  28 */
  29
  30 class Savant2_Plugin {
  31
  32         /**
  33         *
  34         * Optional reference to the calling Savant object.
  35         *
  36         * @var object
  37         *
  38         */
  39
  40         var $Savant = null;
  41
  42
  43         /**
  44         *
  45         * Constructor.
  46         *
  47         * @access public
  48         *
  49         */
  50
  51         function Savant2_Plugin($conf = array())
  52         {
  53                 settype($conf, 'array');
  54                 foreach ($conf as $key => $val) {
  55                         $this->$key = $val;
  56                 }
  57         }
  58
  59
  60         /**
  61         *
  62         * Stub method for extended behaviors.
  63         *
  64         * @access public
  65         *
  66         * @return void
  67         *
  68         */
  69
  70         function plugin()
  71         {
  72         }
  73 }
  74 ?>