events refactoring, added default values, removed magic

Author: dg

composer.json

@@ -18,7 +18,7 @@
 		"php": ">=7.2 <8.1",
 		"nette/component-model": "^3.0",
 		"nette/http": "^3.1",
-		"nette/utils": "^3.2"
+		"nette/utils": "^3.2.1"
 	},
 	"require-dev": {
 		"nette/application": "^3.0",

src/Forms/Container.php

@@ -27,7 +27,7 @@ class Container extends Nette\ComponentModel\Container implements \ArrayAccess
 	private const ARRAY = 'array';
 
 	/** @var callable[]&(callable(Container, mixed): void)[]; Occurs when the form is validated */
-	public $onValidate;
+	public $onValidate = [];
 
 	/** @var ControlGroup|null */
 	protected $currentGroup;
@@ -188,19 +188,13 @@ public function validate(array $controls = null): void
 		}
 		$this->validated = true;
 
-		if ($this->onValidate !== null) {
-			if (!is_iterable($this->onValidate)) {
-				throw new Nette\UnexpectedValueException('Property Form::$onValidate must be iterable, ' . gettype($this->onValidate) . ' given.');
-			}
-
-			$isValid = !$this->getErrors();
-			foreach ($this->onValidate as $handler) {
-				$params = Nette\Utils\Callback::toReflection($handler)->getParameters();
-				$values = isset($params[1]) && $isValid
-					? $this->getValues($params[1]->getType() instanceof \ReflectionNamedType ? $params[1]->getType()->getName() : null)
-					: null;
-				$handler($this, $values);
-			}
+		$isValid = !$this->getErrors();
+		foreach ($this->onValidate as $handler) {
+			$params = Nette\Utils\Callback::toReflection($handler)->getParameters();
+			$values = isset($params[1]) && $isValid
+				? $this->getValues($params[1]->getType() instanceof \ReflectionNamedType ? $params[1]->getType()->getName() : null)
+				: null;
+			$handler($this, $values);
 		}
 	}
 

src/Forms/Controls/SubmitButton.php

@@ -20,10 +20,10 @@
 class SubmitButton extends Button implements Nette\Forms\SubmitterControl
 {
 	/** @var callable[]&(callable(SubmitButton): void)[]; Occurs when the button is clicked and form is successfully validated */
-	public $onClick;
+	public $onClick = [];
 
 	/** @var callable[]&(callable(SubmitButton): void)[]; Occurs when the button is clicked and form is not validated */
-	public $onInvalidClick;
+	public $onInvalidClick = [];
 
 	/** @var array|null */
 	private $validationScope;
@@ -93,7 +93,7 @@ public function getValidationScope(): ?array
 	 */
 	public function click(): void
 	{
-		$this->onClick($this);
+		Nette\Utils\Arrays::invoke($this->onClick, $this);
 	}
 
 

src/Forms/Form.php

@@ -10,6 +10,7 @@
 namespace Nette\Forms;
 
 use Nette;
+use Nette\Utils\Arrays;
 use Nette\Utils\Html;
 
 
@@ -82,16 +83,16 @@ class Form extends Container implements Nette\HtmlStringable
 	public const PROTECTOR_ID = '_token_';
 
 	/** @var callable[]&(callable(Form, mixed): void)[]; Occurs when the form is submitted and successfully validated */
-	public $onSuccess;
+	public $onSuccess = [];
 
 	/** @var callable[]&(callable(Form): void)[]; Occurs when the form is submitted and is not valid */
-	public $onError;
+	public $onError = [];
 
 	/** @var callable[]&(callable(Form): void)[]; Occurs when the form is submitted */
-	public $onSubmit;
+	public $onSubmit = [];
 
 	/** @var callable[]&(callable(Form): void)[]; Occurs before the form is rendered */
-	public $onRender;
+	public $onRender = [];
 
 	/** @internal @var Nette\Http\IRequest  used only by standalone form */
 	public $httpRequest;
@@ -420,31 +421,21 @@ public function fireEvents(): void
 
 		if ($this->submittedBy instanceof SubmitterControl) {
 			if ($this->isValid()) {
-				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);
-				}
+				$this->invokeHandlers($this->submittedBy->onClick, $this->submittedBy);
 			} else {
-				$this->submittedBy->onInvalidClick($this->submittedBy);
+				Arrays::invoke($this->submittedBy->onInvalidClick, $this->submittedBy);
 			}
 		}
 
-		if (!$this->isValid()) {
-			$this->onError($this);
-
-		} elseif ($this->onSuccess !== null) {
-			if (!is_iterable($this->onSuccess)) {
-				throw new Nette\UnexpectedValueException('Property Form::$onSuccess must be iterable, ' . gettype($this->onSuccess) . ' given.');
-			}
+		if ($this->isValid()) {
 			$this->invokeHandlers($this->onSuccess);
-			if (!$this->isValid()) {
-				$this->onError($this);
-			}
 		}
 
-		$this->onSubmit($this);
+		if (!$this->isValid()) {
+			Arrays::invoke($this->onError, $this);
+		}
+
+		Arrays::invoke($this->onSubmit, $this);
 	}
 
 
@@ -630,7 +621,7 @@ public function fireRenderEvents(): void
 		if (!$this->beforeRenderCalled) {
 			$this->beforeRenderCalled = true;
 			$this->beforeRender();
-			$this->onRender($this);
+			Arrays::invoke($this->onRender, $this);
 		}
 	}
 

tests/Forms/Container.validate().phpt

@@ -34,10 +34,3 @@ Assert::same([
 	'fail 1',
 	'fail 2',
 ], $form->getErrors());
-
-
-Assert::exception(function () {
-	$form = new Form;
-	$form->onValidate = true;
-	$form->validate();
-}, Nette\UnexpectedValueException::class, 'Property Form::$onValidate must be iterable, boolean given.');

tests/Forms/Forms.onClick.phpt

@@ -106,10 +106,3 @@ test('invalid', function () {
 	$form->fireEvents();
 	Assert::same(['invalidClick', 'error', 'submit'], $called);
 });
-
-
-Assert::exception(function () {
-	$form = new Form;
-	$form->addSubmit('btn')->onClick = true;
-	$form->fireEvents();
-}, Nette\UnexpectedValueException::class, "Property \$onClick in button 'btn' must be iterable, boolean given.");

tests/Forms/Forms.onSuccess.phpt

@@ -88,10 +88,3 @@ test('invalid', function () {
 	$form->fireEvents();
 	Assert::same(['error', 'submit'], $called);
 });
-
-
-Assert::exception(function () {
-	$form = new Form;
-	$form->onSuccess = true;
-	$form->fireEvents();
-}, Nette\UnexpectedValueException::class, 'Property Form::$onSuccess must be iterable, boolean given.');