Form submit handling

src/Form.php

@@ -18,9 +18,9 @@ class Form extends BaseHtmlElement
 
     public const ON_ELEMENT_REGISTERED = 'elementRegistered';
     public const ON_ERROR = 'error';
-    public const ON_REQUEST = 'request';
+    public const ON_SUBMIT = 'submit';
+    /** @deprecated Use {@link ON_SUBMIT} instead. */
     public const ON_SUCCESS = 'success';
-    public const ON_SENT = 'sent';
     public const ON_VALIDATE = 'validate';
 
     /** @var string Form submission URL */
@@ -41,9 +41,6 @@ class Form extends BaseHtmlElement
     /** @var ServerRequestInterface The server request being processed */
     protected $request;
 
-    /** @var string */
-    protected $redirectUrl;
-
     protected $tag = 'form';
 
     /**
@@ -152,51 +149,16 @@ public function getRequest()
         return $this->request;
     }
 
-    public function setRequest($request)
-    {
-        $this->request = $request;
-        $this->emit(Form::ON_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;
-    }
-
     /**
      * @param ServerRequestInterface $request
      *
      * @return $this
      */
     public function handleRequest(ServerRequestInterface $request)
     {
-        $this->setRequest($request);
+        $this->request = $request;
 
         if (! $this->hasBeenSent()) {
-            // Always assemble
-            $this->ensureAssembled();
-
             return $this;
         }
 
@@ -212,29 +174,46 @@ public function handleRequest(ServerRequestInterface $request)
             default:
                 $params = [];
         }
-
         $this->populate($params);
 
         // Assemble after populate in order to conditionally provide form elements
         $this->ensureAssembled();
 
-        if ($this->hasBeenSubmitted()) {
-            if ($this->isValid()) {
-                try {
-                    $this->emit(Form::ON_SENT, [$this]);
-                    $this->onSuccess();
-                    $this->emitOnce(Form::ON_SUCCESS, [$this]);
-                } catch (Exception $e) {
-                    $this->addMessage($e);
-                    $this->onError();
-                    $this->emit(Form::ON_ERROR, [$e, $this]);
-                }
+        $submitElement = $this->getPressedSubmitElement();
+        if (
+            ! empty($this->submitElements)
+            && $submitElement === null
+        ) {
+            // If elements are registered for submission, but none have been pressed,
+            // the form was most likely submitted via auto-submit. In this case,
+            // we validate all elements that have a value, but do nothing else.
+            $this->validatePartial();
+
+            return $this;
+        }
+
+        // From here, the form is considered submitted because either one of the submit elements has been pressed
+        // or the form has been sent without a submit element being registered.
+        if (
+            $submitElement->getAttributes()->get('formnovalidate')->getValue() !== true
+            && ! $this->isValid()
+        ) {
+            $this->onError();
+
+            return $this;
+        }
+        try {
+            if ($submitElement === $this->getSubmitButton()) {
+                $this->onSuccess();
+                $this->emitOnce(Form::ON_SUCCESS, [$this]);
             } else {
-                $this->onError();
+                $this->onSubmit($submitElement);
+                $this->emit(static::ON_SUBMIT, [$submitElement]);
             }
-        } else {
-            $this->validatePartial();
-            $this->emit(Form::ON_SENT, [$this]);
+        } catch (Exception $e) {
+            $this->addMessage($e);
+            $this->onError();
+            $this->emit(Form::ON_ERROR, [$e, $this]);
         }
 
         return $this;
@@ -259,7 +238,8 @@ public function hasBeenSent()
     /**
      * Get whether the form has been submitted
      *
-     * A form is submitted when it has been sent and when the primary submit button, if set, has been pressed.
+     * A form is considered submitted because either it has been sent by pressing one of the registered submit elements
+     * or the form has been sent without a submit element being registered.
      * This method calls {@link hasBeenSent()} in order to detect whether the form has been sent.
      *
      * @return bool
@@ -270,11 +250,11 @@ public function hasBeenSubmitted()
             return false;
         }
 
-        if ($this->hasSubmitButton()) {
-            return $this->getSubmitButton()->hasBeenPressed();
+        if (empty($this->submitElements)) {
+            return true;
         }
 
-        return true;
+        return $this->getPressedSubmitElement() !== null;
     }
 
     /**
@@ -335,8 +315,15 @@ public function validatePartial()
 
     public function remove(ValidHtml $elementOrHtml)
     {
-        if ($this->submitButton === $elementOrHtml) {
-            $this->submitButton = null;
+        if ($elementOrHtml instanceof FormSubmitElement) {
+            if ($this->submitButton === $elementOrHtml) {
+                $this->submitButton = null;
+            }
+
+            $key = array_search($elementOrHtml, $this->submitElements, true);
+            if ($key !== false) {
+                unset($this->submitElements[$key]);
+            }
         }
 
         $this->removeElement($elementOrHtml);
@@ -358,9 +345,13 @@ protected function onError()
         }
     }
 
+    protected function onSubmit(FormSubmitElement $submitElement)
+    {
+    }
+
+    /** @deprecated Use {@link onSubmit()} instead. */
     protected function onSuccess()
     {
-        // $this->redirectOnSuccess();
     }
 
     protected function onElementRegistered(FormElement $element)

src/FormElement/FormElements.php

@@ -469,9 +469,7 @@ public function isValidEvent($event)
     {
         return in_array($event, [
             Form::ON_SUCCESS,
-            Form::ON_SENT,
             Form::ON_ERROR,
-            Form::ON_REQUEST,
             Form::ON_VALIDATE,
             Form::ON_ELEMENT_REGISTERED,
         ]);