5 * @license GPL 2 (http://www.gnu.org/licenses/gpl.html)
6 * @author Tom N Harris <tnharris@whoopdedo.org>
9 // phpcs:disable Squiz.Classes.ValidClassName.NotCamelCaps
10 // phpcs:disable PSR2.Classes.PropertyDeclaration.Underscore
14 * Class for creating simple HTML forms.
16 * The forms is built from a list of pseudo-tags (arrays with expected keys).
17 * Every pseudo-tag must have the key '_elem' set to the name of the element.
18 * When printed, the form class calls functions named 'form_$type' for each
19 * element it contains.
21 * Standard practice is for non-attribute keys in a pseudo-element to start
22 * with '_'. Other keys are HTML attributes that will be included in the element
23 * tag. That way, the element output functions can pass the pseudo-element
24 * directly to buildAttributes.
26 * See the form_make* functions later in this file.
28 * Please note that even though this class is technically deprecated (use dokuwiki\Form instead),
29 * it is still widely used in the core and the related form events. Until those have been rewritten,
30 * this will continue to be used
32 * @deprecated 2019-07-14
33 * @author Tom N Harris <tnharris@whoopdedo.org>
38 public $params = array();
40 // Draw a border around form fields.
41 // Adds <fieldset></fieldset> around the elements
42 public $_infieldset = false;
44 // Hidden form fields.
45 public $_hidden = array();
47 // Array of pseudo-tags
48 public $_content = array();
53 * Sets parameters and autoadds a security token. The old calling convention
54 * with up to four parameters is deprecated, instead the first parameter
55 * should be an array with parameters.
57 * @param mixed $params Parameters for the HTML form element; Using the deprecated
58 * calling convention this is the ID attribute of the form
59 * @param bool|string $action (optional, deprecated) submit URL, defaults to current page
60 * @param bool|string $method (optional, deprecated) 'POST' or 'GET', default is POST
61 * @param bool|string $enctype (optional, deprecated) Encoding type of the data
63 * @author Tom N Harris <tnharris@whoopdedo.org>
65 public function __construct($params, $action=false, $method=false, $enctype=false)
67 if (!is_array($params)) {
68 $this->params
= array('id' => $params);
69 if ($action !== false) $this->params
['action'] = $action;
70 if ($method !== false) $this->params
['method'] = strtolower($method);
71 if ($enctype !== false) $this->params
['enctype'] = $enctype;
73 $this->params
= $params;
76 if (!isset($this->params
['method'])) {
77 $this->params
['method'] = 'post';
79 $this->params
['method'] = strtolower($this->params
['method']);
82 if (!isset($this->params
['action'])) {
83 $this->params
['action'] = '';
86 $this->addHidden('sectok', getSecurityToken());
92 * Add <fieldset></fieldset> tags around fields.
93 * Usually results in a border drawn around the form.
95 * @param string $legend Label that will be printed with the border.
97 * @author Tom N Harris <tnharris@whoopdedo.org>
99 public function startFieldset($legend)
101 if ($this->_infieldset
) {
102 $this->addElement(array('_elem'=>'closefieldset'));
104 $this->addElement(array('_elem'=>'openfieldset', '_legend'=>$legend));
105 $this->_infieldset
= true;
111 * @author Tom N Harris <tnharris@whoopdedo.org>
113 public function endFieldset()
115 if ($this->_infieldset
) {
116 $this->addElement(array('_elem'=>'closefieldset'));
118 $this->_infieldset
= false;
124 * Adds a name/value pair as a hidden field.
125 * The value of the field (but not the name) will be passed to
126 * formText() before printing.
128 * @param string $name Field name.
129 * @param string $value Field value. If null, remove a previously added field.
131 * @author Tom N Harris <tnharris@whoopdedo.org>
133 public function addHidden($name, $value)
136 unset($this->_hidden
[$name]);
138 $this->_hidden
[$name] = $value;
144 * Appends a content element to the form.
145 * The element can be either a pseudo-tag or string.
146 * If string, it is printed without escaping special chars. *
148 * @param string|array $elem Pseudo-tag or string to add to the form.
150 * @author Tom N Harris <tnharris@whoopdedo.org>
152 public function addElement($elem)
154 $this->_content
[] = $elem;
160 * Inserts a content element at a position.
162 * @param string $pos 0-based index where the element will be inserted.
163 * @param string|array $elem Pseudo-tag or string to add to the form.
165 * @author Tom N Harris <tnharris@whoopdedo.org>
167 public function insertElement($pos, $elem)
169 array_splice($this->_content
, $pos, 0, array($elem));
175 * Replace with NULL to remove an element.
177 * @param int $pos 0-based index the element will be placed at.
178 * @param string|array $elem Pseudo-tag or string to add to the form.
180 * @author Tom N Harris <tnharris@whoopdedo.org>
182 public function replaceElement($pos, $elem)
185 if (!is_null($elem)) $rep[] = $elem;
186 array_splice($this->_content
, $pos, 1, $rep);
192 * Gets the position of the first of a type of element.
194 * @param string $type Element type to look for.
195 * @return int|false position of element if found, otherwise false
197 * @author Tom N Harris <tnharris@whoopdedo.org>
199 public function findElementByType($type)
201 foreach ($this->_content
as $pos => $elem) {
202 if (is_array($elem) && $elem['_elem'] == $type)
211 * Gets the position of the element with an ID attribute.
213 * @param string $id ID of the element to find.
214 * @return int|false position of element if found, otherwise false
216 * @author Tom N Harris <tnharris@whoopdedo.org>
218 public function findElementById($id)
220 foreach ($this->_content
as $pos => $elem) {
221 if (is_array($elem) && isset($elem['id']) && $elem['id'] == $id)
228 * findElementByAttribute
230 * Gets the position of the first element with a matching attribute value.
232 * @param string $name Attribute name.
233 * @param string $value Attribute value.
234 * @return int|false position of element if found, otherwise false
236 * @author Tom N Harris <tnharris@whoopdedo.org>
238 public function findElementByAttribute($name, $value)
240 foreach ($this->_content
as $pos => $elem) {
241 if (is_array($elem) && isset($elem[$name]) && $elem[$name] == $value)
250 * Returns a reference to the element at a position.
251 * A position out-of-bounds will return either the
252 * first (underflow) or last (overflow) element.
254 * @param int $pos 0-based index
255 * @return array reference pseudo-element
257 * @author Tom N Harris <tnharris@whoopdedo.org>
259 public function &getElementAt($pos)
261 if ($pos < 0) $pos = count($this->_content
) +
$pos;
262 if ($pos < 0) $pos = 0;
263 if ($pos >= count($this->_content
)) $pos = count($this->_content
) - 1;
264 return $this->_content
[$pos];
268 * Return the assembled HTML for the form.
270 * Each element in the form will be passed to a function named
271 * 'form_$type'. The function should return the HTML to be printed.
273 * @author Tom N Harris <tnharris@whoopdedo.org>
275 * @return string html of the form
277 public function getForm()
281 $this->params
['accept-charset'] = $lang['encoding'];
282 $form .= '<form '. buildAttributes($this->params
, false) .'><div class="no">'. DOKU_LF
;
283 if (!empty($this->_hidden
)) {
284 foreach ($this->_hidden
as $name => $value)
285 $form .= form_hidden(array('name'=>$name, 'value'=>$value));
287 foreach ($this->_content
as $element) {
288 if (is_array($element)) {
289 $elem_type = $element['_elem'];
290 if (function_exists('form_'.$elem_type)) {
291 $form .= call_user_func('form_'.$elem_type, $element).DOKU_LF
;
297 if ($this->_infieldset
) $form .= form_closefieldset().DOKU_LF
;
298 $form .= '</div></form>'.DOKU_LF
;
304 * Print the assembled form
306 * wraps around getForm()
308 public function printForm()
310 echo $this->getForm();
316 * This function adds a set of radio buttons to the form. If $_POST[$name]
317 * is set, this radio is preselected, else the first radio button.
319 * @param string $name The HTML field name
320 * @param array $entries An array of entries $value => $caption
322 * @author Adrian Lang <lang@cosmocode.de>
325 public function addRadioSet($name, $entries)
328 $value = (array_key_exists($INPUT->post
->str($name), $entries)) ?
329 $INPUT->str($name) : key($entries);
330 foreach($entries as $val => $cap) {
331 $data = ($value === $val) ?
array('checked' => 'checked') : array();
332 $this->addElement(form_makeRadioField($name, $val, $cap, '', '', $data));
341 * Create a form element for a non-specific empty tag.
343 * @param string $tag Tag name.
344 * @param array $attrs Optional attributes.
345 * @return array pseudo-tag
347 * @author Tom N Harris <tnharris@whoopdedo.org>
349 function form_makeTag($tag, $attrs=array()) {
350 $elem = array('_elem'=>'tag', '_tag'=>$tag);
351 return array_merge($elem, $attrs);
357 * Create a form element for a non-specific opening tag.
358 * Remember to put a matching close tag after this as well.
360 * @param string $tag Tag name.
361 * @param array $attrs Optional attributes.
362 * @return array pseudo-tag
364 * @author Tom N Harris <tnharris@whoopdedo.org>
366 function form_makeOpenTag($tag, $attrs=array()) {
367 $elem = array('_elem'=>'opentag', '_tag'=>$tag);
368 return array_merge($elem, $attrs);
374 * Create a form element for a non-specific closing tag.
375 * Careless use of this will result in invalid XHTML.
377 * @param string $tag Tag name.
378 * @return array pseudo-tag
380 * @author Tom N Harris <tnharris@whoopdedo.org>
382 function form_makeCloseTag($tag) {
383 return array('_elem'=>'closetag', '_tag'=>$tag);
389 * Create a form element for a textarea containing wiki text.
390 * Only one wikitext element is allowed on a page. It will have
391 * a name of 'wikitext' and id 'wiki__text'. The text will
392 * be passed to formText() before printing.
394 * @param string $text Text to fill the field with.
395 * @param array $attrs Optional attributes.
396 * @return array pseudo-tag
398 * @author Tom N Harris <tnharris@whoopdedo.org>
400 function form_makeWikiText($text, $attrs=array()) {
401 $elem = array('_elem'=>'wikitext', '_text'=>$text,
402 'class'=>'edit', 'cols'=>'80', 'rows'=>'10');
403 return array_merge($elem, $attrs);
409 * Create a form element for an action button.
410 * A title will automatically be generated using the value and
411 * accesskey attributes, unless you provide one.
413 * @param string $type Type attribute. 'submit' or 'cancel'
414 * @param string $act Wiki action of the button, will be used as the do= parameter
415 * @param string $value (optional) Displayed label. Uses $act if not provided.
416 * @param array $attrs Optional attributes.
417 * @return array pseudo-tag
419 * @author Tom N Harris <tnharris@whoopdedo.org>
421 function form_makeButton($type, $act, $value='', $attrs=array()) {
422 if ($value == '') $value = $act;
423 $elem = array('_elem'=>'button', 'type'=>$type, '_action'=>$act,
425 if (!empty($attrs['accesskey']) && empty($attrs['title'])) {
426 $attrs['title'] = $value .' ['. strtoupper($attrs['accesskey']) .']';
428 return array_merge($elem, $attrs);
434 * Create a form element for a labelled input element.
435 * The label text will be printed before the input.
437 * @param string $type Type attribute of input.
438 * @param string $name Name attribute of the input.
439 * @param string $value (optional) Default value.
440 * @param string $class Class attribute of the label. If this is 'block',
441 * then a line break will be added after the field.
442 * @param string $label Label that will be printed before the input.
443 * @param string $id ID attribute of the input. If set, the label will
444 * reference it with a 'for' attribute.
445 * @param array $attrs Optional attributes.
446 * @return array pseudo-tag
448 * @author Tom N Harris <tnharris@whoopdedo.org>
450 function form_makeField($type, $name, $value='', $label=null, $id='', $class='', $attrs=array()) {
451 if (is_null($label)) $label = $name;
452 $elem = array('_elem'=>'field', '_text'=>$label, '_class'=>$class,
453 'type'=>$type, 'id'=>$id, 'name'=>$name, 'value'=>$value);
454 return array_merge($elem, $attrs);
458 * form_makeFieldRight
460 * Create a form element for a labelled input element.
461 * The label text will be printed after the input.
463 * @see form_makeField
464 * @author Tom N Harris <tnharris@whoopdedo.org>
466 * @param string $type
467 * @param string $name
468 * @param string $value
469 * @param null|string $label
471 * @param string $class
472 * @param array $attrs
476 function form_makeFieldRight($type, $name, $value='', $label=null, $id='', $class='', $attrs=array()) {
477 if (is_null($label)) $label = $name;
478 $elem = array('_elem'=>'fieldright', '_text'=>$label, '_class'=>$class,
479 'type'=>$type, 'id'=>$id, 'name'=>$name, 'value'=>$value);
480 return array_merge($elem, $attrs);
486 * Create a form element for a text input element with label.
488 * @see form_makeField
489 * @author Tom N Harris <tnharris@whoopdedo.org>
491 * @param string $name
492 * @param string $value
493 * @param null|string $label
495 * @param string $class
496 * @param array $attrs
500 function form_makeTextField($name, $value='', $label=null, $id='', $class='', $attrs=array()) {
501 if (is_null($label)) $label = $name;
502 $elem = array('_elem'=>'textfield', '_text'=>$label, '_class'=>$class,
503 'id'=>$id, 'name'=>$name, 'value'=>$value, 'class'=>'edit');
504 return array_merge($elem, $attrs);
508 * form_makePasswordField
510 * Create a form element for a password input element with label.
511 * Password elements have no default value, for obvious reasons.
513 * @see form_makeField
514 * @author Tom N Harris <tnharris@whoopdedo.org>
516 * @param string $name
517 * @param null|string $label
519 * @param string $class
520 * @param array $attrs
524 function form_makePasswordField($name, $label=null, $id='', $class='', $attrs=array()) {
525 if (is_null($label)) $label = $name;
526 $elem = array('_elem'=>'passwordfield', '_text'=>$label, '_class'=>$class,
527 'id'=>$id, 'name'=>$name, 'class'=>'edit');
528 return array_merge($elem, $attrs);
534 * Create a form element for a file input element with label
536 * @see form_makeField
537 * @author Michael Klier <chi@chimeric.de>
539 * @param string $name
540 * @param null|string $label
542 * @param string $class
543 * @param array $attrs
547 function form_makeFileField($name, $label=null, $id='', $class='', $attrs=array()) {
548 if (is_null($label)) $label = $name;
549 $elem = array('_elem'=>'filefield', '_text'=>$label, '_class'=>$class,
550 'id'=>$id, 'name'=>$name, 'class'=>'edit');
551 return array_merge($elem, $attrs);
555 * form_makeCheckboxField
557 * Create a form element for a checkbox input element with label.
558 * If $value is an array, a hidden field with the same name and the value
559 * $value[1] is constructed as well.
561 * @see form_makeFieldRight
562 * @author Tom N Harris <tnharris@whoopdedo.org>
564 * @param string $name
565 * @param string $value
566 * @param null|string $label
568 * @param string $class
569 * @param array $attrs
573 function form_makeCheckboxField($name, $value='1', $label=null, $id='', $class='', $attrs=array()) {
574 if (is_null($label)) $label = $name;
575 if (is_null($value) ||
$value=='') $value='0';
576 $elem = array('_elem'=>'checkboxfield', '_text'=>$label, '_class'=>$class,
577 'id'=>$id, 'name'=>$name, 'value'=>$value);
578 return array_merge($elem, $attrs);
582 * form_makeRadioField
584 * Create a form element for a radio button input element with label.
586 * @see form_makeFieldRight
587 * @author Tom N Harris <tnharris@whoopdedo.org>
589 * @param string $name
590 * @param string $value
591 * @param null|string $label
593 * @param string $class
594 * @param array $attrs
598 function form_makeRadioField($name, $value='1', $label=null, $id='', $class='', $attrs=array()) {
599 if (is_null($label)) $label = $name;
600 if (is_null($value) ||
$value=='') $value='0';
601 $elem = array('_elem'=>'radiofield', '_text'=>$label, '_class'=>$class,
602 'id'=>$id, 'name'=>$name, 'value'=>$value);
603 return array_merge($elem, $attrs);
609 * Create a form element for a drop-down menu with label.
610 * The list of values can be strings, arrays of (value,text),
611 * or an associative array with the values as keys and labels as values.
612 * An item is selected by supplying its value or integer index.
613 * If the list of values is an associative array, the selected item must be
616 * @author Tom N Harris <tnharris@whoopdedo.org>
618 * @param string $name Name attribute of the input.
619 * @param string[]|array[] $values The list of values can be strings, arrays of (value,text),
620 * or an associative array with the values as keys and labels as values.
621 * @param string|int $selected default selected value, string or index number
622 * @param string $class Class attribute of the label. If this is 'block',
623 * then a line break will be added after the field.
624 * @param string $label Label that will be printed before the input.
625 * @param string $id ID attribute of the input. If set, the label will
626 * reference it with a 'for' attribute.
627 * @param array $attrs Optional attributes.
628 * @return array pseudo-tag
630 function form_makeMenuField($name, $values, $selected='', $label=null, $id='', $class='', $attrs=array()) {
631 if (is_null($label)) $label = $name;
634 // FIXME: php doesn't know the difference between a string and an integer
635 if (is_string(key($values))) {
636 foreach ($values as $val => $text) {
637 $options[] = array($val, $text, (!is_null($selected) && $val==$selected));
640 if (is_integer($selected)) $selected = $values[$selected];
641 foreach ($values as $val) {
643 @list
($val, $text) = $val;
646 $options[] = array($val, $text, $val===$selected);
649 $elem = array('_elem'=>'menufield', '_options'=>$options, '_text'=>$label, '_class'=>$class,
650 'id'=>$id, 'name'=>$name);
651 return array_merge($elem, $attrs);
655 * form_makeListboxField
657 * Create a form element for a list box with label.
658 * The list of values can be strings, arrays of (value,text),
659 * or an associative array with the values as keys and labels as values.
660 * Items are selected by supplying its value or an array of values.
662 * @author Tom N Harris <tnharris@whoopdedo.org>
664 * @param string $name Name attribute of the input.
665 * @param string[]|array[] $values The list of values can be strings, arrays of (value,text),
666 * or an associative array with the values as keys and labels as values.
667 * @param array|string $selected value or array of values of the items that need to be selected
668 * @param string $class Class attribute of the label. If this is 'block',
669 * then a line break will be added after the field.
670 * @param string $label Label that will be printed before the input.
671 * @param string $id ID attribute of the input. If set, the label will
672 * reference it with a 'for' attribute.
673 * @param array $attrs Optional attributes.
674 * @return array pseudo-tag
676 function form_makeListboxField($name, $values, $selected='', $label=null, $id='', $class='', $attrs=array()) {
677 if (is_null($label)) $label = $name;
680 if (is_null($selected) ||
$selected == '') {
682 } elseif (!is_array($selected)) {
683 $selected = array($selected);
685 // FIXME: php doesn't know the difference between a string and an integer
686 if (is_string(key($values))) {
687 foreach ($values as $val => $text) {
688 $options[] = array($val, $text, in_array($val, $selected));
691 foreach ($values as $val) {
693 if (is_array($val)) {
694 @list
($val, $text, $disabled) = $val;
698 $options[] = array($val, $text, in_array($val, $selected), $disabled);
701 $elem = array('_elem'=>'listboxfield', '_options'=>$options, '_text'=>$label, '_class'=>$class,
702 'id'=>$id, 'name'=>$name);
703 return array_merge($elem, $attrs);
709 * Print the HTML for a generic empty tag.
710 * Requires '_tag' key with name of the tag.
711 * Attributes are passed to buildAttributes()
713 * @author Tom N Harris <tnharris@whoopdedo.org>
715 * @param array $attrs attributes
716 * @return string html of tag
718 function form_tag($attrs) {
719 return '<'.$attrs['_tag'].' '. buildAttributes($attrs, true) .'/>';
725 * Print the HTML for a generic opening tag.
726 * Requires '_tag' key with name of the tag.
727 * Attributes are passed to buildAttributes()
729 * @author Tom N Harris <tnharris@whoopdedo.org>
731 * @param array $attrs attributes
732 * @return string html of tag
734 function form_opentag($attrs) {
735 return '<'.$attrs['_tag'].' '. buildAttributes($attrs, true) .'>';
741 * Print the HTML for a generic closing tag.
742 * Requires '_tag' key with name of the tag.
743 * There are no attributes.
745 * @author Tom N Harris <tnharris@whoopdedo.org>
747 * @param array $attrs attributes
748 * @return string html of tag
750 function form_closetag($attrs) {
751 return '</'.$attrs['_tag'].'>';
757 * Print the HTML for an opening fieldset tag.
758 * Uses the '_legend' key.
759 * Attributes are passed to buildAttributes()
761 * @author Tom N Harris <tnharris@whoopdedo.org>
763 * @param array $attrs attributes
764 * @return string html
766 function form_openfieldset($attrs) {
767 $s = '<fieldset '. buildAttributes($attrs, true) .'>';
768 if (!is_null($attrs['_legend'])) $s .= '<legend>'.$attrs['_legend'].'</legend>';
775 * Print the HTML for a closing fieldset tag.
776 * There are no attributes.
778 * @author Tom N Harris <tnharris@whoopdedo.org>
780 * @return string html
782 function form_closefieldset() {
783 return '</fieldset>';
789 * Print the HTML for a hidden input element.
790 * Uses only 'name' and 'value' attributes.
791 * Value is passed to formText()
793 * @author Tom N Harris <tnharris@whoopdedo.org>
795 * @param array $attrs attributes
796 * @return string html
798 function form_hidden($attrs) {
799 return '<input type="hidden" name="'.$attrs['name'].'" value="'. formText($attrs['value']) .'" />';
805 * Print the HTML for the wiki textarea.
806 * Requires '_text' with default text of the field.
807 * Text will be passed to formText(), attributes to buildAttributes()
809 * @author Tom N Harris <tnharris@whoopdedo.org>
811 * @param array $attrs attributes
812 * @return string html
814 function form_wikitext($attrs) {
815 // mandatory attributes
816 unset($attrs['name']);
818 return '<textarea name="wikitext" id="wiki__text" dir="auto" '
819 . buildAttributes($attrs, true).'>'.DOKU_LF
820 . formText($attrs['_text'])
827 * Print the HTML for a form button.
828 * If '_action' is set, the button name will be "do[_action]".
829 * Other attributes are passed to buildAttributes()
831 * @author Tom N Harris <tnharris@whoopdedo.org>
833 * @param array $attrs attributes
834 * @return string html
836 function form_button($attrs) {
837 $p = (!empty($attrs['_action'])) ?
'name="do['.$attrs['_action'].']" ' : '';
838 $value = $attrs['value'];
839 unset($attrs['value']);
840 return '<button '.$p. buildAttributes($attrs, true) .'>'.$value.'</button>';
846 * Print the HTML for a form input field.
847 * _class : class attribute used on the label tag
848 * _text : Text to display before the input. Not escaped.
849 * Other attributes are passed to buildAttributes() for the input tag.
851 * @author Tom N Harris <tnharris@whoopdedo.org>
853 * @param array $attrs attributes
854 * @return string html
856 function form_field($attrs) {
858 if ($attrs['_class']) $s .= ' class="'.$attrs['_class'].'"';
859 if (!empty($attrs['id'])) $s .= ' for="'.$attrs['id'].'"';
860 $s .= '><span>'.$attrs['_text'].'</span>';
861 $s .= ' <input '. buildAttributes($attrs, true) .' /></label>';
862 if (preg_match('/(^| )block($| )/', $attrs['_class']))
870 * Print the HTML for a form input field. (right-aligned)
871 * _class : class attribute used on the label tag
872 * _text : Text to display after the input. Not escaped.
873 * Other attributes are passed to buildAttributes() for the input tag.
875 * @author Tom N Harris <tnharris@whoopdedo.org>
877 * @param array $attrs attributes
878 * @return string html
880 function form_fieldright($attrs) {
882 if ($attrs['_class']) $s .= ' class="'.$attrs['_class'].'"';
883 if (!empty($attrs['id'])) $s .= ' for="'.$attrs['id'].'"';
884 $s .= '><input '. buildAttributes($attrs, true) .' />';
885 $s .= ' <span>'.$attrs['_text'].'</span></label>';
886 if (preg_match('/(^| )block($| )/', $attrs['_class']))
894 * Print the HTML for a text input field.
895 * _class : class attribute used on the label tag
896 * _text : Text to display before the input. Not escaped.
897 * Other attributes are passed to buildAttributes() for the input tag.
899 * @author Tom N Harris <tnharris@whoopdedo.org>
901 * @param array $attrs attributes
902 * @return string html
904 function form_textfield($attrs) {
905 // mandatory attributes
906 unset($attrs['type']);
908 if ($attrs['_class']) $s .= ' class="'.$attrs['_class'].'"';
909 if (!empty($attrs['id'])) $s .= ' for="'.$attrs['id'].'"';
910 $s .= '><span>'.$attrs['_text'].'</span> ';
911 $s .= '<input type="text" '. buildAttributes($attrs, true) .' /></label>';
912 if (preg_match('/(^| )block($| )/', $attrs['_class']))
920 * Print the HTML for a password input field.
921 * _class : class attribute used on the label tag
922 * _text : Text to display before the input. Not escaped.
923 * Other attributes are passed to buildAttributes() for the input tag.
925 * @author Tom N Harris <tnharris@whoopdedo.org>
927 * @param array $attrs attributes
928 * @return string html
930 function form_passwordfield($attrs) {
931 // mandatory attributes
932 unset($attrs['type']);
934 if ($attrs['_class']) $s .= ' class="'.$attrs['_class'].'"';
935 if (!empty($attrs['id'])) $s .= ' for="'.$attrs['id'].'"';
936 $s .= '><span>'.$attrs['_text'].'</span> ';
937 $s .= '<input type="password" '. buildAttributes($attrs, true) .' /></label>';
938 if (preg_match('/(^| )block($| )/', $attrs['_class']))
946 * Print the HTML for a file input field.
947 * _class : class attribute used on the label tag
948 * _text : Text to display before the input. Not escaped
949 * _maxlength : Allowed size in byte
950 * _accept : Accepted mime-type
951 * Other attributes are passed to buildAttributes() for the input tag
953 * @author Michael Klier <chi@chimeric.de>
955 * @param array $attrs attributes
956 * @return string html
958 function form_filefield($attrs) {
960 if ($attrs['_class']) $s .= ' class="'.$attrs['_class'].'"';
961 if (!empty($attrs['id'])) $s .= ' for="'.$attrs['id'].'"';
962 $s .= '><span>'.$attrs['_text'].'</span> ';
963 $s .= '<input type="file" '. buildAttributes($attrs, true);
964 if (!empty($attrs['_maxlength'])) $s .= ' maxlength="'.$attrs['_maxlength'].'"';
965 if (!empty($attrs['_accept'])) $s .= ' accept="'.$attrs['_accept'].'"';
967 if (preg_match('/(^| )block($| )/', $attrs['_class']))
975 * Print the HTML for a checkbox input field.
976 * _class : class attribute used on the label tag
977 * _text : Text to display after the input. Not escaped.
978 * Other attributes are passed to buildAttributes() for the input tag.
979 * If value is an array, a hidden field with the same name and the value
980 * $attrs['value'][1] is constructed as well.
982 * @author Tom N Harris <tnharris@whoopdedo.org>
984 * @param array $attrs attributes
985 * @return string html
987 function form_checkboxfield($attrs) {
988 // mandatory attributes
989 unset($attrs['type']);
991 if ($attrs['_class']) $s .= ' class="'.$attrs['_class'].'"';
992 if (!empty($attrs['id'])) $s .= ' for="'.$attrs['id'].'"';
994 if (is_array($attrs['value'])) {
995 echo '<input type="hidden" name="'. hsc($attrs['name']) .'"'
996 .' value="'. hsc($attrs['value'][1]) .'" />';
997 $attrs['value'] = $attrs['value'][0];
999 $s .= '<input type="checkbox" '. buildAttributes($attrs, true) .' />';
1000 $s .= ' <span>'.$attrs['_text'].'</span></label>';
1001 if (preg_match('/(^| )block($| )/', $attrs['_class']))
1009 * Print the HTML for a radio button input field.
1010 * _class : class attribute used on the label tag
1011 * _text : Text to display after the input. Not escaped.
1012 * Other attributes are passed to buildAttributes() for the input tag.
1014 * @author Tom N Harris <tnharris@whoopdedo.org>
1016 * @param array $attrs attributes
1017 * @return string html
1019 function form_radiofield($attrs) {
1020 // mandatory attributes
1021 unset($attrs['type']);
1023 if ($attrs['_class']) $s .= ' class="'.$attrs['_class'].'"';
1024 if (!empty($attrs['id'])) $s .= ' for="'.$attrs['id'].'"';
1025 $s .= '><input type="radio" '. buildAttributes($attrs, true) .' />';
1026 $s .= ' <span>'.$attrs['_text'].'</span></label>';
1027 if (preg_match('/(^| )block($| )/', $attrs['_class']))
1035 * Print the HTML for a drop-down menu.
1036 * _options : Array of (value,text,selected) for the menu.
1037 * Text can be omitted. Text and value are passed to formText()
1038 * Only one item can be selected.
1039 * _class : class attribute used on the label tag
1040 * _text : Text to display before the menu. Not escaped.
1041 * Other attributes are passed to buildAttributes() for the input tag.
1043 * @author Tom N Harris <tnharris@whoopdedo.org>
1045 * @param array $attrs attributes
1046 * @return string html
1048 function form_menufield($attrs) {
1049 $attrs['size'] = '1';
1051 if ($attrs['_class']) $s .= ' class="'.$attrs['_class'].'"';
1052 if (!empty($attrs['id'])) $s .= ' for="'.$attrs['id'].'"';
1053 $s .= '><span>'.$attrs['_text'].'</span>';
1054 $s .= ' <select '. buildAttributes($attrs, true) .'>'.DOKU_LF
;
1055 if (!empty($attrs['_options'])) {
1058 $cnt = count($attrs['_options']);
1059 for($n=0; $n < $cnt; $n++
){
1060 @list
($value,$text,$select) = $attrs['_options'][$n];
1062 if (!is_null($text))
1063 $p .= ' value="'. formText($value) .'"';
1066 if (!empty($select) && !$selected) {
1067 $p .= ' selected="selected"';
1070 $s .= '<option'.$p.'>'. formText($text) .'</option>';
1073 $s .= '<option></option>';
1075 $s .= DOKU_LF
.'</select></label>';
1076 if (preg_match('/(^| )block($| )/', $attrs['_class']))
1084 * Print the HTML for a list box.
1085 * _options : Array of (value,text,selected) for the list.
1086 * Text can be omitted. Text and value are passed to formText()
1087 * _class : class attribute used on the label tag
1088 * _text : Text to display before the menu. Not escaped.
1089 * Other attributes are passed to buildAttributes() for the input tag.
1091 * @author Tom N Harris <tnharris@whoopdedo.org>
1093 * @param array $attrs attributes
1094 * @return string html
1096 function form_listboxfield($attrs) {
1098 if ($attrs['_class']) $s .= ' class="'.$attrs['_class'].'"';
1099 if (!empty($attrs['id'])) $s .= ' for="'.$attrs['id'].'"';
1100 $s .= '><span>'.$attrs['_text'].'</span> ';
1101 $s .= '<select '. buildAttributes($attrs, true) .'>'.DOKU_LF
;
1102 if (!empty($attrs['_options'])) {
1103 foreach ($attrs['_options'] as $opt) {
1104 @list
($value, $text, $select, $disabled) = $opt;
1106 if (is_null($text)) $text = $value;
1107 $p .= ' value="'. formText($value) .'"';
1108 if (!empty($select)) $p .= ' selected="selected"';
1109 if ($disabled) $p .= ' disabled="disabled"';
1110 $s .= '<option'.$p.'>'. formText($text) .'</option>';
1113 $s .= '<option></option>';
1115 $s .= DOKU_LF
.'</select></label>';
1116 if (preg_match('/(^| )block($| )/', $attrs['_class']))