Add self validating Value Objects (#16725)

* Add some Basic Value Objects.

 - ArrayOfBoolean
 - ArrayOfIntegers
 - PositiveInteger
 - ArrayOfPositiveIntegers
 - ArrayOfStrings
 - Path

* Update Upgrade nodes.

doc/23_Installation_and_Upgrade/09_Upgrade_Notes/README.md

@@ -16,6 +16,14 @@
 - Add rootCallback option to `Pimcore\Navigation\Builder::getNavigation()`
 #### [Symfony]
 - Bumped Symfony packages to "^6.4".
+#### [Value Objects]
+- Added new self validating Value Objects:
+  - `Pimcore\ValueObject\BooleanArray`
+  - `Pimcore\ValueObject\IntegerArray`
+  - `Pimcore\ValueObject\Path`
+  - `Pimcore\ValueObject\PositiveInteger`
+  - `Pimcore\ValueObject\PositiveIntegerArray`
+  - `Pimcore\ValueObject\StringArray`
 
 > [!WARNING]  
 > For [environment variable consistency purposes](https://github.com/pimcore/pimcore/issues/16638) in boostrap, please fix `public/index.php` in project root by moving `Bootstrap::bootstrap();` just above `$kernel = Bootstrap::kernel()` line instead of outside the closure.

lib/ValueObject/Collection/ArrayOfBoolean.php

@@ -0,0 +1,63 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * Pimcore
+ *
+ * This source file is available under two different licenses:
+ * - GNU General Public License version 3 (GPLv3)
+ * - Pimcore Commercial License (PCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ * @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
+ * @license    http://www.pimcore.org/license     GPLv3 and PCL
+ */
+
+
+namespace Pimcore\ValueObject\Collection;
+
+use ValueError;
+
+final class ArrayOfBoolean
+{
+
+    /**
+     * @throws ValueError
+     */
+    public function __construct(private readonly array $value)
+    {
+        $this->validate();
+    }
+
+    /**
+     * @throws ValueError
+     */
+    public function __wakeup(): void
+    {
+        $this->validate();
+    }
+
+    private function validate(): void
+    {
+        foreach ($this->value as $value) {
+            if (!is_bool($value)) {
+                throw new ValueError(
+                    sprintf(
+                        'Provided array must contain only boolean values. (%s given)',
+                        gettype($value)
+                    ),
+                );
+            }
+        }
+    }
+
+    /**
+     * @return bool[]
+     */
+    public function getValue(): array
+    {
+        return $this->value;
+    }
+}

lib/ValueObject/Collection/ArrayOfIntegers.php

@@ -0,0 +1,63 @@
+<?php
+
+declare(strict_types = 1);
+
+/**
+ * Pimcore
+ *
+ * This source file is available under two different licenses:
+ * - GNU General Public License version 3 (GPLv3)
+ * - Pimcore Commercial License (PCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
+ *  @license    http://www.pimcore.org/license     GPLv3 and PCL
+ */
+
+
+namespace Pimcore\ValueObject\Collection;
+
+use ValueError;
+
+final class ArrayOfIntegers
+{
+
+    /**
+     * @throws ValueError
+     */
+    public function __construct(private readonly array $value)
+    {
+        $this->validate();
+    }
+
+    /**
+     * @throws ValueError
+     */
+    public function __wakeup(): void
+    {
+        $this->validate();
+    }
+
+    private function validate(): void
+    {
+        foreach ($this->value as $value) {
+            if (!is_int($value)) {
+                throw new ValueError(
+                    sprintf(
+                        'Provided array must contain only integer values. (%s given)',
+                        gettype($value)
+                    ),
+                );
+            }
+        }
+    }
+
+    /**
+     * @return int[]
+     */
+    public function getValue(): array
+    {
+        return $this->value;
+    }
+}

lib/ValueObject/Collection/ArrayOfPositiveIntegers.php

@@ -0,0 +1,72 @@
+<?php
+
+declare(strict_types = 1);
+
+/**
+ * Pimcore
+ *
+ * This source file is available under two different licenses:
+ * - GNU General Public License version 3 (GPLv3)
+ * - Pimcore Commercial License (PCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
+ *  @license    http://www.pimcore.org/license     GPLv3 and PCL
+ */
+
+
+namespace Pimcore\ValueObject\Collection;
+
+use ValueError;
+
+final class ArrayOfPositiveIntegers
+{
+
+    /**
+     * @throws ValueError
+     */
+    public function __construct(private readonly array $value)
+    {
+        $this->validate();
+    }
+
+    /**
+     * @throws ValueError
+     */
+    public function __wakeup(): void
+    {
+        $this->validate();
+    }
+
+    private function validate(): void
+    {
+        foreach ($this->value as $value) {
+            if (!is_int($value)) {
+                throw new ValueError(
+                    sprintf(
+                        'Provided array must contain only integer values. (%s given)',
+                        gettype($value)
+                    ),
+                );
+            }
+
+            if ($value < 0) {
+                throw new ValueError(
+                    sprintf(
+                        'Provided integer must be positive. (%s given)',
+                        $value
+                    ),
+                );
+            }
+        }
+    }
+
+    /**
+     * @return int[]
+     */
+    public function getValue(): array
+    {
+        return $this->value;
+    }
+}

lib/ValueObject/Collection/ArrayOfStrings.php

@@ -0,0 +1,63 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * Pimcore
+ *
+ * This source file is available under two different licenses:
+ * - GNU General Public License version 3 (GPLv3)
+ * - Pimcore Commercial License (PCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ * @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
+ * @license    http://www.pimcore.org/license     GPLv3 and PCL
+ */
+
+
+namespace Pimcore\ValueObject\Collection;
+
+use ValueError;
+
+final class ArrayOfStrings
+{
+
+    /**
+     * @throws ValueError
+     */
+    public function __construct(private readonly array $value)
+    {
+        $this->validate();
+    }
+
+    /**
+     * @throws ValueError
+     */
+    public function __wakeup(): void
+    {
+        $this->validate();
+    }
+
+    private function validate(): void
+    {
+        foreach ($this->value as $value) {
+            if (!is_string($value)) {
+                throw new ValueError(
+                    sprintf(
+                        'Provided array must contain only string values. (%s given)',
+                        gettype($value)
+                    ),
+                );
+            }
+        }
+    }
+
+    /**
+     * @return string[]
+     */
+    public function getValue(): array
+    {
+        return $this->value;
+    }
+}

lib/ValueObject/Integer/PositiveInteger.php

@@ -0,0 +1,63 @@
+<?php
+
+declare(strict_types = 1);
+
+/**
+ * Pimcore
+ *
+ * This source file is available under two different licenses:
+ * - GNU General Public License version 3 (GPLv3)
+ * - Pimcore Commercial License (PCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
+ *  @license    http://www.pimcore.org/license     GPLv3 and PCL
+ */
+
+
+namespace Pimcore\ValueObject\Integer;
+
+use ValueError;
+
+final class PositiveInteger
+{
+
+    /**
+     * @throws ValueError
+     */
+    public function __construct(private readonly int $value)
+    {
+        $this->validate();
+    }
+
+    /**
+     * @throws ValueError
+     */
+    public function __wakeup(): void
+    {
+        $this->validate();
+    }
+
+    private function validate(): void
+    {
+        if ($this->value < 0) {
+            throw new ValueError(
+                sprintf(
+                    'Provided integer must be positive. (%s given)',
+                    $this->value
+                ),
+            );
+        }
+    }
+
+    public function getValue(): int
+    {
+        return $this->value;
+    }
+
+    public function  equals(PositiveInteger $positiveInteger): bool
+    {
+        return $this->value === $positiveInteger->getValue();
+    }
+}