basewidget.inc.php
6.23 KB
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
179
<?php
/**
* $Id$
*
* The contents of this file are subject to the KnowledgeTree Public
* License Version 1.1.2 ("License"); You may not use this file except in
* compliance with the License. You may obtain a copy of the License at
* http://www.knowledgetree.com/KPL
*
* Software distributed under the License is distributed on an "AS IS"
* basis, WITHOUT WARRANTY OF ANY KIND, either express or implied.
* See the License for the specific language governing rights and
* limitations under the License.
*
* All copies of the Covered Code must include on each user interface screen:
* (i) the "Powered by KnowledgeTree" logo and
* (ii) the KnowledgeTree copyright notice
* in the same form as they appear in the distribution. See the License for
* requirements.
*
* The Original Code is: KnowledgeTree Open Source
*
* The Initial Developer of the Original Code is The Jam Warehouse Software
* (Pty) Ltd, trading as KnowledgeTree.
* Portions created by The Jam Warehouse Software (Pty) Ltd are Copyright
* (C) 2007 The Jam Warehouse Software (Pty) Ltd;
* All Rights Reserved.
* Contributor( s): ______________________________________
*/
// unfortunately the autovalidation stuff requires that link to validation here.
require_once(KT_LIB_DIR . "/validation/validatorfactory.inc.php");
class KTWidget {
var $sNamespace = 'kt.abstract.basewidget';
var $sLabel = '';
var $sDescription = '';
var $sName = '';
var $sOrigname;
var $sBasename = '';
var $sId = null;
var $bRequired = false;
var $aOptions = null;
var $aErrors = null;
var $value = null;
var $bAutoValidate;
var $aJavascript = array(); // what javascript do we need added.
var $aCSS = array();
// allow very quick overrides.
var $sTemplate = "ktcore/widgets/base";
function configure($aOptions) {
$this->sLabel = KTUtil::arrayGet($aOptions, 'label');
$this->sDescription = KTUtil::arrayGet($aOptions, 'description');
$this->sName = KTUtil::arrayGet($aOptions, 'name');
$this->sOrigname = $this->sName;
$this->sBasename = $this->sName; // we need to be able to get the "old" value after wrapping.
$this->value = KTUtil::arrayGet($aOptions, 'value');
$this->bRequired = (KTUtil::arrayGet($aOptions, 'required') == true);
$this->sId = KTUtil::arrayGet($aOptions, 'id');
$this->aOptions = $aOptions; // there may be additional options
$this->aErrors = array();
$this->bAutoValidate = KTUtil::arrayGet($aOptions, 'autovalidate', true, false); // false is a valid answer here
$this->aOptions['width'] = KTUtil::arrayGet($this->aOptions, 'width', '45');
}
function getDefault() { return $this->value; }
function setDefault($mValue) { $this->value = $mValue; }
function getBasename() { return $this->sBasename; }
function wrapName($sOuter) {
// wrap the name. we *require* that something extract up to the level
// at which basename is accurate.
$this->sName = sprintf('%s[%s]', $sOuter, $this->sBasename);
}
function setErrors($aErrors = null) {
if (is_array($aErrors)) {
$this->aErrors = $aErrors;
}
}
function requireJSResource($sResourceURL) {
$this->aJavascript[] = $sResourceURL;
}
function render() {
// very simple, general purpose passthrough. Chances are this is sufficient,
// just override the template being used.
$bHasErrors = false;
if (count($this->aErrors) != 0) { $bHasErrors = true; }
//var_dump($this->aErrors);
$oTemplating =& KTTemplating::getSingleton();
$oTemplate = $oTemplating->loadTemplate('ktcore/forms/widgets/base');
if (!empty($this->aJavascript)) {
// grab our inner page.
$oPage =& $GLOBALS['main'];
$oPage->requireJSResources($this->aJavascript);
}
if (!empty($this->aCSS)) {
// grab our inner page.
$oPage =& $GLOBALS['main'];
$oPage->requireCSSResources($this->aCSS);
}
$widget_content = $this->getWidget();
$aTemplateData = array(
"context" => $this,
"label" => $this->sLabel,
"description" => $this->sDescription,
"name" => $this->sName,
"required" => $this->bRequired,
"has_id" => ($this->sId !== null),
"id" => $this->sId,
"has_value" => ($this->value !== null),
"value" => $this->value,
"has_errors" => $bHasErrors,
"errors" => $this->aErrors,
"options" => $this->aOptions,
"widget" => $widget_content,
);
return $oTemplate->render($aTemplateData);
}
function getWidget() {
$oTemplating =& KTTemplating::getSingleton();
$oTemplate = $oTemplating->loadTemplate($this->sTemplate);
$aTemplateData = array(
"context" => $this,
"label" => $this->sLabel,
"description" => $this->sDescription,
"name" => $this->sName,
"required" => $this->bRequired,
"has_id" => ($this->sId !== null),
"id" => $this->sId,
"has_value" => ($this->value !== null),
"value" => $this->value,
"has_errors" => $bHasErrors,
"errors" => $this->aErrors,
"options" => $this->aOptions,
);
return $oTemplate->render($aTemplateData);
}
function getValidators() {
if (!$this->bAutoValidate) {
return null;
}
// the base widget handles only the simplest possible case - required
// fields
if (!$this->bRequired) {
return null;
}
$oVF =& KTValidatorFactory::getSingleton();
return $oVF->get('ktcore.validators.required', array(
'test' => $this->sOrigname,
'basename' => $this->sBasename
));
}
function process($raw_data) {
return array($this->sBasename => KTUtil::arrayGet($raw_data, $this->sOrigname));
}
}
?>