Type: added mergeMode() [WIP]

TODO: Type should not support the array at all

Author: dg

src/Schema/Elements/Type.php

@@ -10,6 +10,7 @@
 use Nette\Schema\Context;
 use Nette\Schema\DynamicParameter;
 use Nette\Schema\Helpers;
+use Nette\Schema\MergeMode;
 use Nette\Schema\Schema;
 use function array_key_exists, array_pop, implode, is_array, str_replace, strpos;
 
@@ -26,6 +27,7 @@ final class Type implements Schema
 	private array $range = [null, null];
 	private ?string $pattern = null;
 	private bool $merge = false;
+	private ?MergeMode $mergeMode = null;
 
 
 	public function __construct(string $type)
@@ -57,6 +59,16 @@ public function mergeDefaults(bool $state = true): self
 	}
 
 
+	/**
+	 * Sets how arrays are combined when merging multiple configurations.
+	 */
+	public function mergeMode(MergeMode $mode): self
+	{
+		$this->mergeMode = $mode;
+		return $this;
+	}
+
+
 	/**
 	 * Allows the value to be a DynamicParameter, which is recorded for deferred validation.
 	 */
@@ -142,19 +154,19 @@ public function normalize(mixed $value, Context $context): mixed
 
 	public function merge(mixed $value, mixed $base): mixed
 	{
-		if (is_array($value) && isset($value[Helpers::PreventMerging])) {
+		if ($this->mergeMode === MergeMode::Replace || (is_array($value) && isset($value[Helpers::PreventMerging]))) {
 			unset($value[Helpers::PreventMerging]);
 			return $value;
 		}
 
-		if (is_array($value) && is_array($base) && $this->itemsValue) {
-			$index = 0;
+		if (is_array($value) && is_array($base) && ($this->itemsValue || $this->mergeMode)) {
+			$index = $this->mergeMode === MergeMode::OverwriteKeys ? null : 0;
 			foreach ($value as $key => $val) {
 				if ($key === $index) {
 					$base[] = $val;
 					$index++;
 				} else {
-					$base[$key] = array_key_exists($key, $base)
+					$base[$key] = array_key_exists($key, $base) && $this->itemsValue
 						? $this->itemsValue->merge($val, $base[$key])
 						: $val;
 				}

src/Schema/enums.php

@@ -0,0 +1,24 @@
+<?php declare(strict_types=1);
+
+/**
+ * This file is part of the Nette Framework (https://nette.org)
+ * Copyright (c) 2004 David Grudl (https://davidgrudl.com)
+ */
+
+namespace Nette\Schema;
+
+
+/**
+ * Defines the strategy for merging array values in Type schemas.
+ */
+enum MergeMode: int
+{
+	/** Replaces all items with the last one. */
+	case Replace = 0;
+
+	/** Overwrites existing keys. */
+	case OverwriteKeys = 1;
+
+	/** Overwrites existing keys and appends new indexed elements. */
+	case AppendKeys = 2;
+}

tests/Schema/Expect.array.phpt

@@ -2,6 +2,7 @@
 
 use Nette\Schema\Expect;
 use Nette\Schema\Helpers;
+use Nette\Schema\MergeMode;
 use Nette\Schema\Processor;
 use Tester\Assert;
 
@@ -334,3 +335,34 @@ test('array shape', function () {
 		(new Processor)->process($schema, []),
 	);
 });
+
+
+test('merge modes', function () {
+	$schema = Expect::structure([
+		'foo1' => Expect::array()->mergeMode(MergeMode::Replace),
+		'foo2' => Expect::array()->mergeMode(MergeMode::OverwriteKeys),
+		'foo3' => Expect::array()->mergeMode(MergeMode::AppendKeys),
+	]);
+
+	$processor = new Processor;
+
+	Assert::equal(
+		(object) [
+			'foo1' => ['key' => 'new'],
+			'foo2' => ['new', 'key' => 'new'],
+			'foo3' => ['old', 'new', 'key' => 'new'],
+		],
+		$processor->processMultiple($schema, [
+			[
+				'foo1' => ['old', 'key' => '1'],
+				'foo2' => ['old', 'key' => '1'],
+				'foo3' => ['old', 'key' => '1'],
+			],
+			[
+				'foo1' => ['key' => 'new'],
+				'foo2' => ['new', 'key' => 'new'],
+				'foo3' => ['new', 'key' => 'new'],
+			],
+		]),
+	);
+});