File: form.inc.php

package info (click to toggle)
zoph 1.4-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 16,632 kB
  • sloc: php: 28,044; javascript: 10,435; sql: 527; sh: 153; makefile: 4
file content (178 lines) | stat: -rw-r--r-- 5,363 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
<?php
/**
 * Class that takes care of displaying a form
 *
 * This file is part of Zoph.
 *
 * Zoph is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * Zoph is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * You should have received a copy of the GNU General Public License
 * along with Zoph; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * @author Jeroen Roos
 * @package Zoph
 */

namespace template;

/**
 * This class takes care of displaying forms
 *
 * @author Jeroen Roos
 * @package Zoph
 */
class form extends block {
    /**
     * Add a form field INPUT type text
     * @param string name
     * @param string current / initial value
     * @param string label text for label
     * @param string input hint
     * @param int maximum input length
     * @param int size of the field
     */
    public function addInputText($name, $value, $label=null, $hint=null, $maxlength=32, $size=null) {
        $this->addBlock(template::createInput($name, $value, $maxlength, $label, $size, $hint));
    }

    /**
     * Add a form field INPUT type email
     * @param string name
     * @param string current / initial value
     * @param string label text for label
     * @param string input hint
     * @param int maximum input length
     * @param int size of the field
     */
    public function addInputEmail($name, $value, $label=null) {
        $this->addBlock(template::createInputEmail($name, $value, $label));
    }

    /**
     * Add a form field INPUT type password
     * @param string name
     * @param string label text for label
     * @param string input hint
     * @param int size of the field
     */
    public function addInputPassword($name, $label=null, $hint=null, $size=32) {
        $this->addBlock(new block("formInputPassword", array(
            "name"  => $name,
            "label" => e($label),
            "hint"  => e($hint),
            "size"  => (int) $size
        )));
    }

    /**
     * Add a form field INPUT type hidden
     * @param string name
     * @param string value
     */
    public function addInputHidden($name, $value) {
        $this->addBlock(new block("formInputHidden", array(
            "name"  => $name,
            "value" => e($value),
        )));
    }

   /**
    * Add hidden fields to this form
    * @param array array of key -> value pairs to make into hidden fields
    * @param array array of keys that should not be included
    */
    public function addHiddenFields(array $vars, array $ignore = array()) {
        foreach ($vars as $key => $val) {
            if (!in_array($key, $ignore)) {
                if (is_array($val)) {
                    foreach ($val as $i => $v) {
                        $this->addInputHidden($key . "[" . $i . "]", $v);
                    }

                } else {
                    $this->addInputHidden($key, $val);
                }
            }
        }
    }

    /**
     * Add a form field INPUT type checkbox
     * @param string name
     * @param bool checked
     * @param string label text for label
     * @param string input hint
     */
    public function addInputCheckbox($name, $checked, $label, $hint=null) {
        $this->addBlock(new block("formInputCheckbox", array(
            "name"  => $name,
            "checked" => $checked,
            "label" => e($label),
            "hint"  => e($hint),
        )));
    }

    /**
     * Add a form field TEXTAREA
     * @param string name
     * @param string current / initial value
     * @param string label text for label
     * @param int columns
     * @param int rows
     */
    public function addTextarea($name, $value, $label=null, $cols=40, $rows=4) {
        $this->addBlock(new block("formTextarea", array(
            "name"  => $name,
            "value" => e($value),
            "label" => e($label),
            "cols"  => (int) $cols,
            "rows"  => (int) $rows
        )));
    }

    /**
     * Add a form field dropdown
     * this function is not actually creating the dropdown, but
     * acts as a wrapper around the dropdown, to add a label
     * @param string name
     * @param block dropdown
     * @param string label text for label
     */
    public function addDropdown($name, block $dropdown, $label) {
        $this->addBlock(new block("formDropdown", array(
            "name"      => $name,
            "dropdown"  => $dropdown,
            "label"     => $label
        )));
    }

    /**
     * add fieldset
     * @param fieldset fieldset
     */
    public function addFieldset(fieldset $fieldset) {
        $this->addBlock($fieldset);
    }

    /**
     * Create a form label
     * @param string id of field this label is for
     * @param string label label text
     */
    public static function createLabel(string $for, string $label) {
        return new block("formLabel", array(
            "for"   => $for,
            "label" => $label
        ));
    }


}