Namespaces

  • 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

  • BaseControl
  • Button
  • Checkbox
  • HiddenField
  • ImageButton
  • MultiSelectBox
  • RadioList
  • SelectBox
  • SubmitButton
  • TextArea
  • TextBase
  • TextInput
  • UploadControl
  • Overview
  • Namespace
  • 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:  */
 11: 
 12: namespace Nette\Forms\Controls;
 13: 
 14: use Nette,
 15:     Nette\Forms\IControl,
 16:     Nette\Utils\Html,
 17:     Nette\Forms\Form,
 18:     Nette\Forms\Rule;
 19: 
 20: 
 21: 
 22: /**
 23:  * Base class that implements the basic functionality common to form controls.
 24:  *
 25:  * @author     David Grudl
 26:  *
 27:  * @property-read Nette\Forms\Form $form
 28:  * @property-read string $htmlName
 29:  * @property   string $htmlId
 30:  * @property-read array $options
 31:  * @property   Nette\Localization\ITranslator|NULL $translator
 32:  * @property   mixed $value
 33:  * @property-read bool $filled
 34:  * @property-write $defaultValue
 35:  * @property   bool $disabled
 36:  * @property-read Nette\Utils\Html $control
 37:  * @property-read Nette\Utils\Html $label
 38:  * @property-read Nette\Utils\Html $controlPrototype
 39:  * @property-read Nette\Utils\Html $labelPrototype
 40:  * @property-read Nette\Forms\Rules $rules
 41:  * @property   bool $required
 42:  * @property-read array $errors
 43:  */
 44: abstract class BaseControl extends Nette\ComponentModel\Component implements IControl
 45: {
 46:     /** @var string */
 47:     public static $idMask = 'frm%s-%s';
 48: 
 49:     /** @var string textual caption or label */
 50:     public $caption;
 51: 
 52:     /** @var mixed unfiltered control value */
 53:     protected $value;
 54: 
 55:     /** @var Nette\Utils\Html  control element template */
 56:     protected $control;
 57: 
 58:     /** @var Nette\Utils\Html  label element template */
 59:     protected $label;
 60: 
 61:     /** @var array */
 62:     private $errors = array();
 63: 
 64:     /** @var bool */
 65:     private $disabled = FALSE;
 66: 
 67:     /** @var string */
 68:     private $htmlId;
 69: 
 70:     /** @var string */
 71:     private $htmlName;
 72: 
 73:     /** @var Nette\Forms\Rules */
 74:     private $rules;
 75: 
 76:     /** @var Nette\Localization\ITranslator */
 77:     private $translator = TRUE; // means autodetect
 78: 
 79:     /** @var array user options */
 80:     private $options = array();
 81: 
 82: 
 83: 
 84:     /**
 85:      * @param  string  caption
 86:      */
 87:     public function __construct($caption = NULL)
 88:     {
 89:         $this->monitor('Nette\Forms\Form');
 90:         parent::__construct();
 91:         $this->control = Html::el('input');
 92:         $this->label = Html::el('label');
 93:         $this->caption = $caption;
 94:         $this->rules = new Nette\Forms\Rules($this);
 95:     }
 96: 
 97: 
 98: 
 99:     /**
100:      * This method will be called when the component becomes attached to Form.
101:      * @param  Nette\ComponentModel\IComponent
102:      * @return void
103:      */
104:     protected function attached($form)
105:     {
106:         if (!$this->disabled && $form instanceof Form && $form->isAnchored() && $form->isSubmitted()) {
107:             $this->htmlName = NULL;
108:             $this->loadHttpData();
109:         }
110:     }
111: 
112: 
113: 
114:     /**
115:      * Returns form.
116:      * @param  bool   throw exception if form doesn't exist?
117:      * @return Nette\Forms\Form
118:      */
119:     public function getForm($need = TRUE)
120:     {
121:         return $this->lookup('Nette\Forms\Form', $need);
122:     }
123: 
124: 
125: 
126:     /**
127:      * Returns HTML name of control.
128:      * @return string
129:      */
130:     public function getHtmlName()
131:     {
132:         if ($this->htmlName === NULL) {
133:             $name = str_replace(self::NAME_SEPARATOR, '][', $this->lookupPath('Nette\Forms\Form'), $count);
134:             if ($count) {
135:                 $name = substr_replace($name, '', strpos($name, ']'), 1) . ']';
136:             }
137:             if (is_numeric($name) || in_array($name, array('attributes','children','elements','focus','length','reset','style','submit','onsubmit'))) {
138:                 $name .= '_';
139:             }
140:             $this->htmlName = $name;
141:         }
142:         return $this->htmlName;
143:     }
144: 
145: 
146: 
147:     /**
148:      * Changes control's HTML id.
149:      * @param  string new ID, or FALSE or NULL
150:      * @return BaseControl  provides a fluent interface
151:      */
152:     public function setHtmlId($id)
153:     {
154:         $this->htmlId = $id;
155:         return $this;
156:     }
157: 
158: 
159: 
160:     /**
161:      * Returns control's HTML id.
162:      * @return string
163:      */
164:     public function getHtmlId()
165:     {
166:         if ($this->htmlId === FALSE) {
167:             return NULL;
168: 
169:         } elseif ($this->htmlId === NULL) {
170:             $this->htmlId = sprintf(self::$idMask, $this->getForm()->getName(), $this->lookupPath('Nette\Forms\Form'));
171:         }
172:         return $this->htmlId;
173:     }
174: 
175: 
176: 
177:     /**
178:      * Changes control's HTML attribute.
179:      * @param  string name
180:      * @param  mixed  value
181:      * @return BaseControl  provides a fluent interface
182:      */
183:     public function setAttribute($name, $value = TRUE)
184:     {
185:         $this->control->$name = $value;
186:         return $this;
187:     }
188: 
189: 
190: 
191:     /**
192:      * Sets user-specific option.
193:      * Options recognized by DefaultFormRenderer
194:      * - 'description' - textual or Html object description
195:      *
196:      * @param  string key
197:      * @param  mixed  value
198:      * @return BaseControl  provides a fluent interface
199:      */
200:     public function setOption($key, $value)
201:     {
202:         if ($value === NULL) {
203:             unset($this->options[$key]);
204: 
205:         } else {
206:             $this->options[$key] = $value;
207:         }
208:         return $this;
209:     }
210: 
211: 
212: 
213:     /**
214:      * Returns user-specific option.
215:      * @param  string key
216:      * @param  mixed  default value
217:      * @return mixed
218:      */
219:     final public function getOption($key, $default = NULL)
220:     {
221:         return isset($this->options[$key]) ? $this->options[$key] : $default;
222:     }
223: 
224: 
225: 
226:     /**
227:      * Returns user-specific options.
228:      * @return array
229:      */
230:     final public function getOptions()
231:     {
232:         return $this->options;
233:     }
234: 
235: 
236: 
237:     /********************* translator ****************d*g**/
238: 
239: 
240: 
241:     /**
242:      * Sets translate adapter.
243:      * @return BaseControl  provides a fluent interface
244:      */
245:     public function setTranslator(Nette\Localization\ITranslator $translator = NULL)
246:     {
247:         $this->translator = $translator;
248:         return $this;
249:     }
250: 
251: 
252: 
253:     /**
254:      * Returns translate adapter.
255:      * @return Nette\Localization\ITranslator|NULL
256:      */
257:     final public function getTranslator()
258:     {
259:         if ($this->translator === TRUE) {
260:             return $this->getForm(FALSE) ? $this->getForm()->getTranslator() : NULL;
261:         }
262:         return $this->translator;
263:     }
264: 
265: 
266: 
267:     /**
268:      * Returns translated string.
269:      * @param  string
270:      * @param  int      plural count
271:      * @return string
272:      */
273:     public function translate($s, $count = NULL)
274:     {
275:         $translator = $this->getTranslator();
276:         return $translator === NULL || $s == NULL ? $s : $translator->translate($s, $count); // intentionally ==
277:     }
278: 
279: 
280: 
281:     /********************* interface IFormControl ****************d*g**/
282: 
283: 
284: 
285:     /**
286:      * Sets control's value.
287:      * @return BaseControl  provides a fluent interface
288:      */
289:     public function setValue($value)
290:     {
291:         $this->value = $value;
292:         return $this;
293:     }
294: 
295: 
296: 
297:     /**
298:      * Returns control's value.
299:      * @return mixed
300:      */
301:     public function getValue()
302:     {
303:         return $this->value;
304:     }
305: 
306: 
307: 
308:     /**
309:      * Is control filled?
310:      * @return bool
311:      */
312:     public function isFilled()
313:     {
314:         return (string) $this->getValue() !== ''; // NULL, FALSE, '' ==> FALSE
315:     }
316: 
317: 
318: 
319:     /**
320:      * Sets control's default value.
321:      * @return BaseControl  provides a fluent interface
322:      */
323:     public function setDefaultValue($value)
324:     {
325:         $form = $this->getForm(FALSE);
326:         if (!$form || !$form->isAnchored() || !$form->isSubmitted()) {
327:             $this->setValue($value);
328:         }
329:         return $this;
330:     }
331: 
332: 
333: 
334:     /**
335:      * Loads HTTP data.
336:      * @return void
337:      */
338:     public function loadHttpData()
339:     {
340:         $path = explode('[', strtr(str_replace(array('[]', ']'), '', $this->getHtmlName()), '.', '_'));
341:         $this->setValue(Nette\Utils\Arrays::get($this->getForm()->getHttpData(), $path, NULL));
342:     }
343: 
344: 
345: 
346:     /**
347:      * Disables or enables control.
348:      * @param  bool
349:      * @return BaseControl  provides a fluent interface
350:      */
351:     public function setDisabled($value = TRUE)
352:     {
353:         $this->disabled = (bool) $value;
354:         return $this;
355:     }
356: 
357: 
358: 
359:     /**
360:      * Is control disabled?
361:      * @return bool
362:      */
363:     public function isDisabled()
364:     {
365:         return $this->disabled;
366:     }
367: 
368: 
369: 
370:     /********************* rendering ****************d*g**/
371: 
372: 
373: 
374:     /**
375:      * Generates control's HTML element.
376:      * @return Nette\Utils\Html
377:      */
378:     public function getControl()
379:     {
380:         $this->setOption('rendered', TRUE);
381: 
382:         $control = clone $this->control;
383:         $control->name = $this->getHtmlName();
384:         $control->disabled = $this->disabled;
385:         $control->id = $this->getHtmlId();
386:         $control->required = $this->isRequired();
387: 
388:         $rules = self::exportRules($this->rules);
389:         $rules = substr(PHP_VERSION_ID >= 50400 ? json_encode($rules, JSON_UNESCAPED_UNICODE) : json_encode($rules), 1, -1);
390:         $rules = preg_replace('#"([a-z0-9_]+)":#i', '$1:', $rules);
391:         $rules = preg_replace('#(?<!\\\\)"(?!:[^a-z])([^\\\\\',]*)"#i', "'$1'", $rules);
392:         $control->data('nette-rules', $rules ? $rules : NULL);
393: 
394:         return $control;
395:     }
396: 
397: 
398: 
399:     /**
400:      * Generates label's HTML element.
401:      * @param  string
402:      * @return Nette\Utils\Html
403:      */
404:     public function getLabel($caption = NULL)
405:     {
406:         $label = clone $this->label;
407:         $label->for = $this->getHtmlId();
408:         if ($caption !== NULL) {
409:             $label->setText($this->translate($caption));
410: 
411:         } elseif ($this->caption instanceof Html) {
412:             $label->add($this->caption);
413: 
414:         } else {
415:             $label->setText($this->translate($this->caption));
416:         }
417:         return $label;
418:     }
419: 
420: 
421: 
422:     /**
423:      * Returns control's HTML element template.
424:      * @return Nette\Utils\Html
425:      */
426:     final public function getControlPrototype()
427:     {
428:         return $this->control;
429:     }
430: 
431: 
432: 
433:     /**
434:      * Returns label's HTML element template.
435:      * @return Nette\Utils\Html
436:      */
437:     final public function getLabelPrototype()
438:     {
439:         return $this->label;
440:     }
441: 
442: 
443: 
444:     /********************* rules ****************d*g**/
445: 
446: 
447: 
448:     /**
449:      * Adds a validation rule.
450:      * @param  mixed      rule type
451:      * @param  string     message to display for invalid data
452:      * @param  mixed      optional rule arguments
453:      * @return BaseControl  provides a fluent interface
454:      */
455:     public function addRule($operation, $message = NULL, $arg = NULL)
456:     {
457:         $this->rules->addRule($operation, $message, $arg);
458:         return $this;
459:     }
460: 
461: 
462: 
463:     /**
464:      * Adds a validation condition a returns new branch.
465:      * @param  mixed     condition type
466:      * @param  mixed     optional condition arguments
467:      * @return Nette\Forms\Rules      new branch
468:      */
469:     public function addCondition($operation, $value = NULL)
470:     {
471:         return $this->rules->addCondition($operation, $value);
472:     }
473: 
474: 
475: 
476:     /**
477:      * Adds a validation condition based on another control a returns new branch.
478:      * @param  Nette\Forms\IControl form control
479:      * @param  mixed      condition type
480:      * @param  mixed      optional condition arguments
481:      * @return Nette\Forms\Rules      new branch
482:      */
483:     public function addConditionOn(IControl $control, $operation, $value = NULL)
484:     {
485:         return $this->rules->addConditionOn($control, $operation, $value);
486:     }
487: 
488: 
489: 
490:     /**
491:      * @return Nette\Forms\Rules
492:      */
493:     final public function getRules()
494:     {
495:         return $this->rules;
496:     }
497: 
498: 
499: 
500:     /**
501:      * Makes control mandatory.
502:      * @param  string  error message
503:      * @return BaseControl  provides a fluent interface
504:      */
505:     final public function setRequired($message = NULL)
506:     {
507:         return $this->addRule(Form::FILLED, $message);
508:     }
509: 
510: 
511: 
512:     /**
513:      * Is control mandatory?
514:      * @return bool
515:      */
516:     final public function isRequired()
517:     {
518:         foreach ($this->rules as $rule) {
519:             if ($rule->type === Rule::VALIDATOR && !$rule->isNegative && $rule->operation === Form::FILLED) {
520:                 return TRUE;
521:             }
522:         }
523:         return FALSE;
524:     }
525: 
526: 
527: 
528:     /**
529:      * @return array
530:      */
531:     protected static function exportRules($rules)
532:     {
533:         $payload = array();
534:         foreach ($rules as $rule) {
535:             if (!is_string($op = $rule->operation)) {
536:                 $op = new Nette\Callback($op);
537:                 if (!$op->isStatic()) {
538:                     continue;
539:                 }
540:             }
541:             if ($rule->type === Rule::VALIDATOR) {
542:                 $item = array('op' => ($rule->isNegative ? '~' : '') . $op, 'msg' => $rules->formatMessage($rule, FALSE));
543: 
544:             } elseif ($rule->type === Rule::CONDITION) {
545:                 $item = array(
546:                     'op' => ($rule->isNegative ? '~' : '') . $op,
547:                     'rules' => self::exportRules($rule->subRules),
548:                     'control' => $rule->control->getHtmlName()
549:                 );
550:                 if ($rule->subRules->getToggles()) {
551:                     $item['toggle'] = $rule->subRules->getToggles();
552:                 }
553:             }
554: 
555:             if (is_array($rule->arg)) {
556:                 foreach ($rule->arg as $key => $value) {
557:                     $item['arg'][$key] = $value instanceof IControl ? (object) array('control' => $value->getHtmlName()) : $value;
558:                 }
559:             } elseif ($rule->arg !== NULL) {
560:                 $item['arg'] = $rule->arg instanceof IControl ? (object) array('control' => $rule->arg->getHtmlName()) : $rule->arg;
561:             }
562: 
563:             $payload[] = $item;
564:         }
565:         return $payload;
566:     }
567: 
568: 
569: 
570:     /********************* validation ****************d*g**/
571: 
572: 
573: 
574:     /**
575:      * Equal validator: are control's value and second parameter equal?
576:      * @return bool
577:      */
578:     public static function validateEqual(IControl $control, $arg)
579:     {
580:         $value = $control->getValue();
581:         foreach ((is_array($value) ? $value : array($value)) as $val) {
582:             foreach ((is_array($arg) ? $arg : array($arg)) as $item) {
583:                 if ((string) $val === (string) ($item instanceof IControl ? $item->value : $item)) {
584:                     return TRUE;
585:                 }
586:             }
587:         }
588:         return FALSE;
589:     }
590: 
591: 
592: 
593:     /**
594:      * Filled validator: is control filled?
595:      * @return bool
596:      */
597:     public static function validateFilled(IControl $control)
598:     {
599:         return $control->isFilled();
600:     }
601: 
602: 
603: 
604:     /**
605:      * Valid validator: is control valid?
606:      * @return bool
607:      */
608:     public static function validateValid(IControl $control)
609:     {
610:         return $control->rules->validate(TRUE);
611:     }
612: 
613: 
614: 
615:     /**
616:      * Adds error message to the list.
617:      * @param  string  error message
618:      * @return void
619:      */
620:     public function addError($message)
621:     {
622:         if (!in_array($message, $this->errors, TRUE)) {
623:             $this->errors[] = $message;
624:         }
625:         $this->getForm()->addError($message);
626:     }
627: 
628: 
629: 
630:     /**
631:      * Returns errors corresponding to control.
632:      * @return array
633:      */
634:     public function getErrors()
635:     {
636:         return $this->errors;
637:     }
638: 
639: 
640: 
641:     /**
642:      * @return bool
643:      */
644:     public function hasErrors()
645:     {
646:         return (bool) $this->errors;
647:     }
648: 
649: 
650: 
651:     /**
652:      * @return void
653:      */
654:     public function cleanErrors()
655:     {
656:         $this->errors = array();
657:     }
658: 
659: }
660: 
Nette Framework 2.0.10 API API documentation generated by ApiGen 2.8.0