BIFE/Widget.php

   1 <?php
   2 // vim: set expandtab tabstop=4 softtabstop=4 shiftwidth=4:
   3 // +--------------------------------------------------------------------+
   4 // |                      BIFE - Buil It Fast & Easy                    |
   5 // +--------------------------------------------------------------------+
   6 // | This file is part of BIFE.                                         |
   7 // |                                                                    |
   8 // | BIFE is free software; you can redistribute it and/or modify it    |
   9 // | 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 // | BIFE is distributed in the hope that it will be useful, but        |
  14 // | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  15 // | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU   |
  16 // | General Public License for more details.                           |
  17 // |                                                                    |
  18 // | You should have received a copy of the GNU General Public License  |
  19 // | along with Hooks; if not, write to the Free Software Foundation,   |
  20 // | Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA      |
  21 // +--------------------------------------------------------------------+
  22 // | Created: @date
  23 // | Authors: @author
  24 // +--------------------------------------------------------------------+
  25 //
  26 // $Id$
  27 //
  28
  29 // +X2C Class 3 :Widget
  30 /**
  31  * Base widget class.
  32  *
  33  * @access public
  34  * @abstract
  35  */
  36 class BIFE_Widget {
  37     // ~X2C
  38
  39     // +X2C Operation 4
  40     /**
  41      * Renders the widget returning a string.
  42 Renders the widget using a template returning a string with the
  43 results.
  44      *
  45      * @param  HTML_Template_Sigma &$template Template object to render the widget.
  46      *
  47      * @return void
  48      * @access public
  49      * @abstract
  50      */
  51     function render(&$template) // ~X2C
  52     {
  53         trigger_error('Method not implemented '.get_class($this).
  54             '::addContents().', E_USER_ERROR);
  55     }
  56     // -X2C
  57
  58 } // -X2C Class :Widget
  59
  60 ?>