*/ public $onSuccess = []; /** @var array Occurs when the form is submitted and is not valid */ public $onError = []; /** @var array Occurs when the form is submitted */ public $onSubmit = []; /** @var array Occurs before the form is rendered */ public $onRender = []; /** @internal @var \Packetery\Nette\Http\IRequest used only by standalone form */ public $httpRequest; /** @var bool */ protected $crossOrigin = \false; /** @var \Packetery\Nette\Http\IRequest */ private static $defaultHttpRequest; /** @var mixed or null meaning: not detected yet */ private $submittedBy; /** @var array */ private $httpData; /** @var Html element

*/ private $element; /** @var FormRenderer */ private $renderer; /** @var \Packetery\Nette\Localization\Translator */ private $translator; /** @var ControlGroup[] */ private $groups = []; /** @var array */ private $errors = []; /** @var bool */ private $beforeRenderCalled; /** * Form constructor. */ public function __construct(string $name = null) { if ($name !== null) { $this->getElementPrototype()->id = 'frm-' . $name; $tracker = new Controls\HiddenField($name); $tracker->setOmitted(); $this[self::TRACKER_ID] = $tracker; $this->setParent(null, $name); } $this->monitor(self::class, function () : void { throw new \Packetery\Nette\InvalidStateException('Nested forms are forbidden.'); }); } /** * Returns self. * @return static */ public function getForm(bool $throw = \true) : self { return $this; } /** * Sets form's action. * @param string|object $url * @return static */ public function setAction($url) { $this->getElementPrototype()->action = $url; return $this; } /** * Returns form's action. * @return mixed */ public function getAction() { return $this->getElementPrototype()->action; } /** * Sets form's method GET or POST. * @return static */ public function setMethod(string $method) { if ($this->httpData !== null) { throw new \Packetery\Nette\InvalidStateException(__METHOD__ . '() must be called until the form is empty.'); } $this->getElementPrototype()->method = \strtolower($method); return $this; } /** * Returns form's method. */ public function getMethod() : string { return $this->getElementPrototype()->method; } /** * Checks if the request method is the given one. */ public function isMethod(string $method) : bool { return \strcasecmp($this->getElementPrototype()->method, $method) === 0; } /** * Changes forms's HTML attribute. * @return static */ public function setHtmlAttribute(string $name, $value = \true) { $this->getElementPrototype()->{$name} = $value; return $this; } /** * Disables CSRF protection using a SameSite cookie. */ public function allowCrossOrigin() : void { $this->crossOrigin = \true; } /** * Cross-Site Request Forgery (CSRF) form protection. */ public function addProtection(string $errorMessage = null) : Controls\CsrfProtection { $control = new Controls\CsrfProtection($errorMessage); $this->addComponent($control, self::PROTECTOR_ID, \key((array) $this->getComponents())); return $control; } /** * Adds fieldset group to the form. */ public function addGroup(string $caption = null, bool $setAsCurrent = \true) : ControlGroup { $group = new ControlGroup(); $group->setOption('label', $caption); $group->setOption('visual', \true); if ($setAsCurrent) { $this->setCurrentGroup($group); } return !\is_scalar($caption) || isset($this->groups[$caption]) ? $this->groups[] = $group : ($this->groups[$caption] = $group); } /** * Removes fieldset group from form. * @param string|ControlGroup $name */ public function removeGroup($name) : void { if (\is_string($name) && isset($this->groups[$name])) { $group = $this->groups[$name]; } elseif ($name instanceof ControlGroup && \in_array($name, $this->groups, \true)) { $group = $name; $name = \array_search($group, $this->groups, \true); } else { throw new \Packetery\Nette\InvalidArgumentException("Group not found in form '{$this->name}'"); } foreach ($group->getControls() as $control) { $control->getParent()->removeComponent($control); } unset($this->groups[$name]); } /** * Returns all defined groups. * @return ControlGroup[] */ public function getGroups() : array { return $this->groups; } /** * Returns the specified group. * @param string|int $name */ public function getGroup($name) : ?ControlGroup { return $this->groups[$name] ?? null; } /********************* translator ****************d*g**/ /** * Sets translate adapter. * @return static */ public function setTranslator(?Nette\Localization\Translator $translator) { $this->translator = $translator; return $this; } /** * Returns translate adapter. */ public function getTranslator() : ?Nette\Localization\Translator { return $this->translator; } /********************* submission ****************d*g**/ /** * Tells if the form is anchored. */ public function isAnchored() : bool { return \true; } /** * Tells if the form was submitted. * @return SubmitterControl|bool submittor control */ public function isSubmitted() { if ($this->submittedBy === null) { $this->getHttpData(); } return $this->submittedBy; } /** * Tells if the form was submitted and successfully validated. */ public function isSuccess() : bool { return $this->isSubmitted() && $this->isValid(); } /** * Sets the submittor control. * @return static * @internal */ public function setSubmittedBy(?SubmitterControl $by) { $this->submittedBy = $by ?? \false; return $this; } /** * Returns submitted HTTP data. * @return mixed */ public function getHttpData(int $type = null, string $htmlName = null) { if ($this->httpData === null) { if (!$this->isAnchored()) { throw new \Packetery\Nette\InvalidStateException('Form is not anchored and therefore can not determine whether it was submitted.'); } $data = $this->receiveHttpData(); $this->httpData = (array) $data; $this->submittedBy = \is_array($data); } if ($htmlName === null) { return $this->httpData; } return Helpers::extractHttpData($this->httpData, $htmlName, $type); } /** * Fires submit/click events. */ public function fireEvents() : void { if (!$this->isSubmitted()) { return; } elseif (!$this->getErrors()) { $this->validate(); } if ($this->submittedBy instanceof Controls\SubmitButton) { if ($this->isValid()) { $this->invokeHandlers($this->submittedBy->onClick, $this->submittedBy); } else { Arrays::invoke($this->submittedBy->onInvalidClick, $this->submittedBy); } } if ($this->isValid()) { $this->invokeHandlers($this->onSuccess); } if (!$this->isValid()) { Arrays::invoke($this->onError, $this); } Arrays::invoke($this->onSubmit, $this); } private function invokeHandlers(iterable $handlers, $button = null) : void { foreach ($handlers as $handler) { $params = \Packetery\Nette\Utils\Callback::toReflection($handler)->getParameters(); $types = \array_map([\Packetery\Nette\Utils\Reflection::class, 'getParameterType'], $params); if (!isset($types[0])) { $arg0 = $button ?: $this; } elseif ($this instanceof $types[0]) { $arg0 = $this; } elseif ($button instanceof $types[0]) { $arg0 = $button; } else { $arg0 = $this->getValues($types[0]); } $arg1 = isset($params[1]) ? $this->getValues($types[1]) : null; $handler($arg0, $arg1); if (!$this->isValid()) { return; } } } /** * Resets form. * @return static */ public function reset() { $this->setSubmittedBy(null); $this->setValues([], \true); return $this; } /** * Internal: returns submitted HTTP data or null when form was not submitted. */ protected function receiveHttpData() : ?array { $httpRequest = $this->getHttpRequest(); if (\strcasecmp($this->getMethod(), $httpRequest->getMethod())) { return null; } if ($httpRequest->isMethod('post')) { if (!$this->crossOrigin && !$httpRequest->isSameSite()) { return null; } $data = \Packetery\Nette\Utils\Arrays::mergeTree($httpRequest->getPost(), $httpRequest->getFiles()); } else { $data = $httpRequest->getQuery(); if (!$data) { return null; } } if ($tracker = $this->getComponent(self::TRACKER_ID, \false)) { if (!isset($data[self::TRACKER_ID]) || $data[self::TRACKER_ID] !== $tracker->getValue()) { return null; } } return $data; } /********************* validation ****************d*g**/ public function validate(array $controls = null) : void { $this->cleanErrors(); if ($controls === null && $this->submittedBy instanceof SubmitterControl) { $controls = $this->submittedBy->getValidationScope(); } $this->validateMaxPostSize(); parent::validate($controls); } /** @internal */ public function validateMaxPostSize() : void { if (!$this->submittedBy || !$this->isMethod('post') || empty($_SERVER['CONTENT_LENGTH'])) { return; } $maxSize = Helpers::iniGetSize('post_max_size'); if ($maxSize > 0 && $maxSize < $_SERVER['CONTENT_LENGTH']) { $this->addError(\sprintf(Validator::$messages[self::MAX_FILE_SIZE], $maxSize)); } } /** * Adds global error message. * @param string|object $message */ public function addError($message, bool $translate = \true) : void { if ($translate && $this->translator) { $message = $this->translator->translate($message); } $this->errors[] = $message; } /** * Returns global validation errors. */ public function getErrors() : array { return \array_unique(\array_merge($this->errors, parent::getErrors())); } public function hasErrors() : bool { return (bool) $this->getErrors(); } public function cleanErrors() : void { $this->errors = []; } /** * Returns form's validation errors. */ public function getOwnErrors() : array { return \array_unique($this->errors); } /********************* rendering ****************d*g**/ /** * Returns form's HTML element template. */ public function getElementPrototype() : Html { if (!$this->element) { $this->element = Html::el('form'); $this->element->action = ''; // RFC 1808 -> empty uri means 'this' $this->element->method = self::POST; } return $this->element; } /** * Sets form renderer. * @return static */ public function setRenderer(?FormRenderer $renderer) { $this->renderer = $renderer; return $this; } /** * Returns form renderer. */ public function getRenderer() : FormRenderer { if ($this->renderer === null) { $this->renderer = new Rendering\DefaultFormRenderer(); } return $this->renderer; } protected function beforeRender() { } /** * Must be called before form is rendered and render() is not used. */ public function fireRenderEvents() : void { if (!$this->beforeRenderCalled) { $this->beforeRenderCalled = \true; $this->beforeRender(); Arrays::invoke($this->onRender, $this); } } /** * Renders form. */ public function render(...$args) : void { $this->fireRenderEvents(); echo $this->getRenderer()->render($this, ...$args); } /** * Renders form to string. * @param can throw exceptions? (hidden parameter) */ public function __toString() : string { try { $this->fireRenderEvents(); return $this->getRenderer()->render($this); } catch (\Throwable $e) { if (\func_num_args() || \PHP_VERSION_ID >= 70400) { throw $e; } \trigger_error('Exception in ' . __METHOD__ . "(): {$e->getMessage()} in {$e->getFile()}:{$e->getLine()}", \E_USER_ERROR); return ''; } } public function getToggles() : array { $toggles = []; foreach ($this->getComponents(\true, Controls\BaseControl::class) as $control) { $toggles = $control->getRules()->getToggleStates($toggles); } return $toggles; } /********************* backend ****************d*g**/ /** * Initialize standalone forms. */ public static function initialize(bool $reinit = \false) : void { if ($reinit) { self::$defaultHttpRequest = null; return; } elseif (self::$defaultHttpRequest) { return; } self::$defaultHttpRequest = (new \Packetery\Nette\Http\RequestFactory())->fromGlobals(); if (\PHP_SAPI !== 'cli') { if (\headers_sent($file, $line)) { throw new \Packetery\Nette\InvalidStateException('Create a form or call \\Packetery\\Nette\\Forms\\Form::initialize() before the headers are sent to initialize CSRF protection.' . ($file ? " (output started at {$file}:{$line})" : '') . '. '); } \Packetery\Nette\Http\Helpers::initCookie(self::$defaultHttpRequest, new \Packetery\Nette\Http\Response()); } } /** @internal */ public function setHttpRequest(\Packetery\Nette\Http\IRequest $request) { $this->httpRequest = $request; } private function getHttpRequest() : \Packetery\Nette\Http\IRequest { if (!$this->httpRequest) { self::initialize(); $this->httpRequest = self::$defaultHttpRequest; } return $this->httpRequest; } }