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
  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 array of 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 = '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 array of 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:      * @param  ITranslator
316:      * @return Form  provides a fluent interface
317:      */
318:     public function setTranslator(ITranslator $translator = NULL)
319:     {
320:         $this->translator = $translator;
321:         return $this;
322:     }
323: 
324: 
325: 
326:     /**
327:      * Returns translate adapter.
328:      * @return ITranslator|NULL
329:      */
330:     final public function getTranslator()
331:     {
332:         return $this->translator;
333:     }
334: 
335: 
336: 
337:     /********************* submission ****************d*g**/
338: 
339: 
340: 
341:     /**
342:      * Tells if the form is anchored.
343:      * @return bool
344:      */
345:     public function isAnchored()
346:     {
347:         return TRUE;
348:     }
349: 
350: 
351: 
352:     /**
353:      * Tells if the form was submitted.
354:      * @return ISubmitterControl|FALSE  submittor control
355:      */
356:     final public function isSubmitted()
357:     {
358:         if ($this->submittedBy === NULL && count($this->getControls())) {
359:             $this->getHttpData();
360:             $this->submittedBy = $this->httpData !== NULL;
361:         }
362:         return $this->submittedBy;
363:     }
364: 
365: 
366: 
367:     /**
368:      * Tells if the form was submitted and successfully validated.
369:      * @return bool
370:      */
371:     final public function isSuccess()
372:     {
373:         return $this->isSubmitted() && $this->isValid();
374:     }
375: 
376: 
377: 
378:     /**
379:      * Sets the submittor control.
380:      * @param  ISubmitterControl
381:      * @return Form  provides a fluent interface
382:      */
383:     public function setSubmittedBy(ISubmitterControl $by = NULL)
384:     {
385:         $this->submittedBy = $by === NULL ? FALSE : $by;
386:         return $this;
387:     }
388: 
389: 
390: 
391:     /**
392:      * Returns submitted HTTP data.
393:      * @return array
394:      */
395:     final public function getHttpData()
396:     {
397:         if ($this->httpData === NULL) {
398:             if (!$this->isAnchored()) {
399:                 throw new InvalidStateException('Form is not anchored and therefore can not determine whether it was submitted.');
400:             }
401:             $this->httpData = $this->receiveHttpData();
402:         }
403:         return $this->httpData;
404:     }
405: 
406: 
407: 
408:     /**
409:      * Fires submit/click events.
410:      * @return void
411:      */
412:     public function fireEvents()
413:     {
414:         if (!$this->isSubmitted()) {
415:             return;
416: 
417:         } elseif ($this->submittedBy instanceof ISubmitterControl) {
418:             if (!$this->submittedBy->getValidationScope() || $this->isValid()) {
419:                 $this->submittedBy->click();
420:                 $valid = TRUE;
421:             } else {
422:                 $this->submittedBy->onInvalidClick($this->submittedBy);
423:             }
424:         }
425: 
426:         if (isset($valid) || $this->isValid()) {
427:             $this->onSuccess($this);
428:         } else {
429:             $this->onError($this);
430:             if ($this->onInvalidSubmit) {
431:                 trigger_error(__CLASS__ . '->onInvalidSubmit is deprecated; use onError instead.', E_USER_WARNING);
432:                 $this->onInvalidSubmit($this);
433:             }
434:         }
435: 
436:         if ($this->onSuccess) { // back compatibility
437:             $this->onSubmit($this);
438:         } elseif ($this->onSubmit) {
439:             trigger_error(__CLASS__ . '->onSubmit changed its behavior; use onSuccess instead.', E_USER_WARNING);
440:             if (isset($valid) || $this->isValid()) {
441:                 $this->onSubmit($this);
442:             }
443:         }
444:     }
445: 
446: 
447: 
448:     /**
449:      * Internal: receives submitted HTTP data.
450:      * @return array
451:      */
452:     protected function receiveHttpData()
453:     {
454:         $httpRequest = $this->getHttpRequest();
455:         if (strcasecmp($this->getMethod(), $httpRequest->getMethod())) {
456:             return;
457:         }
458: 
459:         if ($httpRequest->isMethod('post')) {
460:             $data = Arrays::mergeTree($httpRequest->getPost(), $httpRequest->getFiles());
461:         } else {
462:             $data = $httpRequest->getQuery();
463:         }
464: 
465:         if ($tracker = $this->getComponent(self::TRACKER_ID, FALSE)) {
466:             if (!isset($data[self::TRACKER_ID]) || $data[self::TRACKER_ID] !== $tracker->getValue()) {
467:                 return;
468:             }
469:         }
470: 
471:         return $data;
472:     }
473: 
474: 
475: 
476:     /********************* data exchange ****************d*g**/
477: 
478: 
479: 
480:     /**
481:      * Returns the values submitted by the form.
482:      * @return array
483:      */
484:     public function getValues($asArray = FALSE)
485:     {
486:         $values = parent::getValues($asArray);
487:         unset($values[self::TRACKER_ID], $values[self::PROTECTOR_ID]);
488:         return $values;
489:     }
490: 
491: 
492: 
493:     /********************* validation ****************d*g**/
494: 
495: 
496: 
497:     /**
498:      * Adds error message to the list.
499:      * @param  string  error message
500:      * @return void
501:      */
502:     public function addError($message)
503:     {
504:         $this->valid = FALSE;
505:         if ($message !== NULL && !in_array($message, $this->errors, TRUE)) {
506:             $this->errors[] = $message;
507:         }
508:     }
509: 
510: 
511: 
512:     /**
513:      * Returns validation errors.
514:      * @return array
515:      */
516:     public function getErrors()
517:     {
518:         return $this->errors;
519:     }
520: 
521: 
522: 
523:     /**
524:      * @return bool
525:      */
526:     public function hasErrors()
527:     {
528:         return (bool) $this->getErrors();
529:     }
530: 
531: 
532: 
533:     /**
534:      * @return void
535:      */
536:     public function cleanErrors()
537:     {
538:         $this->errors = array();
539:         $this->valid = NULL;
540:     }
541: 
542: 
543: 
544:     /********************* rendering ****************d*g**/
545: 
546: 
547: 
548:     /**
549:      * Returns form's HTML element template.
550:      * @return Html
551:      */
552:     public function getElementPrototype()
553:     {
554:         return $this->element;
555:     }
556: 
557: 
558: 
559:     /**
560:      * Sets form renderer.
561:      * @param  IFormRenderer
562:      * @return Form  provides a fluent interface
563:      */
564:     public function setRenderer(IFormRenderer $renderer)
565:     {
566:         $this->renderer = $renderer;
567:         return $this;
568:     }
569: 
570: 
571: 
572:     /**
573:      * Returns form renderer.
574:      * @return IFormRenderer
575:      */
576:     final public function getRenderer()
577:     {
578:         if ($this->renderer === NULL) {
579:             $this->renderer = new DefaultFormRenderer;
580:         }
581:         return $this->renderer;
582:     }
583: 
584: 
585: 
586:     /**
587:      * Renders form.
588:      * @return void
589:      */
590:     public function render()
591:     {
592:         $args = func_get_args();
593:         array_unshift($args, $this);
594:         echo call_user_func_array(array($this->getRenderer(), 'render'), $args);
595:     }
596: 
597: 
598: 
599:     /**
600:      * Renders form to string.
601:      * @return bool  can throw exceptions? (hidden parameter)
602:      * @return string
603:      */
604:     public function __toString()
605:     {
606:         try {
607:             return $this->getRenderer()->render($this);
608: 
609:         } catch (Exception $e) {
610:             if (func_get_args() && func_get_arg(0)) {
611:                 throw $e;
612:             } else {
613:                 Debugger::toStringException($e);
614:             }
615:         }
616:     }
617: 
618: 
619: 
620:     /********************* backend ****************d*g**/
621: 
622: 
623: 
624:     /**
625:      * @return IHttpRequest
626:      */
627:     protected function getHttpRequest()
628:     {
629:         return Environment::getHttpRequest();
630:     }
631: 
632: 
633: 
634:     /**
635:      * @return Session
636:      */
637:     protected function getSession()
638:     {
639:         return Environment::getSession();
640:     }
641: 
642: }
643: 
Nette Framework 2.0.0 (for PHP 5.2, un-prefixed) API API documentation generated by ApiGen 2.7.0