$onClick handlers are called with argument $values (as $onSuccess)

Author: dg

src/Forms/Form.php

@@ -400,7 +400,12 @@ public function fireEvents(): void
 
 		if ($this->submittedBy instanceof ISubmitterControl) {
 			if ($this->isValid()) {
-				$this->submittedBy->onClick($this->submittedBy);
+				if ($handlers = $this->submittedBy->onClick) {
+					if (!is_iterable($handlers)) {
+						throw new Nette\UnexpectedValueException("Property \$onClick in button '{$this->submittedBy->getName()}' must be iterable, " . gettype($handlers) . ' given.');
+					}
+					$this->invokeHandlers($handlers, $this->submittedBy);
+				}
 			} else {
 				$this->submittedBy->onInvalidClick($this->submittedBy);
 			}
@@ -413,21 +418,29 @@ public function fireEvents(): void
 			if (!is_iterable($this->onSuccess)) {
 				throw new Nette\UnexpectedValueException('Property Form::$onSuccess must be iterable, ' . gettype($this->onSuccess) . ' given.');
 			}
-			foreach ($this->onSuccess as $handler) {
-				$params = Nette\Utils\Callback::toReflection($handler)->getParameters();
-				$values = isset($params[1]) ? $this->getValues($params[1]->isArray()) : NULL;
-				Nette\Utils\Callback::invoke($handler, $this, $values);
-				if (!$this->isValid()) {
-					$this->onError($this);
-					break;
-				}
+			$this->invokeHandlers($this->onSuccess);
+			if (!$this->isValid()) {
+				$this->onError($this);
 			}
 		}
 
 		$this->onSubmit($this);
 	}
 
 
+	private function invokeHandlers(iterable $handlers, $button = NULL): void
+	{
+		foreach ($handlers as $handler) {
+			$params = Nette\Utils\Callback::toReflection($handler)->getParameters();
+			$values = isset($params[1]) ? $this->getValues($params[1]->isArray()) : NULL;
+			Nette\Utils\Callback::invoke($handler, $button ?: $this, $values);
+			if (!$button && !$this->isValid()) {
+				return;
+			}
+		}
+	}
+
+
 	/**
 	 * Internal: returns submitted HTTP data or NULL when form was not submitted.
 	 */

tests/Forms/Forms.callbackParameters.phpt

@@ -8,16 +8,18 @@ declare(strict_types=1);
 
 use Nette\Utils\ArrayHash;
 use Nette\Forms\Form;
+use Nette\Forms\Controls\SubmitButton;
 use Tester\Assert;
 
 require __DIR__ . '/../bootstrap.php';
 
 $_SERVER['REQUEST_METHOD'] = 'POST';
 $_POST['text'] = 'a';
+$_POST['btn'] = 'b';
 
 $form = new Form();
 $form->addText('text');
-$form->addSubmit('submit');
+$form->addSubmit('btn');
 
 $types = [];
 
@@ -33,6 +35,18 @@ $f2 = function ($form, array $values) use (&$types) {
 	$types[] = is_array($values);
 };
 
+// Test the closure second parameter to be an ArrayHash instance by default
+$b1 = function ($form, $values) use (&$types) {
+	$types[] = $form instanceof SubmitButton;
+	$types[] = $values instanceof ArrayHash;
+};
+
+// Test the closure second parameter to be an array by type-hint
+$b2 = function ($form, array $values) use (&$types) {
+	$types[] = $form instanceof SubmitButton;
+	$types[] = is_array($values);
+};
+
 // Test the second parameter in ArrayHash form to be immutable
 $f4 = function ($form, $values) use (&$types) {
 	$values->text = 'b';
@@ -44,7 +58,8 @@ $f5 = function ($form, $values) use (&$arrayHashIsImmutable) {
 
 $form->onSuccess = [$f1, $f2, $f1, $f4, $f5];
 $form->onValidate = [$f1, $f2, $f1, $f4, $f5];
+$form['btn']->onClick = [$b1, $b2, $b1, $f4, $f5];
 $form->fireEvents();
 
-Assert::same([TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE], $types);
-Assert::same([TRUE, TRUE], $arrayHashIsImmutable);
+Assert::same([TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE], $types);
+Assert::same([TRUE, TRUE, TRUE], $arrayHashIsImmutable);

tests/Forms/Forms.onClick.phpt

@@ -73,4 +73,4 @@ Assert::exception(function () {
 	$form = new Form;
 	$form->addSubmit('btn')->onClick = TRUE;
 	$form->fireEvents();
-}, Nette\UnexpectedValueException::class, 'Property Nette\Forms\Controls\SubmitButton::$onClick must be array or NULL, boolean given.');
+}, Nette\UnexpectedValueException::class, "Property \$onClick in button 'btn' must be iterable, boolean given.");