Added extended additionalProperties validation

Author: wol-soft

src/Model/Validator/AdditionalPropertiesValidator.php

@@ -0,0 +1,80 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace PHPModelGenerator\Model\Validator;
+
+use PHPMicroTemplate\Exception\FileSystemException;
+use PHPMicroTemplate\Exception\SyntaxErrorException;
+use PHPMicroTemplate\Exception\UndefinedSymbolException;
+use PHPModelGenerator\Exception\SchemaException;
+use PHPModelGenerator\Model\Schema;
+use PHPModelGenerator\PropertyProcessor\PropertyCollectionProcessor;
+use PHPModelGenerator\PropertyProcessor\PropertyFactory;
+use PHPModelGenerator\PropertyProcessor\PropertyProcessorFactory;
+use PHPModelGenerator\SchemaProcessor\SchemaProcessor;
+use PHPModelGenerator\Utils\RenderHelper;
+
+/**
+ * Class AdditionalPropertiesValidator
+ *
+ * @package PHPModelGenerator\Model\Validator
+ */
+class AdditionalPropertiesValidator extends AbstractComposedPropertyValidator
+{
+    /**
+     * AdditionalPropertiesValidator constructor.
+     *
+     * @param SchemaProcessor $schemaProcessor
+     * @param Schema          $schema
+     * @param array           $propertyStructure
+     *
+     * @throws FileSystemException
+     * @throws SchemaException
+     * @throws SyntaxErrorException
+     * @throws UndefinedSymbolException
+     */
+    public function __construct(
+        SchemaProcessor $schemaProcessor,
+        Schema $schema,
+        array $propertyStructure
+    ) {
+        $propertyFactory = new PropertyFactory(new PropertyProcessorFactory());
+
+        $validationProperty = $propertyFactory->create(
+            new PropertyCollectionProcessor(),
+            $schemaProcessor,
+            $schema,
+            'additional property',
+            $propertyStructure['additionalProperties']
+        );
+
+        parent::__construct(
+            $this->getRenderer()->renderTemplate(
+                DIRECTORY_SEPARATOR . 'Exception' . DIRECTORY_SEPARATOR . 'InvalidPropertiesException.phptpl',
+                ['error' => 'Provided JSON contains invalid additional properties.']
+            ),
+            DIRECTORY_SEPARATOR . 'Validator' . DIRECTORY_SEPARATOR . 'AdditionalProperties.phptpl',
+            [
+                'validationProperty'     => $validationProperty,
+                'additionalProperties'   => preg_replace(
+                    '(\d+\s=>)',
+                    '',
+                    var_export(array_keys($propertyStructure['properties'] ?? []), true)
+                ),
+                'generatorConfiguration' => $schemaProcessor->getGeneratorConfiguration(),
+                'viewHelper'             => new RenderHelper($schemaProcessor->getGeneratorConfiguration()),
+            ]
+        );
+    }
+
+    /**
+     * Initialize all variables which are required to execute a property names validator
+     *
+     * @return string
+     */
+    public function getValidatorSetUp(): string
+    {
+        return '$invalidProperties = [];';
+    }
+}

src/Model/Validator/PropertyNamesValidator.php

@@ -49,7 +49,8 @@ public function __construct(
 
         parent::__construct(
             $this->getRenderer()->renderTemplate(
-                DIRECTORY_SEPARATOR . 'Exception' . DIRECTORY_SEPARATOR . 'PropertyNamesException.phptpl'
+                DIRECTORY_SEPARATOR . 'Exception' . DIRECTORY_SEPARATOR . 'InvalidPropertiesException.phptpl',
+                ['error' => 'Provided JSON contains properties with invalid names.']
             ),
             DIRECTORY_SEPARATOR . 'Validator' . DIRECTORY_SEPARATOR . 'PropertyNames.phptpl',
             [

src/PropertyProcessor/Property/BaseProcessor.php

@@ -12,6 +12,7 @@
 use PHPModelGenerator\Model\Property\PropertyInterface;
 use PHPModelGenerator\Model\Validator;
 use PHPModelGenerator\Model\Validator\AbstractComposedPropertyValidator;
+use PHPModelGenerator\Model\Validator\AdditionalPropertiesValidator;
 use PHPModelGenerator\Model\Validator\PropertyNamesValidator;
 use PHPModelGenerator\Model\Validator\PropertyTemplateValidator;
 use PHPModelGenerator\Model\Validator\PropertyValidator;
@@ -92,13 +93,30 @@ protected function addPropertyNamesValidator(array $propertyData): void
      * Add an object validator to disallow properties which are not defined in the schema
      *
      * @param array $propertyData
+     *
+     * @throws FileSystemException
+     * @throws SchemaException
+     * @throws SyntaxErrorException
+     * @throws UndefinedSymbolException
      */
     protected function addAdditionalPropertiesValidator(array $propertyData): void
     {
         if (!isset($propertyData['additionalProperties']) || $propertyData['additionalProperties'] === true) {
             return;
         }
 
+        if (!is_bool($propertyData['additionalProperties'])) {
+            $this->schema->addBaseValidator(
+                new AdditionalPropertiesValidator(
+                    $this->schemaProcessor,
+                    $this->schema,
+                    $propertyData
+                )
+            );
+
+            return;
+        }
+
         $this->schema->addBaseValidator(
             new PropertyValidator(
                 sprintf(

src/Templates/Exception/PropertyNamesException.phptpl renamed to src/Templates/Exception/InvalidPropertiesException.phptpl

@@ -1,4 +1,4 @@
-Provided JSON contains properties with invalid names."
+{{ error }}"
   . (function (array $invalidProperties) {
         $output = '';
         foreach ($invalidProperties as $propertyName => $errors) {

src/Templates/Model.phptpl

@@ -23,15 +23,15 @@ class {{ class }}
         protected ${{ property.getAttribute() }}{% if not viewHelper.isNull(property.getDefaultValue()) %} = {{ property.getDefaultValue() }}{% endif %};
     {% endforeach %}
     /** @var array */
-    protected $rawModelDataInput;
+    private $rawModelDataInput;
 
     {% if generatorConfiguration.collectErrors() %}
         /** @var ErrorRegistryExceptionInterface Collect all validation errors */
-        protected $errorRegistry;
+        private $errorRegistry;
         /** @var bool Store if the current class is the initial class which must throw a collected exception after
          *            the validation process is finished
          */
-        protected $isInitialClass = false;
+        private $isInitialClass = false;
     {% endif %}
 
     /**

src/Templates/Validator/AdditionalProperties.phptpl

@@ -0,0 +1,41 @@
+(function () use ($modelData, &$invalidProperties) {
+    {% if generatorConfiguration.collectErrors() %}
+        $originalErrorRegistry = $this->errorRegistry;
+    {% endif %}
+
+    foreach (array_diff(array_keys($modelData), {{ additionalProperties }}) as $propertyKey) {
+        try {
+            $value = $modelData[$propertyKey];
+
+            {% if generatorConfiguration.collectErrors() %}
+                $this->errorRegistry = new {{ viewHelper.getSimpleClassName(generatorConfiguration.getErrorRegistryClass()) }}();
+            {% endif %}
+
+            {{ viewHelper.resolvePropertyDecorator(validationProperty) }}
+
+            {% foreach validationProperty.getOrderedValidators() as validator %}
+                {{ validator.getValidatorSetUp() }}
+                if ({{ validator.getCheck() }}) {
+                    {{ viewHelper.validationError(validator.getExceptionMessage()) }}
+                }
+            {% endforeach %}
+
+            {% if generatorConfiguration.collectErrors() %}
+                if ($this->errorRegistry->getErrors()) {
+                    $invalidProperties[$propertyKey] = $this->errorRegistry->getErrors();
+                }
+            {% endif %}
+        } catch (\Exception $e) {
+            // collect all errors concerning invalid property names
+            isset($invalidProperties[$propertyKey])
+                ? $invalidProperties[$propertyKey][] = $e->getMessage()
+                : $invalidProperties[$propertyKey] = [$e->getMessage()];
+        }
+    }
+
+    {% if generatorConfiguration.collectErrors() %}
+        $this->errorRegistry = $originalErrorRegistry;
+    {% endif %}
+
+    return !empty($invalidProperties);
+})()