]> git.llucax.com Git - software/bife/bife-all.git/blob - base/src/BIFE/Widget.php
Updated documentation.
[software/bife/bife-all.git] / base / src / BIFE / Widget.php
1 <?php
2 // vim: set expandtab tabstop=4 softtabstop=4 shiftwidth=4:
3 // +--------------------------------------------------------------------+
4 // |                       BIFE - Buil It FastEr                        |
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: Wed May 17 18:16:54 ART 2003                              |
23 // | Authors: Leandro Lucarella <luca@lugmen.org.ar>                    |
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     /**
38      * Attribute list.
39      *
40      * @var    array $attrs
41      * @access protected
42      */
43     var $attrs = array();
44
45     // ~X2C
46
47     // +X2C Operation 126
48     /**
49      * Constructor.
50      *
51      * @param  array $attrs Attributes.
52      *
53      * @return void
54      * @access public
55      */
56     function BIFE_Widget($attrs) // ~X2C
57     {
58         $this->__construct($attrs);
59     }
60     // -X2C
61
62     // +X2C Operation 127
63     /**
64      * Constructor.
65      *
66      * @param  array $attrs Attributes.
67      *
68      * @return void
69      * @access public
70      */
71     function __construct($attrs) // ~X2C
72     {
73         $this->attrs = $attrs;
74     }
75     // -X2C
76
77     // +X2C Operation 4
78     /**
79      * Renders the widget using a template returning a string with the results.
80      *
81      * @param  HTML_Template_HIT &$template Template object to render the widget.
82      *
83      * @return string
84      * @access public
85      * @abstract
86      */
87     function render(&$template) // ~X2C
88     {
89         trigger_error('Method not implemented '.get_class($this).
90             '::render().', E_USER_ERROR);
91     }
92     // -X2C
93
94 } // -X2C Class :Widget
95
96 ?>