]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - lib/htmloutputter.php
Merge branch 'master' into groups
[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                 common_user_error(_('This page is not available in a '.
105                                     'media type you accept'), 406);
106                 exit(0);
107             }
108         }
109
110         header('Content-Type: '.$type);
111
112         $this->startXML('html',
113                         '-//W3C//DTD XHTML 1.0 Strict//EN',
114                         'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
115
116         // FIXME: correct language for interface
117
118         $language = common_language();
119
120         $this->elementStart('html', array('xmlns' => 'http://www.w3.org/1999/xhtml',
121                                           'xml:lang' => $language,
122                                           'lang' => $language));
123     }
124
125     /**
126     *  Ends an HTML document
127     *
128     *  @return void
129     */
130     function endHTML()
131     {
132         $this->elementEnd('html');
133         $this->endXML();
134     }
135
136     /**
137      * Output an HTML text input element
138      *
139      * Despite the name, it is specifically for outputting a
140      * text input element, not other <input> elements. It outputs
141      * a cluster of elements, including a <label> and an associated
142      * instructions span.
143      *
144      * @param string $id           element ID, must be unique on page
145      * @param string $label        text of label for the element
146      * @param string $value        value of the element, default null
147      * @param string $instructions instructions for valid input
148      *
149      * @todo add a $name parameter
150      * @todo add a $maxLength parameter
151      * @todo add a $size parameter
152      *
153      * @return void
154      */
155
156     function input($id, $label, $value=null, $instructions=null)
157     {
158         $this->element('label', array('for' => $id), $label);
159         $attrs = array('name' => $id,
160                        'type' => 'text',
161                        'id' => $id);
162         if ($value) {
163             $attrs['value'] = htmlspecialchars($value);
164         }
165         $this->element('input', $attrs);
166         if ($instructions) {
167             $this->element('p', 'form_guide', $instructions);
168         }
169     }
170
171     /**
172      * output an HTML checkbox and associated elements
173      *
174      * Note that the value is default 'true' (the string), which can
175      * be used by Action::boolean()
176      *
177      * @param string $id           element ID, must be unique on page
178      * @param string $label        text of label for the element
179      * @param string $checked      if the box is checked, default false
180      * @param string $instructions instructions for valid input
181      * @param string $value        value of the checkbox, default 'true'
182      * @param string $disabled     show the checkbox disabled, default false
183      *
184      * @return void
185      *
186      * @todo add a $name parameter
187      */
188
189     function checkbox($id, $label, $checked=false, $instructions=null,
190                       $value='true', $disabled=false)
191     {
192         $attrs = array('name' => $id,
193                        'type' => 'checkbox',
194                        'class' => 'checkbox',
195                        'id' => $id);
196         if ($value) {
197             $attrs['value'] = htmlspecialchars($value);
198         }
199         if ($checked) {
200             $attrs['checked'] = 'checked';
201         }
202         if ($disabled) {
203             $attrs['disabled'] = 'true';
204         }
205         $this->element('input', $attrs);
206         $this->text(' ');
207         $this->element('label', array('class' => 'checkbox',
208                                       'for' => $id),
209                        $label);
210         $this->text(' ');
211         if ($instructions) {
212             $this->element('p', 'form_guide', $instructions);
213         }
214     }
215
216     /**
217      * output an HTML combobox/select and associated elements
218      *
219      * $content is an array of key-value pairs for the dropdown, where
220      * the key is the option value attribute and the value is the option
221      * text. (Careful on the overuse of 'value' here.)
222      *
223      * @param string $id           element ID, must be unique on page
224      * @param string $label        text of label for the element
225      * @param array  $content      options array, value => text
226      * @param string $instructions instructions for valid input
227      * @param string $blank_select whether to have a blank entry, default false
228      * @param string $selected     selected value, default null
229      *
230      * @return void
231      *
232      * @todo add a $name parameter
233      */
234
235     function dropdown($id, $label, $content, $instructions=null,
236                       $blank_select=false, $selected=null)
237     {
238         $this->element('label', array('for' => $id), $label);
239         $this->elementStart('select', array('id' => $id, 'name' => $id));
240         if ($blank_select) {
241             $this->element('option', array('value' => ''));
242         }
243         foreach ($content as $value => $option) {
244             if ($value == $selected) {
245                 $this->element('option', array('value' => $value,
246                                                'selected' => $value),
247                                $option);
248             } else {
249                 $this->element('option', array('value' => $value), $option);
250             }
251         }
252         $this->elementEnd('select');
253         if ($instructions) {
254             $this->element('p', 'form_guide', $instructions);
255         }
256     }
257
258     /**
259      * output an HTML hidden element
260      *
261      * $id is re-used as name
262      *
263      * @param string $id    element ID, must be unique on page
264      * @param string $value hidden element value, default null
265      * @param string $name  name, if different than ID
266      *
267      * @return void
268      */
269
270     function hidden($id, $value, $name=null)
271     {
272         $this->element('input', array('name' => ($name) ? $name : $id,
273                                       'type' => 'hidden',
274                                       'id' => $id,
275                                       'value' => $value));
276     }
277
278     /**
279      * output an HTML password input and associated elements
280      *
281      * @param string $id           element ID, must be unique on page
282      * @param string $label        text of label for the element
283      * @param string $instructions instructions for valid input
284      *
285      * @return void
286      *
287      * @todo add a $name parameter
288      */
289
290     function password($id, $label, $instructions=null)
291     {
292         $this->element('label', array('for' => $id), $label);
293         $attrs = array('name' => $id,
294                        'type' => 'password',
295                        'class' => 'password',
296                        'id' => $id);
297         $this->element('input', $attrs);
298         if ($instructions) {
299             $this->element('p', 'form_guide', $instructions);
300         }
301     }
302
303     /**
304      * output an HTML submit input and associated elements
305      *
306      * @param string $id    element ID, must be unique on page
307      * @param string $label text of the button
308      * @param string $cls   class of the button, default 'submit'
309      * @param string $name  name, if different than ID
310      *
311      * @return void
312      *
313      * @todo add a $name parameter
314      */
315
316     function submit($id, $label, $cls='submit', $name=null, $title=null)
317     {
318         $this->element('input', array('type' => 'submit',
319                                       'id' => $id,
320                                       'name' => ($name) ? $name : $id,
321                                       'class' => $cls,
322                                       'value' => $label,
323                                       'title' => $title));
324     }
325
326     /**
327      * output an HTML textarea and associated elements
328      *
329      * @param string $id           element ID, must be unique on page
330      * @param string $label        text of label for the element
331      * @param string $content      content of the textarea, default none
332      * @param string $instructions instructions for valid input
333      *
334      * @return void
335      *
336      * @todo add a $name parameter
337      * @todo add a $cols parameter
338      * @todo add a $rows parameter
339      */
340
341     function textarea($id, $label, $content=null, $instructions=null)
342     {
343         $this->element('label', array('for' => $id), $label);
344         $this->element('textarea', array('rows' => 3,
345                                          'cols' => 40,
346                                          'name' => $id,
347                                          'id' => $id),
348                        ($content) ? $content : '');
349         if ($instructions) {
350             $this->element('p', 'form_guide', $instructions);
351         }
352     }
353 }