Source for file InstantClientScript.php

Documentation is available at InstantClientScript.php

1: <?php
2:
3: /**
4: * Nette Framework
5: *
6: * Copyright (c) 2004, 2009 David Grudl (http://davidgrudl.com)
7: *
8: * This source file is subject to the "Nette license" that is bundled
9: * with this package in the file license.txt.
10: *
11: * For more information please see https://nette.org
12: *
13: * @copyright Copyright (c) 2004, 2009 David Grudl
14: * @license https://nette.org/license Nette license
15: * @link https://nette.org
16: * @category Nette
17: * @package Nette\Forms
18: * @version $Id$
19: */
20:
21:
22:
23: require_once dirname(__FILE__) . '/../../Object.php';
24:
25:
26:
27: /**
28: * Instant validation JavaScript generator.
29: *
30: * @author David Grudl
31: * @copyright Copyright (c) 2004, 2009 David Grudl
32: * @package Nette\Forms
33: */
34: final class InstantClientScript extends Object
35: {
36: /** @var string JavaScript event handler name */
37: public $validateFunction;
38:
39: /** @var string JavaScript event handler name */
40: public $toggleFunction;
41:
42: /** @var string JavaScript code */
43: public $doAlert = 'if (element) element.focus(); alert(message);';
44:
45: /** @var string JavaScript code */
46: public $doToggle = 'if (element) element.style.display = visible ? "" : "none";';
47:
48: /** @var string */
49: public $validateScript;
50:
51: /** @var string */
52: public $toggleScript;
53:
54: /** @var bool */
55: private $central;
56:
57: /** @var Form */
58: private $form;
59:
60:
61:
62: public function __construct(Form $form)
63: {
64: $this->form = $form;
65: $name = ucfirst($form->getName()); //ucfirst(strtr($form->getUniqueId(), Form::NAME_SEPARATOR, '_'));
66: $this->validateFunction = 'validate' . $name;
67: $this->toggleFunction = 'toggle' . $name;
68: }
69:
70:
71:
72: public function enable()
73: {
74: $this->validateScript = '';
75: $this->toggleScript = '';
76: $this->central = TRUE;
77:
78: foreach ($this->form->getControls() as $control) {
79: $script = $this->getValidateScript($control->getRules());
80: if ($script) {
81: $this->validateScript .= "do {\n\t$script} while(0);\n\n\t";
82: }
83: $this->toggleScript .= $this->getToggleScript($control->getRules());
84:
85: if ($control instanceof ISubmitterControl && $control->getValidationScope() !== TRUE) {
86: $this->central = FALSE;
87: }
88: }
89:
90: if ($this->validateScript || $this->toggleScript) {
91: if ($this->central) {
92: $this->form->getElementPrototype()->onsubmit("return $this->validateFunction(this)", TRUE);
93:
94: } else {
95: foreach ($this->form->getComponents(TRUE, 'Nette\Forms\ISubmitterControl') as $control) {
96: if ($control->getValidationScope()) {
97: $control->getControlPrototype()->onclick("return $this->validateFunction(this)", TRUE);
98: }
99: }
100: }
101: }
102: }
103:
104:
105:
106: /**
107: * Generates the client side validation script.
108: * @return string
109: */
110: public function renderClientScript()
111: {
112: $s = '';
113:
114: if ($this->validateScript) {
115: $s .= "function $this->validateFunction(sender) {\n\t"
116: . "var element, message, res;\n\t"
117: . $this->validateScript
118: . "return true;\n"
119: . "}\n\n";
120: }
121:
122: if ($this->toggleScript) {
123: $s .= "function $this->toggleFunction(sender) {\n\t"
124: . "var element, visible, res;\n\t"
125: . $this->toggleScript
126: . "\n}\n\n"
127: . "$this->toggleFunction(null);\n";
128: }
129:
130: if ($s) {
131: return "<script type=\"text/javascript\">\n"
132: . "/* <![CDATA[ */\n"
133: . $s
134: . "/* ]]> */\n"
135: . "</script>";
136: }
137: }
138:
139:
140:
141: private function getValidateScript(Rules $rules, $onlyCheck = FALSE)
142: {
143: $res = '';
144: foreach ($rules as $rule) {
145: if (!is_string($rule->operation)) continue;
146:
147: if (strcasecmp($rule->operation, 'Nette\Forms\InstantClientScript::javascript') === 0) {
148: $res .= "$rule->arg\n\t";
149: continue;
150: }
151:
152: $script = $this->getClientScript($rule->control, $rule->operation, $rule->arg);
153: if (!$script) continue;
154:
155: if (!empty($rule->message)) { // this is rule
156: if ($onlyCheck) {
157: $res .= "$script\n\tif (" . ($rule->isNegative ? '' : '!') . "res) { return false; }\n\t";
158:
159: } else {
160: $res .= "$script\n\t"
161: . "if (" . ($rule->isNegative ? '' : '!') . "res) { "
162: . "message = " . json_encode((string) vsprintf($rule->control->translate($rule->message), (array) $rule->arg)) . "; "
163: . $this->doAlert
164: . " return false; }\n\t";
165: }
166: }
167:
168: if ($rule->type === Rule::CONDITION) { // this is condition
169: $innerScript = $this->getValidateScript($rule->subRules, $onlyCheck);
170: if ($innerScript) {
171: $res .= "$script\n\tif (" . ($rule->isNegative ? '!' : '') . "res) {\n\t\t" . str_replace("\n\t", "\n\t\t", rtrim($innerScript)) . "\n\t}\n\t";
172: if (!$onlyCheck && $rule->control instanceof ISubmitterControl) {
173: $this->central = FALSE;
174: }
175: }
176: }
177: }
178: return $res;
179: }
180:
181:
182:
183: private function getToggleScript(Rules $rules, $cond = NULL)
184: {
185: $s = '';
186: foreach ($rules->getToggles() as $id => $visible) {
187: $s .= "visible = true; {$cond}element = document.getElementById('" . $id . "');\n\t"
188: . ($visible ? '' : 'visible = !visible; ')
189: . $this->doToggle
190: . "\n\t";
191: }
192: foreach ($rules as $rule) {
193: if ($rule->type === Rule::CONDITION && is_string($rule->operation)) {
194: $script = $this->getClientScript($rule->control, $rule->operation, $rule->arg);
195: if ($script) {
196: $res = $this->getToggleScript($rule->subRules, $cond . "$script visible = visible && " . ($rule->isNegative ? '!' : '') . "res;\n\t");
197: if ($res) {
198: $el = $rule->control->getControlPrototype();
199: if ($el->getName() === 'select') {
200: $el->onchange("$this->toggleFunction(this)", TRUE);
201: } else {
202: $el->onclick("$this->toggleFunction(this)", TRUE);
203: //$el->onkeyup("$this->toggleFunction(this)", TRUE);
204: }
205: $s .= $res;
206: }
207: }
208: }
209: }
210: return $s;
211: }
212:
213:
214:
215: private function getValueScript(IFormControl $control)
216: {
217: $tmp = "element = document.getElementById(" . json_encode($control->getHtmlId()) . ");\n\t";
218: switch (TRUE) {
219: case $control instanceof Checkbox:
220: return $tmp . "var val = element.checked;\n\t";
221:
222: case $control instanceof RadioList:
223: return "for (var val=null, i=0; i<" . count($control->getItems()) . "; i++) {\n\t\t"
224: . "element = document.getElementById(" . json_encode($control->getHtmlId() . '-') . "+i);\n\t\t"
225: . "if (element.checked) { val = element.value; break; }\n\t"
226: . "}\n\t";
227:
228: default:
229: return $tmp . "var val = element.value.replace(/^\\s+|\\s+\$/g, '');\n\t";
230: }
231: }
232:
233:
234:
235: private function getClientScript(IFormControl $control, $operation, $arg)
236: {
237: $operation = strtolower($operation);
238: switch (TRUE) {
239: case $control instanceof HiddenField || $control->isDisabled():
240: return NULL;
241:
242: case $operation === ':filled' && $control instanceof RadioList:
243: return $this->getValueScript($control) . "res = val !== null;";
244:
245: case $operation === ':submitted' && $control instanceof SubmitButton:
246: return "element=null; res=sender && sender.name==" . json_encode($control->getHtmlName()) . ";";
247:
248: case $operation === ':equal' && $control instanceof MultiSelectBox:
249: $tmp = array();
250: foreach ((is_array($arg) ? $arg : array($arg)) as $item) {
251: $tmp[] = "element.options[i].value==" . json_encode((string) $item);
252: }
253: $first = $control->isFirstSkipped() ? 1 : 0;
254: return "element = document.getElementById(" . json_encode($control->getHtmlId()) . ");\n\tres = false;\n\t"
255: . "for (var i=$first;i<element.options.length;i++)\n\t\t"
256: . "if (element.options[i].selected && (" . implode(' || ', $tmp) . ")) { res = true; break; }";
257:
258: case $operation === ':filled' && $control instanceof SelectBox:
259: return "element = document.getElementById(" . json_encode($control->getHtmlId()) . ");\n\t"
260: . "res = element.selectedIndex >= " . ($control->isFirstSkipped() ? 1 : 0) . ";";
261:
262: case $operation === ':filled' && $control instanceof TextInput:
263: return $this->getValueScript($control) . "res = val!='' && val!=" . json_encode((string) $control->getEmptyValue()) . ";";
264:
265: case $operation === ':minlength' && $control instanceof TextBase:
266: return $this->getValueScript($control) . "res = val.length>=" . (int) $arg . ";";
267:
268: case $operation === ':maxlength' && $control instanceof TextBase:
269: return $this->getValueScript($control) . "res = val.length<=" . (int) $arg . ";";
270:
271: case $operation === ':length' && $control instanceof TextBase:
272: if (!is_array($arg)) {
273: $arg = array($arg, $arg);
274: }
275: return $this->getValueScript($control) . "res = " . ($arg[0] === NULL ? "true" : "val.length>=" . (int) $arg[0]) . " && "
276: . ($arg[1] === NULL ? "true" : "val.length<=" . (int) $arg[1]) . ";";
277:
278: case $operation === ':email' && $control instanceof TextBase:
279: return $this->getValueScript($control) . 'res = /^[^@]+@[^@]+\.[a-z]{2,6}$/i.test(val);';
280:
281: case $operation === ':url' && $control instanceof TextBase:
282: return $this->getValueScript($control) . 'res = /^.+\.[a-z]{2,6}(\\/.*)?$/i.test(val);';
283:
284: case $operation === ':regexp' && $control instanceof TextBase:
285: if (strncmp($arg, '/', 1)) {
286: throw new InvalidStateException("Regular expression '$arg' must be JavaScript compatible.");
287: }
288: return $this->getValueScript($control) . "res = $arg.test(val);";
289:
290: case $operation === ':integer' && $control instanceof TextBase:
291: return $this->getValueScript($control) . "res = /^-?[0-9]+$/.test(val);";
292:
293: case $operation === ':float' && $control instanceof TextBase:
294: return $this->getValueScript($control) . "res = /^-?[0-9]*[.,]?[0-9]+$/.test(val);";
295:
296: case $operation === ':range' && $control instanceof TextBase:
297: return $this->getValueScript($control) . "res = " . ($arg[0] === NULL ? "true" : "parseFloat(val)>=" . json_encode((float) $arg[0])) . " && "
298: . ($arg[1] === NULL ? "true" : "parseFloat(val)<=" . json_encode((float) $arg[1])) . ";";
299:
300: case $operation === ':filled' && $control instanceof FormControl:
301: return $this->getValueScript($control) . "res = val!='';";
302:
303: case $operation === ':valid' && $control instanceof FormControl:
304: return $this->getValueScript($control) . "res = function(){\n\t" . $this->getValidateScript($control->getRules(), TRUE) . "return true; }();";
305:
306: case $operation === ':equal' && $control instanceof FormControl:
307: if ($control instanceof Checkbox) $arg = (bool) $arg;
308: $tmp = array();
309: foreach ((is_array($arg) ? $arg : array($arg)) as $item) {
310: if ($item instanceof IFormControl) { // compare with another form control?
311: $tmp[] = "val==function(){var element;" . $this->getValueScript($item). "return val;}()";
312: } else {
313: $tmp[] = "val==" . json_encode($item);
314: }
315: }
316: return $this->getValueScript($control) . "res = (" . implode(' || ', $tmp) . ");";
317: }
318: }
319:
320:
321:
322: public static function javascript()
323: {
324: return TRUE;
325: }
326:
327: }

Source for file InstantClientScript.php

Namespaces