*/ protected ?DecoratorChain $decorators = null; /** @var bool Whether the form has been decorated */ protected bool $decorated = false; protected $tag = 'form'; /** * Get whether the given value is empty * * @param mixed $value * * @return bool */ public static function isEmptyValue($value): bool { return $value === null || $value === [] || (is_string($value) && trim($value) === ''); } /** * Return the given string unchanged. * * @param string $string * @param bool $escapeBrackets * * @return string * @deprecated Escaping element names must be explicitly done. This method does not escape * anymore and will be removed in a future version. */ public static function escapeReservedChars(string $string, bool $escapeBrackets = true): string { trigger_error(sprintf( '%s is deprecated. Escaping element names must be explicitly done.', __METHOD__ ), E_USER_DEPRECATED); return $string; } public function getAction() { return $this->action; } /** * Set the Form submission URL * * @param string $action * * @return $this */ public function setAction($action) { $this->action = $action; return $this; } public function getMethod() { return $this->method; } /** * Set the HTTP method to submit the form with * * @param string $method * * @return $this */ public function setMethod($method) { $this->method = strtoupper($method); return $this; } /** * Get whether the form has a primary submit button * * @return bool */ public function hasSubmitButton() { return $this->submitButton !== null; } /** * Get the primary submit button * * @return FormSubmitElement|null */ public function getSubmitButton() { return $this->submitButton; } /** * Set the primary submit button * * @param FormSubmitElement $element * * @return $this */ public function setSubmitButton(FormSubmitElement $element) { $this->submitButton = $element; return $this; } /** * Get the submit element used to send the form * * @return FormSubmitElement|null */ public function getPressedSubmitElement() { foreach ($this->submitElements as $submitElement) { if ($submitElement->hasBeenPressed()) { return $submitElement; } } return null; } public function getRequest() { return $this->request; } public function setRequest($request) { $this->request = $request; return $this; } /** * Get the url to redirect to on success * * @return string */ public function getRedirectUrl() { return $this->redirectUrl; } /** * Set the url to redirect to on success * * @param string $url * * @return $this */ public function setRedirectUrl($url) { $this->redirectUrl = $url; return $this; } /** * Get the decorators of this form * * @return DecoratorChain */ public function getDecorators(): DecoratorChain { if ($this->decorators === null) { $this->decorators = new DecoratorChain(FormDecoration::class); } return $this->decorators; } public function handleRequest(ServerRequestInterface $request) { $this->setRequest($request); if (! $this->hasBeenSent()) { $this->emit(Contract\Form::ON_REQUEST, [$request, $this]); // Always assemble $this->ensureAssembled(); return $this; } switch ($request->getMethod()) { case 'POST': $params = $request->getParsedBody(); break; case 'GET': parse_str($request->getUri()->getQuery(), $params); break; default: $params = []; } $params = array_merge_recursive($params, $request->getUploadedFiles()); $this->populate($params); // Assemble after populate in order to conditionally provide form elements $this->ensureAssembled(); if ($this->hasBeenSubmitted()) { if ($this->isValid()) { try { $this->emit(Contract\Form::ON_SENT, [$this]); $this->onSuccess(); $this->emitOnce(Contract\Form::ON_SUBMIT, [$this]); } catch (Throwable $e) { $this->addMessage($e->getMessage()); $this->onError(); $this->emit(Contract\Form::ON_ERROR, [$e, $this]); } } else { $this->onError(); } } else { $this->validatePartial(); $this->emit(Contract\Form::ON_SENT, [$this]); } return $this; } public function hasBeenSent() { if ($this->request === null) { return false; } return $this->request->getMethod() === $this->getMethod(); } public function hasBeenSubmitted() { if (! $this->hasBeenSent()) { return false; } if ($this->hasSubmitButton()) { return $this->getSubmitButton()->hasBeenPressed(); } return true; } public function isValid() { if ($this->isValid === null) { $this->validate(); $this->emit(Contract\Form::ON_VALIDATE, [$this]); } return $this->isValid; } /** * Validate all elements * * @return $this */ public function validate() { $this->ensureAssembled(); $valid = true; foreach ($this->getElements() as $element) { $element->validate(); if (! $element->isValid()) { $valid = false; } } $this->isValid = $valid; return $this; } /** * Validate all elements that have a value * * @return $this */ public function validatePartial() { foreach ($this->yieldElementsRecursive($this) as $element) { if ($element->hasValue()) { $element->validate(); } } return $this; } public function remove(ValidHtml $content) { if ($this->submitButton === $content) { $this->submitButton = null; } $this->baseRemove($content); return $this; } /** * Apply the form decoration * * @return void */ protected function applyDecoration(): void { if ($this->decorated) { return; } $result = new FormDecorationResult($this); foreach ($this->getDecorators() as $decorator) { $decorator->decorateForm($result, $this); } $this->decorated = true; } protected function onError() { $errors = Html::tag('ul', ['class' => 'errors']); foreach ($this->getMessages() as $message) { if ($message instanceof Throwable) { $message = $message->getMessage(); } $errors->addHtml(Html::tag('li', $message)); } if (! $errors->isEmpty()) { $this->prependHtml($errors); } } protected function onSuccess() { // $this->redirectOnSuccess(); } protected function onElementRegistered(FormElement $element) { if ($element instanceof FormSubmitElement) { $this->submitElements[$element->getName()] = $element; if (! $this->hasSubmitButton()) { $this->setSubmitButton($element); } } $element->onRegistered($this); } protected function registerAttributeCallbacks(Attributes $attributes) { $attributes ->registerAttributeCallback('action', [$this, 'getAction'], [$this, 'setAction']) ->registerAttributeCallback('method', [$this, 'getMethod'], [$this, 'setMethod']); } protected function beforeRender(): void { $this->baseBeforeRender(); $this->applyDecoration(); } /** * Yield all sub form elements of $from by traversing the form elements tree recursively * * Recurses into nested {@see FormElements} instances instead of yielding them directly. * * @param Contract\FormElements $from Entry point for traversing * * @return Generator */ protected function yieldElementsRecursive(Contract\FormElements $from): Generator { if ($from instanceof HtmlDocument) { $from->ensureAssembled(); } foreach ($from->getElements() as $element) { if ($element instanceof Contract\FormElements) { yield from $this->yieldElementsRecursive($element); } else { yield $element; } } } }