Added DataConfiguration for Validation

Author: Fa-BRAIK

docs/DataConfiguration.md

@@ -38,6 +38,11 @@ DataConfiguration::getInstance([
             BackedEnumSerializer::class,
             ScalarTypeSerializer::class,
         ]
-    ]
+    ],
+    
+    'validation' => [
+        'ruleReferer' => ValidationRulesReferer::class,
+        'validator' => Validator::class,
+    ] 
 ])
 ```

src/Configuration/DataConfiguration.php

@@ -12,6 +12,7 @@ class DataConfiguration implements Configuration
     protected function __construct(
         protected(set) NormalizersConfiguration $normalizers,
         protected(set) SerializersConfiguration $serializers,
+        protected(set) ValidationConfiguration $validation,
     ) {
     }
 
@@ -36,6 +37,10 @@ public static function getInstance(
             serializers: SerializersConfiguration::getInstance(
                 Arr::getArray($config ?? [], 'serializers'),
                 $forceCreate
+            ),
+            validation: ValidationConfiguration::getInstance(
+                Arr::getArray($config ?? [], 'validation'),
+                $forceCreate
             )
         );
     }

src/Configuration/ValidationConfiguration.php

@@ -0,0 +1,64 @@
+<?php
+
+namespace Nuxtifyts\PhpDto\Configuration;
+
+use Nuxtifyts\PhpDto\Exceptions\DataConfigurationException;
+use Nuxtifyts\PhpDto\Support\Arr;
+use Nuxtifyts\PhpDto\Support\Validation\Contracts\DataValidator;
+use Nuxtifyts\PhpDto\Support\Validation\Contracts\RuleReferer;
+use Nuxtifyts\PhpDto\Support\Validation\ValidationRulesReferer;
+use Nuxtifyts\PhpDto\Support\Validation\Validator;
+
+class ValidationConfiguration implements Configuration
+{
+    protected static ?self $instance = null;
+
+    /**
+     * @param class-string<DataValidator> $validatorClass
+     * @param class-string<RuleReferer> $validationRulesRefererClass
+     */
+    protected function __construct(
+        protected(set) string $validatorClass,
+        protected(set) string $validationRulesRefererClass
+    ) {
+    }
+
+    /**
+     * @param ?array<array-key, mixed> $config
+     *
+     * @throws DataConfigurationException
+     */
+    public static function getInstance(
+        ?array $config = null,
+        bool $forceCreate = false
+    ): self {
+        if (self::$instance && !$forceCreate) {
+            return self::$instance;
+        }
+
+        $validatorClass = Arr::getString($config ?? [], 'validator', Validator::class);
+
+        $validationRulesRefererClass = Arr::getString(
+            $config ?? [],
+            'ruleReferer',
+            ValidationRulesReferer::class
+        );
+
+        if (
+            !$validatorClass
+            || !class_exists($validatorClass)
+            || !is_subclass_of($validatorClass, DataValidator::class)
+
+            || !$validationRulesRefererClass
+            || !class_exists($validationRulesRefererClass)
+            || !is_subclass_of($validationRulesRefererClass, RuleReferer::class)
+        ) {
+            throw DataConfigurationException::invalidValidationClasses();
+        }
+
+        return self::$instance = new self(
+            validatorClass: $validatorClass,
+            validationRulesRefererClass: $validationRulesRefererClass
+        );
+    }
+}

src/Contracts/ValidateableData.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace Nuxtifyts\PhpDto\Contracts;
+
+use Nuxtifyts\PhpDto\Exceptions\DataValidationException;
+
+interface ValidateableData
+{
+    /**
+     * @param array<string, mixed> $data
+     *
+     * @throws DataValidationException
+     */
+    public static function validate(array $data): void;
+
+    /**
+     *  @param array<string, mixed> $data
+     *
+     *  @throws DataValidationException
+     */
+    public static function validateAndCreate(array $data): static;
+
+    /**
+     * @return true|array<string, array<string>>
+     */
+    public function isValid(): true|array;
+
+    /**
+     * @param ?array<array-key, mixed> $data
+     *
+     * @return array<string, mixed>
+     */
+    public static function validationRules(?array $data = null): array;
+}

src/Exceptions/DataConfigurationException.php

@@ -9,6 +9,7 @@ class DataConfigurationException extends Exception
     protected const int INVALID_BASE_SERIALIZERS = 10000;
 
     protected const int INVALID_BASE_NORMALIZERS = 20000;
+    protected const int INVALID_VALIDATION_CLASSES = 30000;
 
     public static function invalidBaseSerializers(): self
     {
@@ -19,4 +20,9 @@ public static function invalidBaseNormalizers(): self
     {
         return new self('Invalid base normalizers', self::INVALID_BASE_NORMALIZERS);
     }
+
+    public static function invalidValidationClasses(): self
+    {
+        return new self('Invalid validation classes', self::INVALID_VALIDATION_CLASSES);
+    }
 }

src/Exceptions/DataValidationException.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace Nuxtifyts\PhpDto\Exceptions;
+
+use Exception;
+
+class DataValidationException extends Exception
+{
+}

src/Support/Validation/Contracts/DataValidator.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Nuxtifyts\PhpDto\Support\Validation\Contracts;
+
+use Throwable;
+
+interface DataValidator
+{
+    /**
+     * @param array<array-key, mixed> $value
+     *
+     * @return array<array-key, mixed>
+     *
+     * @throws Throwable
+     */
+    public static function validate(array $value): array;
+}

src/Support/Validation/Contracts/RuleReferer.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Nuxtifyts\PhpDto\Support\Validation\Contracts;
+
+use Nuxtifyts\PhpDto\Contexts\ClassContext;
+use Nuxtifyts\PhpDto\Data;
+
+interface RuleReferer
+{
+    /**
+     * @template T of Data
+     *
+     * @param ClassContext<T> $classContext
+     *
+     * @return list<string>|array<string, mixed>
+     */
+    public static function getRulesFromClassContext(ClassContext $classContext): array;
+}

src/Support/Validation/ValidationRulesReferer.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace Nuxtifyts\PhpDto\Support\Validation;
+
+use Nuxtifyts\PhpDto\Data;
+use Nuxtifyts\PhpDto\Support\Validation\Contracts\RuleReferer;
+use Nuxtifyts\PhpDto\Contexts\ClassContext;
+
+final readonly class ValidationRulesReferer implements RuleReferer
+{
+    /**
+     * @template T of Data
+     *
+     * @param ClassContext<T> $classContext
+     *
+     * @return list<string>|array<string, mixed>
+     */
+    public static function getRulesFromClassContext(ClassContext $classContext): array
+    {
+        return []; // Rule referer should be replaced from config.
+    }
+}

src/Support/Validation/Validator.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace Nuxtifyts\PhpDto\Support\Validation;
+
+use Nuxtifyts\PhpDto\Support\Validation\Contracts\DataValidator;
+
+final readonly class Validator implements DataValidator
+{
+    /**
+     * @param array<array-key, mixed> $value
+     *
+     * @return array<array-key, mixed>
+     *
+     */
+    public static function validate(array $value): array
+    {
+        return $value; // Validator should be replaced from config.
+    }
+}