added empty setHelpButton method to moodleform_hidden
[moodle.git] / lib / pear / HTML / QuickForm / Renderer / Tableless.php
1 <?php
2 /**
3  * A renderer for HTML_QuickForm that only uses XHTML and CSS but no
4  * table tags
5  *
6  * PHP versions 4 and 5
7  *
8  * LICENSE: This source file is subject to version 3.01 of the PHP license
9  * that is available through the world-wide-web at the following URI:
10  * http://www.php.net/license/3_01.txt.  If you did not receive a copy of
11  * the PHP License and are unable to obtain it through the web, please
12  * send a note to license@php.net so we can mail you a copy immediately.
13  *
14  * @category   HTML
15  * @package    HTML_QuickForm_Renderer_Tableless
16  * @author     Alexey Borzov <borz_off@cs.msu.su>
17  * @author     Adam Daniel <adaniel1@eesus.jnj.com>
18  * @author     Bertrand Mansion <bmansion@mamasam.com>
19  * @author     Mark Wiesemann <wiesemann@php.net>
20  * @copyright  2005-2006 The PHP Group
21  * @license    http://www.php.net/license/3_01.txt  PHP License 3.01
22  * @version    CVS: $Id$
23  * @link       http://pear.php.net/package/HTML_QuickForm_Renderer_Tableless
24  */
26 require_once 'HTML/QuickForm/Renderer/Default.php';
28 /**
29  * A renderer for HTML_QuickForm that only uses XHTML and CSS but no
30  * table tags
31  * 
32  * You need to specify a stylesheet like the one that you find in
33  * data/stylesheet.css to make this work.
34  *
35  * @category   HTML
36  * @package    HTML_QuickForm_Renderer_Tableless
37  * @author     Alexey Borzov <borz_off@cs.msu.su>
38  * @author     Adam Daniel <adaniel1@eesus.jnj.com>
39  * @author     Bertrand Mansion <bmansion@mamasam.com>
40  * @author     Mark Wiesemann <wiesemann@php.net>
41  * @license    http://www.php.net/license/3_01.txt  PHP License 3.01
42  * @version    Release: 0.3.3
43  * @link       http://pear.php.net/package/HTML_QuickForm_Renderer_Tableless
44  */
45 class HTML_QuickForm_Renderer_Tableless extends HTML_QuickForm_Renderer_Default
46 {
47    /**
48     * Header Template string
49     * @var      string
50     * @access   private
51     */
52     var $_headerTemplate = 
53         "\n\t\t<legend>{header}</legend>";
55    /**
56     * Element template string
57     * @var      string
58     * @access   private
59     */
60     var $_elementTemplate = 
61         "\n\t\t<div class=\"qfrow\"><label class=\"qflabel\"><!-- BEGIN required --><span class=\"required\">*</span><!-- END required -->{label}</label>{help}<div class=\"qfelement<!-- BEGIN error --> error<!-- END error -->\"><!-- BEGIN error --><span class=\"error\">{error}</span><br /><!-- END error -->{element}</div></div><br />";
63    /**
64     * Form template string
65     * @var      string
66     * @access   private
67     */
68     var $_formTemplate = 
69         "\n<form{attributes}>\n\t<div style=\"display: none;\">{hidden}</div>\n{content}\n</form>";
71    /**
72     * Template used when opening a fieldset
73     * @var      string
74     * @access   private
75     */
76     var $_openFieldsetTemplate = "\n\t<fieldset{id}>";
78    /**
79     * Template used when opening a hidden fieldset
80     * (i.e. a fieldset that is opened when there is no header element)
81     * @var      string
82     * @access   private
83     */
84     var $_openHiddenFieldsetTemplate = "\n\t<fieldset class=\"hidden\">";
86    /**
87     * Template used when closing a fieldset
88     * @var      string
89     * @access   private
90     */
91     var $_closeFieldsetTemplate = "\n\t</fieldset>";
93    /**
94     * Required Note template string
95     * @var      string
96     * @access   private
97     */
98     var $_requiredNoteTemplate = 
99         "\n\t\t{requiredNote}";
101    /**
102     * How many fieldsets are open
103     * @var      integer
104     * @access   private
105     */
106    var $_fieldsetsOpen = 0;
108    /**
109     * Array of element names that indicate the end of a fieldset
110     * (a new one will be opened when a the next header element occurs)
111     * @var      array
112     * @access   private
113     */
114     var $_stopFieldsetElements = array();
116    /**
117     * Constructor
118     *
119     * @access public
120     */
121     function HTML_QuickForm_Renderer_Tableless()
122     {
123         $this->HTML_QuickForm_Renderer_Default();
124     } // end constructor
126    /**
127     * Called when visiting a header element
128     *
129     * @param    object     An HTML_QuickForm_header element being visited
130     * @access   public
131     * @return   void
132     */
133     function renderHeader(&$header)
134     {
135         $name = $header->getName();
136         $id = empty($name) ? '' : ' id="' . $name . '"';
137         if (is_null($header->_text)) {
138             $header_html = '';
139         }
140         elseif (!empty($name) && isset($this->_templates[$name])) {
141             $header_html = str_replace('{header}', $header->toHtml(), $this->_templates[$name]);
142         } else {
143             $header_html = str_replace('{header}', $header->toHtml(), $this->_headerTemplate);
144         }
145         if ($this->_fieldsetsOpen > 0) {
146             $this->_html .= $this->_closeFieldsetTemplate;
147             $this->_fieldsetsOpen--;
148         }
149         $openFieldsetTemplate = str_replace('{id}', $id, $this->_openFieldsetTemplate);
150         $this->_html .= $openFieldsetTemplate . $header_html;
151         $this->_fieldsetsOpen++;
152     } // end func renderHeader
154    /**
155     * Renders an element Html
156     * Called when visiting an element
157     *
158     * @param object     An HTML_QuickForm_element object being visited
159     * @param bool       Whether an element is required
160     * @param string     An error message associated with an element
161     * @access public
162     * @return void
163     */
164     function renderElement(&$element, $required, $error)
165     {
166         // if the element name indicates the end of a fieldset, close the fieldset
167         if (   in_array($element->getName(), $this->_stopFieldsetElements)
168             && $this->_fieldsetsOpen > 0
169            ) {
170             $this->_html .= $this->_closeFieldsetTemplate;
171             $this->_fieldsetsOpen--;
172         }
173         // if no fieldset was opened, we need to open a hidden one here to get
174         // XHTML validity
175         if ($this->_fieldsetsOpen === 0) {
176             $this->_html .= $this->_openHiddenFieldsetTemplate;
177             $this->_fieldsetsOpen++;
178         }
179         if (!$this->_inGroup) {
180             $html = $this->_prepareTemplate($element->getName(), $element->getLabel(), $required, $error);
181             // the following lines (until the "elseif") were changed / added
182             // compared to the default renderer
183             $element_html = $element->toHtml();
184             if (!is_null($element->getAttribute('id'))) {
185                 $id = $element->getAttribute('id');
186             } else {
187                 $id = $element->getName();
188             }
189             $html = str_replace('<label', '<label for="' . $id . '"', $html);
190             $element_html = str_replace('name="' . $id . '"',
191                                         'id="' . $id . '" name="' . $id . '"',
192                                         $element_html);
193             $this->_html .= str_replace('{element}', $element_html, $html);
194         } elseif (!empty($this->_groupElementTemplate)) {
195             $html = str_replace('{label}', $element->getLabel(), $this->_groupElementTemplate);
196             if ($required) {
197                 $html = str_replace('<!-- BEGIN required -->', '', $html);
198                 $html = str_replace('<!-- END required -->', '', $html);
199             } else {
200                 $html = preg_replace("/([ \t\n\r]*)?<!-- BEGIN required -->(\s|\S)*<!-- END required -->([ \t\n\r]*)?/i", '', $html);
201             }
202             $this->_groupElements[] = str_replace('{element}', $element->toHtml(), $html);
204         } else {
205             $this->_groupElements[] = $element->toHtml();
206         }
207     } // end func renderElement
209    /**
210     * Called when visiting a form, before processing any form elements
211     *
212     * @param    object      An HTML_QuickForm object being visited
213     * @access   public
214     * @return   void
215     */
216     function startForm(&$form)
217     {
218         $this->_fieldsetsOpen = 0;
219         parent::startForm($form);
220     } // end func startForm
222    /**
223     * Called when visiting a form, after processing all form elements
224     * Adds required note, form attributes, validation javascript and form content.
225     * 
226     * @param    object      An HTML_QuickForm object being visited
227     * @access   public
228     * @return   void
229     */
230     function finishForm(&$form)
231     {
232         // add a required note, if one is needed
233         if (!empty($form->_required) && !$form->_freezeAll) {
234             $this->_html .= str_replace('{requiredNote}', $form->getRequiredNote(), $this->_requiredNoteTemplate);
235         }
236         // close the open fieldset
237         if ($this->_fieldsetsOpen > 0) {
238             $this->_html .= $this->_closeFieldsetTemplate;
239             $this->_fieldsetsOpen--;
240         }
241         // add form attributes and content
242         $html = str_replace('{attributes}', $form->getAttributes(true), $this->_formTemplate);
243         if (strpos($this->_formTemplate, '{hidden}')) {
244             $html = str_replace('{hidden}', $this->_hiddenHtml, $html);
245         } else {
246             $this->_html .= $this->_hiddenHtml;
247         }
248         $this->_hiddenHtml = '';
249         $this->_html = str_replace('{content}', $this->_html, $html);
250         $this->_html = str_replace('></label>', '>&nbsp;</label>', $this->_html);
251         // add a validation script
252         if ('' != ($script = $form->getValidationScript())) {
253             $this->_html = $script . "\n" . $this->_html;
254         }
255     } // end func finishForm
257     /**
258      * Sets the template used when opening a fieldset
259      *
260      * @param       string      The HTML used when opening a fieldset
261      * @access      public
262      * @return      void
263      */
264     function setOpenFieldsetTemplate($html)
265     {
266         $this->_openFieldsetTemplate = $html;
267     } // end func setOpenFieldsetTemplate
269     /**
270      * Sets the template used when opening a hidden fieldset
271      * (i.e. a fieldset that is opened when there is no header element)
272      *
273      * @param       string      The HTML used when opening a hidden fieldset
274      * @access      public
275      * @return      void
276      */
277     function setOpenHiddenFieldsetTemplate($html)
278     {
279         $this->_openHiddenFieldsetTemplate = $html;
280     } // end func setOpenHiddenFieldsetTemplate
282     /**
283      * Sets the template used when closing a fieldset
284      *
285      * @param       string      The HTML used when closing a fieldset
286      * @access      public
287      * @return      void
288      */
289     function setCloseFieldsetTemplate($html)
290     {
291         $this->_closeFieldsetTemplate = $html;
292     } // end func setCloseFieldsetTemplate
294     /**
295      * Adds one or more element names that indicate the end of a fieldset
296      * (a new one will be opened when a the next header element occurs)
297      *
298      * @param       mixed      Element name(s) (as array or string)
299      * @access      public
300      * @return      void
301      */
302     function addStopFieldsetElements($element)
303     {
304         if (is_array($element)) {
305             $this->_stopFieldsetElements = array_merge($this->_stopFieldsetElements,
306                                                        $element);
307         } else {
308             $this->_stopFieldsetElements[] = $element;
309         }
310     } // end func addStopFieldsetElements
312 } // end class HTML_QuickForm_Renderer_Default
313 ?>