]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - lib/htmloutputter.php
Switch DOCTYPE's to the XHTML 5 DOCTYPE
[quix0rs-gnu-social.git] / lib / htmloutputter.php
1 <?php
2 /**
3  * Laconica, the distributed open-source microblogging tool
4  *
5  * Low-level generator for HTML
6  *
7  * PHP version 5
8  *
9  * LICENCE: This program is free software: you can redistribute it and/or modify
10  * it under the terms of the GNU Affero General Public License as published by
11  * the Free Software Foundation, either version 3 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU Affero General Public License for more details.
18  *
19  * You should have received a copy of the GNU Affero General Public License
20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
21  *
22  * @category  Output
23  * @package   Laconica
24  * @author    Evan Prodromou <evan@controlyourself.ca>
25  * @author    Sarven Capadisli <csarven@controlyourself.ca>
26  * @copyright 2008 Control Yourself, Inc.
27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
28  * @link      http://laconi.ca/
29  */
30
31 if (!defined('LACONICA')) {
32     exit(1);
33 }
34
35 require_once INSTALLDIR.'/lib/xmloutputter.php';
36
37 define('PAGE_TYPE_PREFS',
38        'text/html,application/xhtml+xml,'.
39        'application/xml;q=0.3,text/xml;q=0.2');
40
41 /**
42  * Low-level generator for HTML
43  *
44  * Abstracts some of the code necessary for HTML generation. Especially
45  * has methods for generating HTML form elements. Note that these have
46  * been created kind of haphazardly, not with an eye to making a general
47  * HTML-creation class.
48  *
49  * @category Output
50  * @package  Laconica
51  * @author   Evan Prodromou <evan@controlyourself.ca>
52  * @author   Sarven Capadisli <csarven@controlyourself.ca>
53  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
54  * @link     http://laconi.ca/
55  *
56  * @see      Action
57  * @see      XMLOutputter
58  */
59
60 class HTMLOutputter extends XMLOutputter
61 {
62     /**
63      * Constructor
64      *
65      * Just wraps the XMLOutputter constructor.
66      *
67      * @param string  $output URI to output to, default = stdout
68      * @param boolean $indent Whether to indent output, default true
69      */
70
71     function __construct($output='php://output', $indent=true)
72     {
73         parent::__construct($output, $indent);
74     }
75
76     /**
77      * Start an HTML document
78      *
79      * If $type isn't specified, will attempt to do content negotiation.
80      *
81      * Attempts to do content negotiation for language, also.
82      *
83      * @param string $type MIME type to use; default is to do negotation.
84      *
85      * @todo extract content negotiation code to an HTTP module or class.
86      *
87      * @return void
88      */
89
90     function startHTML($type=null)
91     {
92         if (!$type) {
93             $httpaccept = isset($_SERVER['HTTP_ACCEPT']) ?
94               $_SERVER['HTTP_ACCEPT'] : null;
95
96             // XXX: allow content negotiation for RDF, RSS, or XRDS
97
98             $cp = common_accept_to_prefs($httpaccept);
99             $sp = common_accept_to_prefs(PAGE_TYPE_PREFS);
100
101             $type = common_negotiate_type($cp, $sp);
102
103             if (!$type) {
104                 throw new ClientException(_('This page is not available in a '.
105                                             'media type you accept'), 406);
106             }
107         }
108
109         header('Content-Type: '.$type);
110
111         $this->extraHeaders();
112
113         $this->startXML('html');
114
115         $language = $this->getLanguage();
116
117         $this->elementStart('html', array('xmlns' => 'http://www.w3.org/1999/xhtml',
118                                           'xml:lang' => $language,
119                                           'lang' => $language));
120     }
121
122     function getLanguage()
123     {
124         // FIXME: correct language for interface
125         return common_language();
126     }
127
128     /**
129     *  Ends an HTML document
130     *
131     *  @return void
132     */
133     function endHTML()
134     {
135         $this->elementEnd('html');
136         $this->endXML();
137     }
138
139     /**
140     *  To specify additional HTTP headers for the action
141     *
142     *  @return void
143     */
144     function extraHeaders()
145     {
146         // Needs to be overloaded
147     }
148
149     /**
150      * Output an HTML text input element
151      *
152      * Despite the name, it is specifically for outputting a
153      * text input element, not other <input> elements. It outputs
154      * a cluster of elements, including a <label> and an associated
155      * instructions span.
156      *
157      * @param string $id           element ID, must be unique on page
158      * @param string $label        text of label for the element
159      * @param string $value        value of the element, default null
160      * @param string $instructions instructions for valid input
161      *
162      * @todo add a $name parameter
163      * @todo add a $maxLength parameter
164      * @todo add a $size parameter
165      *
166      * @return void
167      */
168
169     function input($id, $label, $value=null, $instructions=null)
170     {
171         $this->element('label', array('for' => $id), $label);
172         $attrs = array('name' => $id,
173                        'type' => 'text',
174                        'id' => $id);
175         if ($value) {
176             $attrs['value'] = $value;
177         }
178         $this->element('input', $attrs);
179         if ($instructions) {
180             $this->element('p', 'form_guide', $instructions);
181         }
182     }
183
184     /**
185      * output an HTML checkbox and associated elements
186      *
187      * Note that the value is default 'true' (the string), which can
188      * be used by Action::boolean()
189      *
190      * @param string $id           element ID, must be unique on page
191      * @param string $label        text of label for the element
192      * @param string $checked      if the box is checked, default false
193      * @param string $instructions instructions for valid input
194      * @param string $value        value of the checkbox, default 'true'
195      * @param string $disabled     show the checkbox disabled, default false
196      *
197      * @return void
198      *
199      * @todo add a $name parameter
200      */
201
202     function checkbox($id, $label, $checked=false, $instructions=null,
203                       $value='true', $disabled=false)
204     {
205         $attrs = array('name' => $id,
206                        'type' => 'checkbox',
207                        'class' => 'checkbox',
208                        'id' => $id);
209         if ($value) {
210             $attrs['value'] = $value;
211         }
212         if ($checked) {
213             $attrs['checked'] = 'checked';
214         }
215         if ($disabled) {
216             $attrs['disabled'] = 'true';
217         }
218         $this->element('input', $attrs);
219         $this->text(' ');
220         $this->element('label', array('class' => 'checkbox',
221                                       'for' => $id),
222                        $label);
223         $this->text(' ');
224         if ($instructions) {
225             $this->element('p', 'form_guide', $instructions);
226         }
227     }
228
229     /**
230      * output an HTML combobox/select and associated elements
231      *
232      * $content is an array of key-value pairs for the dropdown, where
233      * the key is the option value attribute and the value is the option
234      * text. (Careful on the overuse of 'value' here.)
235      *
236      * @param string $id           element ID, must be unique on page
237      * @param string $label        text of label for the element
238      * @param array  $content      options array, value => text
239      * @param string $instructions instructions for valid input
240      * @param string $blank_select whether to have a blank entry, default false
241      * @param string $selected     selected value, default null
242      *
243      * @return void
244      *
245      * @todo add a $name parameter
246      */
247
248     function dropdown($id, $label, $content, $instructions=null,
249                       $blank_select=false, $selected=null)
250     {
251         $this->element('label', array('for' => $id), $label);
252         $this->elementStart('select', array('id' => $id, 'name' => $id));
253         if ($blank_select) {
254             $this->element('option', array('value' => ''));
255         }
256         foreach ($content as $value => $option) {
257             if ($value == $selected) {
258                 $this->element('option', array('value' => $value,
259                                                'selected' => 'selected'),
260                                $option);
261             } else {
262                 $this->element('option', array('value' => $value), $option);
263             }
264         }
265         $this->elementEnd('select');
266         if ($instructions) {
267             $this->element('p', 'form_guide', $instructions);
268         }
269     }
270
271     /**
272      * output an HTML hidden element
273      *
274      * $id is re-used as name
275      *
276      * @param string $id    element ID, must be unique on page
277      * @param string $value hidden element value, default null
278      * @param string $name  name, if different than ID
279      *
280      * @return void
281      */
282
283     function hidden($id, $value, $name=null)
284     {
285         $this->element('input', array('name' => ($name) ? $name : $id,
286                                       'type' => 'hidden',
287                                       'id' => $id,
288                                       'value' => $value));
289     }
290
291     /**
292      * output an HTML password input and associated elements
293      *
294      * @param string $id           element ID, must be unique on page
295      * @param string $label        text of label for the element
296      * @param string $instructions instructions for valid input
297      *
298      * @return void
299      *
300      * @todo add a $name parameter
301      */
302
303     function password($id, $label, $instructions=null)
304     {
305         $this->element('label', array('for' => $id), $label);
306         $attrs = array('name' => $id,
307                        'type' => 'password',
308                        'class' => 'password',
309                        'id' => $id);
310         $this->element('input', $attrs);
311         if ($instructions) {
312             $this->element('p', 'form_guide', $instructions);
313         }
314     }
315
316     /**
317      * output an HTML submit input and associated elements
318      *
319      * @param string $id    element ID, must be unique on page
320      * @param string $label text of the button
321      * @param string $cls   class of the button, default 'submit'
322      * @param string $name  name, if different than ID
323      *
324      * @return void
325      *
326      * @todo add a $name parameter
327      */
328
329     function submit($id, $label, $cls='submit', $name=null, $title=null)
330     {
331         $this->element('input', array('type' => 'submit',
332                                       'id' => $id,
333                                       'name' => ($name) ? $name : $id,
334                                       'class' => $cls,
335                                       'value' => $label,
336                                       'title' => $title));
337     }
338
339     /**
340      * output an HTML textarea and associated elements
341      *
342      * @param string $id           element ID, must be unique on page
343      * @param string $label        text of label for the element
344      * @param string $content      content of the textarea, default none
345      * @param string $instructions instructions for valid input
346      *
347      * @return void
348      *
349      * @todo add a $name parameter
350      * @todo add a $cols parameter
351      * @todo add a $rows parameter
352      */
353
354     function textarea($id, $label, $content=null, $instructions=null)
355     {
356         $this->element('label', array('for' => $id), $label);
357         $this->element('textarea', array('rows' => 3,
358                                          'cols' => 40,
359                                          'name' => $id,
360                                          'id' => $id),
361                        ($content) ? $content : '');
362         if ($instructions) {
363             $this->element('p', 'form_guide', $instructions);
364         }
365     }
366 }