Namespaces

  • Latte
    • Loaders
    • Macros
    • Runtime
  • Nette
    • Application
      • Responses
      • Routers
      • UI
    • Bridges
      • ApplicationDI
      • ApplicationLatte
      • ApplicationTracy
      • CacheDI
      • CacheLatte
      • DatabaseDI
      • DatabaseTracy
      • DITracy
      • FormsDI
      • FormsLatte
      • Framework
      • HttpDI
      • HttpTracy
      • MailDI
      • ReflectionDI
      • SecurityDI
      • SecurityTracy
    • Caching
      • Storages
    • ComponentModel
    • Database
      • Conventions
      • Drivers
      • Table
    • DI
      • Config
        • Adapters
      • Extensions
    • Forms
      • Controls
      • Rendering
    • Http
    • Iterators
    • Loaders
    • Localization
    • Mail
    • Neon
    • PhpGenerator
    • Reflection
    • Security
    • Utils
  • none
  • Tracy
    • Bridges
      • Nette

Classes

  • BaseControl
  • Button
  • Checkbox
  • CheckboxList
  • ChoiceControl
  • CsrfProtection
  • HiddenField
  • ImageButton
  • MultiChoiceControl
  • 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 (https://nette.org)
  5:  * Copyright (c) 2004 David Grudl (https://davidgrudl.com)
  6:  */
  7: 
  8: namespace Nette\Forms\Controls;
  9: 
 10: use Nette;
 11: use Nette\Forms\Form;
 12: use Nette\Forms\IControl;
 13: use Nette\Forms\Rules;
 14: use Nette\Utils\Html;
 15: 
 16: 
 17: /**
 18:  * Base class that implements the basic functionality common to form controls.
 19:  *
 20:  * @property-read Form $form
 21:  * @property-read string $htmlName
 22:  * @property   string $htmlId
 23:  * @property   mixed $value
 24:  * @property   bool $disabled
 25:  * @property   bool $omitted
 26:  * @property-read Html $control
 27:  * @property-read Html $label
 28:  * @property-read Html $controlPrototype
 29:  * @property-read Html $labelPrototype
 30:  * @property   bool $required
 31:  * @property-read bool $filled
 32:  * @property-read array $errors
 33:  * @property-read array $options
 34:  * @property-read string $error
 35:  */
 36: abstract class BaseControl extends Nette\ComponentModel\Component implements IControl
 37: {
 38:     /** @var string */
 39:     public static $idMask = 'frm-%s';
 40: 
 41:     /** @var string textual caption or label */
 42:     public $caption;
 43: 
 44:     /** @var mixed current control value */
 45:     protected $value;
 46: 
 47:     /** @var Html  control element template */
 48:     protected $control;
 49: 
 50:     /** @var Html  label element template */
 51:     protected $label;
 52: 
 53:     /** @var array */
 54:     private $errors = [];
 55: 
 56:     /** @var bool */
 57:     protected $disabled = FALSE;
 58: 
 59:     /** @var bool|NULL */
 60:     private $omitted;
 61: 
 62:     /** @var Rules */
 63:     private $rules;
 64: 
 65:     /** @var Nette\Localization\ITranslator */
 66:     private $translator = TRUE; // means autodetect
 67: 
 68:     /** @var array user options */
 69:     private $options = [];
 70: 
 71:     /** @var bool */
 72:     private static $autoOptional = FALSE;
 73: 
 74: 
 75:     /**
 76:      * @param  string  caption
 77:      */
 78:     public function __construct($caption = NULL)
 79:     {
 80:         $this->monitor(Form::class);
 81:         parent::__construct();
 82:         $this->control = Html::el('input', ['type' => NULL, 'name' => NULL]);
 83:         $this->label = Html::el('label');
 84:         $this->caption = $caption;
 85:         $this->rules = new Rules($this);
 86:         if (self::$autoOptional) {
 87:             $this->setRequired(FALSE);
 88:         }
 89:         $this->setValue(NULL);
 90:     }
 91: 
 92: 
 93:     /**
 94:      * This method will be called when the component becomes attached to Form.
 95:      * @param  Nette\ComponentModel\IComponent
 96:      * @return void
 97:      */
 98:     protected function attached($form)
 99:     {
100:         if (!$this->isDisabled() && $form instanceof Form && $form->isAnchored() && $form->isSubmitted()) {
101:             $this->loadHttpData();
102:         }
103:     }
104: 
105: 
106:     /**
107:      * Returns form.
108:      * @param  bool   throw exception if form doesn't exist?
109:      * @return Form
110:      */
111:     public function getForm($need = TRUE)
112:     {
113:         return $this->lookup(Form::class, $need);
114:     }
115: 
116: 
117:     /**
118:      * Loads HTTP data.
119:      * @return void
120:      */
121:     public function loadHttpData()
122:     {
123:         $this->setValue($this->getHttpData(Form::DATA_TEXT));
124:     }
125: 
126: 
127:     /**
128:      * Loads HTTP data.
129:      * @return mixed
130:      */
131:     protected function getHttpData($type, $htmlTail = NULL)
132:     {
133:         return $this->getForm()->getHttpData($type, $this->getHtmlName() . $htmlTail);
134:     }
135: 
136: 
137:     /**
138:      * Returns HTML name of control.
139:      * @return string
140:      */
141:     public function getHtmlName()
142:     {
143:         return Nette\Forms\Helpers::generateHtmlName($this->lookupPath(Form::class));
144:     }
145: 
146: 
147:     /********************* interface IControl ****************d*g**/
148: 
149: 
150:     /**
151:      * Sets control's value.
152:      * @return self
153:      * @internal
154:      */
155:     public function setValue($value)
156:     {
157:         $this->value = $value;
158:         return $this;
159:     }
160: 
161: 
162:     /**
163:      * Returns control's value.
164:      * @return mixed
165:      */
166:     public function getValue()
167:     {
168:         return $this->value;
169:     }
170: 
171: 
172:     /**
173:      * Is control filled?
174:      * @return bool
175:      */
176:     public function isFilled()
177:     {
178:         $value = $this->getValue();
179:         return $value !== NULL && $value !== [] && $value !== '';
180:     }
181: 
182: 
183:     /**
184:      * Sets control's default value.
185:      * @return self
186:      */
187:     public function setDefaultValue($value)
188:     {
189:         $form = $this->getForm(FALSE);
190:         if ($this->isDisabled() || !$form || !$form->isAnchored() || !$form->isSubmitted()) {
191:             $this->setValue($value);
192:         }
193:         return $this;
194:     }
195: 
196: 
197:     /**
198:      * Disables or enables control.
199:      * @param  bool
200:      * @return self
201:      */
202:     public function setDisabled($value = TRUE)
203:     {
204:         if ($this->disabled = (bool) $value) {
205:             $this->setValue(NULL);
206:         }
207:         return $this;
208:     }
209: 
210: 
211:     /**
212:      * Is control disabled?
213:      * @return bool
214:      */
215:     public function isDisabled()
216:     {
217:         return $this->disabled === TRUE;
218:     }
219: 
220: 
221:     /**
222:      * Sets whether control value is excluded from $form->getValues() result.
223:      * @param  bool
224:      * @return self
225:      */
226:     public function setOmitted($value = TRUE)
227:     {
228:         $this->omitted = (bool) $value;
229:         return $this;
230:     }
231: 
232: 
233:     /**
234:      * Is control value excluded from $form->getValues() result?
235:      * @return bool
236:      */
237:     public function isOmitted()
238:     {
239:         return $this->omitted || ($this->isDisabled() && $this->omitted === NULL);
240:     }
241: 
242: 
243:     /********************* rendering ****************d*g**/
244: 
245: 
246:     /**
247:      * Generates control's HTML element.
248:      * @return Html|string
249:      */
250:     public function getControl()
251:     {
252:         $this->setOption('rendered', TRUE);
253:         $el = clone $this->control;
254:         return $el->addAttributes([
255:             'name' => $this->getHtmlName(),
256:             'id' => $this->getHtmlId(),
257:             'required' => $this->isRequired(),
258:             'disabled' => $this->isDisabled(),
259:             'data-nette-rules' => Nette\Forms\Helpers::exportRules($this->rules) ?: NULL,
260:         ]);
261:     }
262: 
263: 
264:     /**
265:      * Generates label's HTML element.
266:      * @param  string
267:      * @return Html|string
268:      */
269:     public function getLabel($caption = NULL)
270:     {
271:         $label = clone $this->label;
272:         $label->for = $this->getHtmlId();
273:         $label->setText($this->translate($caption === NULL ? $this->caption : $caption));
274:         return $label;
275:     }
276: 
277: 
278:     /**
279:      * @return Nette\Utils\Html|NULL
280:      */
281:     public function getControlPart()
282:     {
283:         return $this->getControl();
284:     }
285: 
286: 
287:     /**
288:      * @return Nette\Utils\Html|NULL
289:      */
290:     public function getLabelPart()
291:     {
292:         return $this->getLabel();
293:     }
294: 
295: 
296:     /**
297:      * Returns control's HTML element template.
298:      * @return Html
299:      */
300:     public function getControlPrototype()
301:     {
302:         return $this->control;
303:     }
304: 
305: 
306:     /**
307:      * Returns label's HTML element template.
308:      * @return Html
309:      */
310:     public function getLabelPrototype()
311:     {
312:         return $this->label;
313:     }
314: 
315: 
316:     /**
317:      * Changes control's HTML id.
318:      * @param  string new ID, or FALSE or NULL
319:      * @return self
320:      */
321:     public function setHtmlId($id)
322:     {
323:         $this->control->id = $id;
324:         return $this;
325:     }
326: 
327: 
328:     /**
329:      * Returns control's HTML id.
330:      * @return string
331:      */
332:     public function getHtmlId()
333:     {
334:         if (!isset($this->control->id)) {
335:             $this->control->id = sprintf(self::$idMask, $this->lookupPath());
336:         }
337:         return $this->control->id;
338:     }
339: 
340: 
341:     /**
342:      * Changes control's HTML attribute.
343:      * @param  string name
344:      * @param  mixed  value
345:      * @return self
346:      */
347:     public function setAttribute($name, $value = TRUE)
348:     {
349:         $this->control->$name = $value;
350:         return $this;
351:     }
352: 
353: 
354:     /********************* translator ****************d*g**/
355: 
356: 
357:     /**
358:      * Sets translate adapter.
359:      * @return self
360:      */
361:     public function setTranslator(Nette\Localization\ITranslator $translator = NULL)
362:     {
363:         $this->translator = $translator;
364:         return $this;
365:     }
366: 
367: 
368:     /**
369:      * Returns translate adapter.
370:      * @return Nette\Localization\ITranslator|NULL
371:      */
372:     public function getTranslator()
373:     {
374:         if ($this->translator === TRUE) {
375:             return $this->getForm(FALSE) ? $this->getForm()->getTranslator() : NULL;
376:         }
377:         return $this->translator;
378:     }
379: 
380: 
381:     /**
382:      * Returns translated string.
383:      * @param  mixed
384:      * @param  int      plural count
385:      * @return string
386:      */
387:     public function translate($value, $count = NULL)
388:     {
389:         if ($translator = $this->getTranslator()) {
390:             $tmp = is_array($value) ? [& $value] : [[& $value]];
391:             foreach ($tmp[0] as & $v) {
392:                 if ($v != NULL && !$v instanceof Html) { // intentionally ==
393:                     $v = $translator->translate($v, $count);
394:                 }
395:             }
396:         }
397:         return $value;
398:     }
399: 
400: 
401:     /********************* rules ****************d*g**/
402: 
403: 
404:     /**
405:      * Adds a validation rule.
406:      * @param  mixed      rule type
407:      * @param  string     message to display for invalid data
408:      * @param  mixed      optional rule arguments
409:      * @return self
410:      */
411:     public function addRule($validator, $message = NULL, $arg = NULL)
412:     {
413:         $this->rules->addRule($validator, $message, $arg);
414:         return $this;
415:     }
416: 
417: 
418:     /**
419:      * Adds a validation condition a returns new branch.
420:      * @param  mixed     condition type
421:      * @param  mixed     optional condition arguments
422:      * @return Rules      new branch
423:      */
424:     public function addCondition($validator, $value = NULL)
425:     {
426:         return $this->rules->addCondition($validator, $value);
427:     }
428: 
429: 
430:     /**
431:      * Adds a validation condition based on another control a returns new branch.
432:      * @param  IControl form control
433:      * @param  mixed      condition type
434:      * @param  mixed      optional condition arguments
435:      * @return Rules      new branch
436:      */
437:     public function addConditionOn(IControl $control, $validator, $value = NULL)
438:     {
439:         return $this->rules->addConditionOn($control, $validator, $value);
440:     }
441: 
442: 
443:     /**
444:      * @return Rules
445:      */
446:     public function getRules()
447:     {
448:         return $this->rules;
449:     }
450: 
451: 
452:     /**
453:      * Makes control mandatory.
454:      * @param  mixed  state or error message
455:      * @return self
456:      */
457:     public function setRequired($value = TRUE)
458:     {
459:         $this->rules->setRequired($value);
460:         return $this;
461:     }
462: 
463: 
464:     /**
465:      * Is control mandatory?
466:      * @return bool
467:      */
468:     public function isRequired()
469:     {
470:         return $this->rules->isRequired();
471:     }
472: 
473: 
474:     /**
475:      * Performs the server side validation.
476:      * @return void
477:      */
478:     public function validate()
479:     {
480:         if ($this->isDisabled()) {
481:             return;
482:         }
483:         $this->cleanErrors();
484:         $this->rules->validate();
485:     }
486: 
487: 
488:     /**
489:      * Adds error message to the list.
490:      * @param  string  error message
491:      * @return void
492:      */
493:     public function addError($message)
494:     {
495:         $this->errors[] = $message;
496:     }
497: 
498: 
499:     /**
500:      * Returns errors corresponding to control.
501:      * @return string
502:      */
503:     public function getError()
504:     {
505:         return $this->errors ? implode(' ', array_unique($this->errors)) : NULL;
506:     }
507: 
508: 
509:     /**
510:      * Returns errors corresponding to control.
511:      * @return array
512:      */
513:     public function getErrors()
514:     {
515:         return array_unique($this->errors);
516:     }
517: 
518: 
519:     /**
520:      * @return bool
521:      */
522:     public function hasErrors()
523:     {
524:         return (bool) $this->errors;
525:     }
526: 
527: 
528:     /**
529:      * @return void
530:      */
531:     public function cleanErrors()
532:     {
533:         $this->errors = [];
534:     }
535: 
536: 
537:     /**
538:      * Globally enables new required/optional behavior.
539:      * This method will be deprecated in next version.
540:      */
541:     public static function enableAutoOptionalMode()
542:     {
543:         self::$autoOptional = TRUE;
544:     }
545: 
546: 
547:     /********************* user data ****************d*g**/
548: 
549: 
550:     /**
551:      * Sets user-specific option.
552:      * @return self
553:      */
554:     public function setOption($key, $value)
555:     {
556:         if ($value === NULL) {
557:             unset($this->options[$key]);
558:         } else {
559:             $this->options[$key] = $value;
560:         }
561:         return $this;
562:     }
563: 
564: 
565:     /**
566:      * Returns user-specific option.
567:      * @return mixed
568:      */
569:     public function getOption($key, $default = NULL)
570:     {
571:         return isset($this->options[$key]) ? $this->options[$key] : $default;
572:     }
573: 
574: 
575:     /**
576:      * Returns user-specific options.
577:      * @return array
578:      */
579:     public function getOptions()
580:     {
581:         return $this->options;
582:     }
583: 
584: 
585:     /********************* extension methods ****************d*g**/
586: 
587: 
588:     public function __call($name, $args)
589:     {
590:         if ($callback = Nette\Utils\ObjectMixin::getExtensionMethod(get_class($this), $name)) {
591:             return Nette\Utils\Callback::invoke($callback, $this, ...$args);
592:         }
593:         return parent::__call($name, $args);
594:     }
595: 
596: 
597:     public static function extensionMethod($name, $callback = NULL)
598:     {
599:         if (strpos($name, '::') !== FALSE) { // back compatibility
600:             list(, $name) = explode('::', $name);
601:         }
602:         Nette\Utils\ObjectMixin::setExtensionMethod(get_called_class(), $name, $callback);
603:     }
604: 
605: }
606: 
Nette 2.4-20161109 API API documentation generated by ApiGen 2.8.0