Packages

  • Nette
    • Application
      • Diagnostics
      • Responses
      • Routers
      • UI
    • Caching
      • Storages
    • ComponentModel
    • Config
      • Adapters
      • Extensions
    • Database
      • Diagnostics
      • Drivers
      • Reflection
      • Table
    • DI
      • Diagnostics
    • Diagnostics
    • Forms
      • Controls
      • Rendering
    • Http
    • Iterators
    • Latte
      • Macros
    • Loaders
    • Localization
    • Mail
    • Reflection
    • Security
      • Diagnostics
    • Templating
    • Utils
      • PhpGenerator
  • NetteModule
  • None
  • PHP

Classes

  • Form
  • FormContainer
  • FormGroup
  • Rule
  • Rules

Interfaces

  • IFormControl
  • IFormRenderer
  • ISubmitterControl
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  1: <?php
  2: 
  3: /**
  4:  * This file is part of the Nette Framework (http://nette.org)
  5:  *
  6:  * Copyright (c) 2004 David Grudl (http://davidgrudl.com)
  7:  *
  8:  * For the full copyright and license information, please view
  9:  * the file license.txt that was distributed with this source code.
 10:  * @package Nette\Forms
 11:  */
 12: 
 13: 
 14: 
 15: /**
 16:  * Creates, validates and renders HTML forms.
 17:  *
 18:  * @author     David Grudl
 19:  *
 20:  * @property   mixed $action
 21:  * @property   string $method
 22:  * @property-read array $groups
 23:  * @property   ITranslator|NULL $translator
 24:  * @property-read bool $anchored
 25:  * @property-read ISubmitterControl|FALSE $submitted
 26:  * @property-read bool $success
 27:  * @property-read array $httpData
 28:  * @property-read array $errors
 29:  * @property-read Html $elementPrototype
 30:  * @property   IFormRenderer $renderer
 31:  * @package Nette\Forms
 32:  */
 33: class Form extends FormContainer
 34: {
 35:     /** validator */
 36:     const EQUAL = ':equal',
 37:         IS_IN = ':equal',
 38:         FILLED = ':filled',
 39:         VALID = ':valid';
 40: 
 41:     // CSRF protection
 42:     const PROTECTION = 'HiddenField::validateEqual';
 43: 
 44:     // button
 45:     const SUBMITTED = ':submitted';
 46: 
 47:     // text
 48:     const MIN_LENGTH = ':minLength',
 49:         MAX_LENGTH = ':maxLength',
 50:         LENGTH = ':length',
 51:         EMAIL = ':email',
 52:         URL = ':url',
 53:         REGEXP = ':regexp',
 54:         PATTERN = ':pattern',
 55:         INTEGER = ':integer',
 56:         NUMERIC = ':integer',
 57:         FLOAT = ':float',
 58:         RANGE = ':range';
 59: 
 60:     // multiselect
 61:     const COUNT = ':length';
 62: 
 63:     // file upload
 64:     const MAX_FILE_SIZE = ':fileSize',
 65:         MIME_TYPE = ':mimeType',
 66:         IMAGE = ':image';
 67: 
 68:     /** method */
 69:     const GET = 'get',
 70:         POST = 'post';
 71: 
 72:     /** @internal tracker ID */
 73:     const TRACKER_ID = '_form_';
 74: 
 75:     /** @internal protection token ID */
 76:     const PROTECTOR_ID = '_token_';
 77: 
 78:     /** @var array of function(Form $sender); Occurs when the form is submitted and successfully validated */
 79:     public $onSuccess;
 80: 
 81:     /** @var array of function(Form $sender); Occurs when the form is submitted and is not valid */
 82:     public $onError;
 83: 
 84:     /** @var array of function(Form $sender); Occurs when the form is submitted */
 85:     public $onSubmit;
 86: 
 87:     /** @deprecated */
 88:     public $onInvalidSubmit;
 89: 
 90:     /** @var mixed or NULL meaning: not detected yet */
 91:     private $submittedBy;
 92: 
 93:     /** @var array */
 94:     private $httpData;
 95: 
 96:     /** @var Html  <form> element */
 97:     private $element;
 98: 
 99:     /** @var IFormRenderer */
100:     private $renderer;
101: 
102:     /** @var ITranslator */
103:     private $translator;
104: 
105:     /** @var FormGroup[] */
106:     private $groups = array();
107: 
108:     /** @var array */
109:     private $errors = array();
110: 
111: 
112: 
113:     /**
114:      * Form constructor.
115:      * @param  string
116:      */
117:     public function __construct($name = NULL)
118:     {
119:         $this->element = Html::el('form');
120:         $this->element->action = ''; // RFC 1808 -> empty uri means 'this'
121:         $this->element->method = self::POST;
122:         $this->element->id = $name === NULL ? NULL : 'frm-' . $name;
123: 
124:         $this->monitor(__CLASS__);
125:         if ($name !== NULL) {
126:             $tracker = new HiddenField($name);
127:             $tracker->unmonitor(__CLASS__);
128:             $this[self::TRACKER_ID] = $tracker;
129:         }
130:         parent::__construct(NULL, $name);
131:     }
132: 
133: 
134: 
135:     /**
136:      * This method will be called when the component (or component's parent)
137:      * becomes attached to a monitored object. Do not call this method yourself.
138:      * @param  IComponent
139:      * @return void
140:      */
141:     protected function attached($obj)
142:     {
143:         if ($obj instanceof self) {
144:             throw new InvalidStateException('Nested forms are forbidden.');
145:         }
146:     }
147: 
148: 
149: 
150:     /**
151:      * Returns self.
152:      * @return Form
153:      */
154:     final public function getForm($need = TRUE)
155:     {
156:         return $this;
157:     }
158: 
159: 
160: 
161:     /**
162:      * Sets form's action.
163:      * @param  mixed URI
164:      * @return Form  provides a fluent interface
165:      */
166:     public function setAction($url)
167:     {
168:         $this->element->action = $url;
169:         return $this;
170:     }
171: 
172: 
173: 
174:     /**
175:      * Returns form's action.
176:      * @return mixed URI
177:      */
178:     public function getAction()
179:     {
180:         return $this->element->action;
181:     }
182: 
183: 
184: 
185:     /**
186:      * Sets form's method.
187:      * @param  string get | post
188:      * @return Form  provides a fluent interface
189:      */
190:     public function setMethod($method)
191:     {
192:         if ($this->httpData !== NULL) {
193:             throw new InvalidStateException(__METHOD__ . '() must be called until the form is empty.');
194:         }
195:         $this->element->method = strtolower($method);
196:         return $this;
197:     }
198: 
199: 
200: 
201:     /**
202:      * Returns form's method.
203:      * @return string get | post
204:      */
205:     public function getMethod()
206:     {
207:         return $this->element->method;
208:     }
209: 
210: 
211: 
212:     /**
213:      * Cross-Site Request Forgery (CSRF) form protection.
214:      * @param  string
215:      * @param  int
216:      * @return void
217:      */
218:     public function addProtection($message = NULL, $timeout = NULL)
219:     {
220:         $session = $this->getSession()->getSection('Nette.Forms.Form/CSRF');
221:         $key = "key$timeout";
222:         if (isset($session->$key)) {
223:             $token = $session->$key;
224:         } else {
225:             $session->$key = $token = Strings::random();
226:         }
227:         $session->setExpiration($timeout, $key);
228:         $this[self::PROTECTOR_ID] = new HiddenField($token);
229:         $this[self::PROTECTOR_ID]->addRule(self::PROTECTION, $message, $token);
230:     }
231: 
232: 
233: 
234:     /**
235:      * Adds fieldset group to the form.
236:      * @param  string  caption
237:      * @param  bool    set this group as current
238:      * @return FormGroup
239:      */
240:     public function addGroup($caption = NULL, $setAsCurrent = TRUE)
241:     {
242:         $group = new FormGroup;
243:         $group->setOption('label', $caption);
244:         $group->setOption('visual', TRUE);
245: 
246:         if ($setAsCurrent) {
247:             $this->setCurrentGroup($group);
248:         }
249: 
250:         if (isset($this->groups[$caption])) {
251:             return $this->groups[] = $group;
252:         } else {
253:             return $this->groups[$caption] = $group;
254:         }
255:     }
256: 
257: 
258: 
259:     /**
260:      * Removes fieldset group from form.
261:      * @param  string|FormGroup
262:      * @return void
263:      */
264:     public function removeGroup($name)
265:     {
266:         if (is_string($name) && isset($this->groups[$name])) {
267:             $group = $this->groups[$name];
268: 
269:         } elseif ($name instanceof FormGroup && in_array($name, $this->groups, TRUE)) {
270:             $group = $name;
271:             $name = array_search($group, $this->groups, TRUE);
272: 
273:         } else {
274:             throw new InvalidArgumentException("Group not found in form '$this->name'");
275:         }
276: 
277:         foreach ($group->getControls() as $control) {
278:             $this->removeComponent($control);
279:         }
280: 
281:         unset($this->groups[$name]);
282:     }
283: 
284: 
285: 
286:     /**
287:      * Returns all defined groups.
288:      * @return FormGroup[]
289:      */
290:     public function getGroups()
291:     {
292:         return $this->groups;
293:     }
294: 
295: 
296: 
297:     /**
298:      * Returns the specified group.
299:      * @param  string  name
300:      * @return FormGroup
301:      */
302:     public function getGroup($name)
303:     {
304:         return isset($this->groups[$name]) ? $this->groups[$name] : NULL;
305:     }
306: 
307: 
308: 
309:     /********************* translator ****************d*g**/
310: 
311: 
312: 
313:     /**
314:      * Sets translate adapter.
315:      * @return Form  provides a fluent interface
316:      */
317:     public function setTranslator(ITranslator $translator = NULL)
318:     {
319:         $this->translator = $translator;
320:         return $this;
321:     }
322: 
323: 
324: 
325:     /**
326:      * Returns translate adapter.
327:      * @return ITranslator|NULL
328:      */
329:     final public function getTranslator()
330:     {
331:         return $this->translator;
332:     }
333: 
334: 
335: 
336:     /********************* submission ****************d*g**/
337: 
338: 
339: 
340:     /**
341:      * Tells if the form is anchored.
342:      * @return bool
343:      */
344:     public function isAnchored()
345:     {
346:         return TRUE;
347:     }
348: 
349: 
350: 
351:     /**
352:      * Tells if the form was submitted.
353:      * @return ISubmitterControl|FALSE  submittor control
354:      */
355:     final public function isSubmitted()
356:     {
357:         if ($this->submittedBy === NULL && count($this->getControls())) {
358:             $this->getHttpData();
359:             $this->submittedBy = $this->httpData !== NULL;
360:         }
361:         return $this->submittedBy;
362:     }
363: 
364: 
365: 
366:     /**
367:      * Tells if the form was submitted and successfully validated.
368:      * @return bool
369:      */
370:     final public function isSuccess()
371:     {
372:         return $this->isSubmitted() && $this->isValid();
373:     }
374: 
375: 
376: 
377:     /**
378:      * Sets the submittor control.
379:      * @return Form  provides a fluent interface
380:      */
381:     public function setSubmittedBy(ISubmitterControl $by = NULL)
382:     {
383:         $this->submittedBy = $by === NULL ? FALSE : $by;
384:         return $this;
385:     }
386: 
387: 
388: 
389:     /**
390:      * Returns submitted HTTP data.
391:      * @return array
392:      */
393:     final public function getHttpData()
394:     {
395:         if ($this->httpData === NULL) {
396:             if (!$this->isAnchored()) {
397:                 throw new InvalidStateException('Form is not anchored and therefore can not determine whether it was submitted.');
398:             }
399:             $this->httpData = $this->receiveHttpData();
400:         }
401:         return $this->httpData;
402:     }
403: 
404: 
405: 
406:     /**
407:      * Fires submit/click events.
408:      * @return void
409:      */
410:     public function fireEvents()
411:     {
412:         if (!$this->isSubmitted()) {
413:             return;
414: 
415:         } elseif ($this->submittedBy instanceof ISubmitterControl) {
416:             if (!$this->submittedBy->getValidationScope() || $this->isValid()) {
417:                 $this->submittedBy->click();
418:                 $valid = TRUE;
419:             } else {
420:                 $this->submittedBy->onInvalidClick($this->submittedBy);
421:             }
422:         }
423: 
424:         if (isset($valid) || $this->isValid()) {
425:             $this->onSuccess($this);
426:         } else {
427:             $this->onError($this);
428:             if ($this->onInvalidSubmit) {
429:                 trigger_error(__CLASS__ . '->onInvalidSubmit is deprecated; use onError instead.', E_USER_WARNING);
430:                 $this->onInvalidSubmit($this);
431:             }
432:         }
433: 
434:         if ($this->onSuccess) { // back compatibility
435:             $this->onSubmit($this);
436:         } elseif ($this->onSubmit) {
437:             trigger_error(__CLASS__ . '->onSubmit changed its behavior; use onSuccess instead.', E_USER_WARNING);
438:             if (isset($valid) || $this->isValid()) {
439:                 $this->onSubmit($this);
440:             }
441:         }
442:     }
443: 
444: 
445: 
446:     /**
447:      * Internal: receives submitted HTTP data.
448:      * @return array
449:      */
450:     protected function receiveHttpData()
451:     {
452:         $httpRequest = $this->getHttpRequest();
453:         if (strcasecmp($this->getMethod(), $httpRequest->getMethod())) {
454:             return;
455:         }
456: 
457:         if ($httpRequest->isMethod('post')) {
458:             $data = Arrays::mergeTree($httpRequest->getPost(), $httpRequest->getFiles());
459:         } else {
460:             $data = $httpRequest->getQuery();
461:         }
462: 
463:         if ($tracker = $this->getComponent(self::TRACKER_ID, FALSE)) {
464:             if (!isset($data[self::TRACKER_ID]) || $data[self::TRACKER_ID] !== $tracker->getValue()) {
465:                 return;
466:             }
467:         }
468: 
469:         return $data;
470:     }
471: 
472: 
473: 
474:     /********************* data exchange ****************d*g**/
475: 
476: 
477: 
478:     /**
479:      * Returns the values submitted by the form.
480:      * @return ArrayHash|array
481:      */
482:     public function getValues($asArray = FALSE)
483:     {
484:         $values = parent::getValues($asArray);
485:         unset($values[self::TRACKER_ID], $values[self::PROTECTOR_ID]);
486:         return $values;
487:     }
488: 
489: 
490: 
491:     /********************* validation ****************d*g**/
492: 
493: 
494: 
495:     /**
496:      * Adds error message to the list.
497:      * @param  string  error message
498:      * @return void
499:      */
500:     public function addError($message)
501:     {
502:         $this->valid = FALSE;
503:         if ($message !== NULL && !in_array($message, $this->errors, TRUE)) {
504:             $this->errors[] = $message;
505:         }
506:     }
507: 
508: 
509: 
510:     /**
511:      * Returns validation errors.
512:      * @return array
513:      */
514:     public function getErrors()
515:     {
516:         return $this->errors;
517:     }
518: 
519: 
520: 
521:     /**
522:      * @return bool
523:      */
524:     public function hasErrors()
525:     {
526:         return (bool) $this->getErrors();
527:     }
528: 
529: 
530: 
531:     /**
532:      * @return void
533:      */
534:     public function cleanErrors()
535:     {
536:         $this->errors = array();
537:         $this->valid = NULL;
538:     }
539: 
540: 
541: 
542:     /********************* rendering ****************d*g**/
543: 
544: 
545: 
546:     /**
547:      * Returns form's HTML element template.
548:      * @return Html
549:      */
550:     public function getElementPrototype()
551:     {
552:         return $this->element;
553:     }
554: 
555: 
556: 
557:     /**
558:      * Sets form renderer.
559:      * @return Form  provides a fluent interface
560:      */
561:     public function setRenderer(IFormRenderer $renderer)
562:     {
563:         $this->renderer = $renderer;
564:         return $this;
565:     }
566: 
567: 
568: 
569:     /**
570:      * Returns form renderer.
571:      * @return IFormRenderer
572:      */
573:     final public function getRenderer()
574:     {
575:         if ($this->renderer === NULL) {
576:             $this->renderer = new DefaultFormRenderer;
577:         }
578:         return $this->renderer;
579:     }
580: 
581: 
582: 
583:     /**
584:      * Renders form.
585:      * @return void
586:      */
587:     public function render()
588:     {
589:         $args = func_get_args();
590:         array_unshift($args, $this);
591:         echo call_user_func_array(array($this->getRenderer(), 'render'), $args);
592:     }
593: 
594: 
595: 
596:     /**
597:      * Renders form to string.
598:      * @return bool  can throw exceptions? (hidden parameter)
599:      * @return string
600:      */
601:     public function __toString()
602:     {
603:         try {
604:             return $this->getRenderer()->render($this);
605: 
606:         } catch (Exception $e) {
607:             if (func_get_args() && func_get_arg(0)) {
608:                 throw $e;
609:             } else {
610:                 trigger_error("Exception in " . __METHOD__ . "(): {$e->getMessage()} in {$e->getFile()}:{$e->getLine()}", E_USER_ERROR);
611:             }
612:         }
613:     }
614: 
615: 
616: 
617:     /********************* backend ****************d*g**/
618: 
619: 
620: 
621:     /**
622:      * @return IHttpRequest
623:      */
624:     protected function getHttpRequest()
625:     {
626:         return Environment::getHttpRequest();
627:     }
628: 
629: 
630: 
631:     /**
632:      * @return Session
633:      */
634:     protected function getSession()
635:     {
636:         return Environment::getSession();
637:     }
638: 
639: }
640: 
Nette Framework 2.0.8 (for PHP 5.2, un-prefixed) API API documentation generated by ApiGen 2.8.0