Added an option to collect all errors before throwing an exception

Decouple from package-exception

Author: Enno Woortmann

src/Exception/ErrorRegistryException.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace PHPModelGenerator\Exception;
+
+use Exception;
+
+/**
+ * Class ErrorRegistryException
+ *
+ * @package PHPModelGenerator\Exception
+ */
+class ErrorRegistryException extends Exception implements ErrorRegistryExceptionInterface
+{
+    protected $errors = [];
+
+    public function addError(string $message): ErrorRegistryExceptionInterface
+    {
+        $this->errors[] = $message;
+        return $this;
+    }
+
+    public function getErrors(): array
+    {
+        return $this->errors;
+    }
+}

src/Exception/ErrorRegistryExceptionInterface.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace PHPModelGenerator\Exception;
+
+use Throwable;
+
+/**
+ * Class ErrorRegistryExceptionInterface
+ *
+ * @package PHPModelGenerator\Exception
+ */
+interface ErrorRegistryExceptionInterface extends Throwable
+{
+    public function addError(string $message): self;
+
+    public function getErrors(): array;
+}

src/Model/GeneratorConfiguration.php

@@ -4,6 +4,9 @@
 
 namespace PHPModelGenerator\Model;
 
+use PHPModelGenerator\Exception\ErrorRegistryException;
+use PHPModelGenerator\Exception\InvalidArgumentException;
+
 /**
  * Class GeneratorConfiguration
  *
@@ -19,6 +22,12 @@ class GeneratorConfiguration
     protected $prettyPrint = true;
     /** @var bool */
     protected $outputEnabled = true;
+    /** @var bool */
+    protected $collectErrors = true;
+    /** @var string */
+    protected $errorRegistryClass = ErrorRegistryException::class;
+    /** @var string */
+    protected $exceptionClass = InvalidArgumentException::class;
 
     /**
      * @return string
@@ -95,4 +104,61 @@ public function isOutputEnabled(): bool
     {
         return $this->outputEnabled;
     }
+
+    /**
+     * @return bool
+     */
+    public function collectErrors(): bool
+    {
+        return $this->collectErrors;
+    }
+
+    /**
+     * @param bool $collectErrors
+     *
+     * @return GeneratorConfiguration
+     */
+    public function setCollectErrors(bool $collectErrors): self
+    {
+        $this->collectErrors = $collectErrors;
+        return $this;
+    }
+
+    /**
+     * @return string
+     */
+    public function getErrorRegistryClass(): string
+    {
+        return $this->errorRegistryClass;
+    }
+
+    /**
+     * @param string $errorRegistryClass
+     *
+     * @return GeneratorConfiguration
+     */
+    public function setErrorRegistryClass(string $errorRegistryClass): self
+    {
+        $this->errorRegistryClass = $errorRegistryClass;
+        return $this;
+    }
+
+    /**
+     * @return string
+     */
+    public function getExceptionClass(): string
+    {
+        return $this->exceptionClass;
+    }
+
+    /**
+     * @param string $exceptionClass
+     *
+     * @return GeneratorConfiguration
+     */
+    public function setExceptionClass(string $exceptionClass): self
+    {
+        $this->exceptionClass = $exceptionClass;
+        return $this;
+    }
 }

src/Model/Property/Property.php

@@ -229,28 +229,6 @@ public function hasDecorators(): bool
         return count($this->decorators) > 0;
     }
 
-    /**
-     * @inheritdoc
-     */
-    public function getExceptionClasses(): array
-    {
-        $use = [];
-
-        foreach ($this->getOrderedValidators() as $validator) {
-            $use[] = $validator->getExceptionClass();
-        }
-
-        foreach ($this->getNestedProperties() as $property) {
-            $use = array_merge($use, $property->getExceptionClasses());
-        }
-
-        foreach ($this->decorators as $decorator) {
-            $use = array_merge($use, $decorator->getExceptionClasses());
-        }
-
-        return $use;
-    }
-
     /**
      * Convert a name of a JSON-field into a valid PHP variable name to be used as class attribute
      *

src/Model/Property/PropertyInterface.php

@@ -133,13 +133,6 @@ public function resolveDecorator(string $input): string;
      */
     public function hasDecorators(): bool;
 
-    /**
-     * Get a list of all required classes
-     *
-     * @return array
-     */
-    public function getExceptionClasses(): array;
-
     /**
      * @param bool $isPropertyRequired
      *

src/Model/Property/PropertyProxy.php

@@ -180,14 +180,6 @@ public function hasDecorators(): bool
         return $this->getProperty()->hasDecorators();
     }
 
-    /**
-     * @inheritdoc
-     */
-    public function getExceptionClasses(): array
-    {
-        return $this->getProperty()->getExceptionClasses();
-    }
-
     /**
      * @inheritdoc
      */

src/Model/RenderJob.php

@@ -99,7 +99,10 @@ protected function renderClass(GeneratorConfiguration $generatorConfiguration):
         $render = new Render(__DIR__ . "/../Templates/");
 
         $namespace = trim($generatorConfiguration->getNamespacePrefix() . $this->classPath, '\\');
-        $use = $this->schema->getUseList(empty($namespace));
+
+        $use = $generatorConfiguration->collectErrors()
+            ? [$generatorConfiguration->getErrorRegistryClass()]
+            : [$generatorConfiguration->getExceptionClass()];
 
         try {
             $class = $render->renderTemplate(
@@ -111,7 +114,7 @@ protected function renderClass(GeneratorConfiguration $generatorConfiguration):
                     'baseValidators'         => $this->schema->getBaseValidators(),
                     'properties'             => $this->schema->getProperties(),
                     'generatorConfiguration' => $generatorConfiguration,
-                    'viewHelper'             => new RenderHelper(),
+                    'viewHelper'             => new RenderHelper($generatorConfiguration),
                 ]
             );
         } catch (PHPMicroTemplateException $exception) {

src/Model/Schema.php

@@ -80,38 +80,6 @@ public function addBaseValidator(PropertyValidatorInterface $baseValidator)
         return $this;
     }
 
-    /**
-     * Extract all required uses for the properties of the schema
-     *
-     * @param bool $skipGlobalNamespace
-     *
-     * @return array
-     */
-    public function getUseList(bool $skipGlobalNamespace): array
-    {
-        $use = [];
-
-        foreach ($this->getBaseValidators() as $validator) {
-            $use[] = $validator->getExceptionClass();
-        }
-
-        foreach ($this->getProperties() as $property) {
-            if (empty($property->getValidators())) {
-                continue;
-            }
-
-            $use = array_merge($use, [Exception::class], $property->getExceptionClasses());
-        }
-
-        if ($skipGlobalNamespace) {
-            $use = array_filter($use, function ($namespace) {
-                return strstr($namespace, '\\');
-            });
-        }
-
-        return $use;
-    }
-
     /**
      * @return SchemaDefinitionDictionary
      */

src/Model/Validator/AbstractPropertyValidator.php

@@ -11,21 +11,9 @@
  */
 abstract class AbstractPropertyValidator implements PropertyValidatorInterface
 {
-    /** @var string */
-    protected $exceptionClass;
     /** @var string */
     protected $exceptionMessage;
 
-    /**
-     * Get the exception class to be thrown if the validation fails
-     *
-     * @return string
-     */
-    public function getExceptionClass(): string
-    {
-        return $this->exceptionClass;
-    }
-
     /**
      * Get the message of the exception which is thrown if the validation fails
      *

src/Model/Validator/ComposedPropertyValidator.php

@@ -4,7 +4,6 @@
 
 namespace PHPModelGenerator\Model\Validator;
 
-use PHPModelGenerator\Exception\InvalidArgumentException;
 use PHPModelGenerator\Model\Property\CompositionPropertyDecorator;
 use PHPModelGenerator\Model\Property\PropertyInterface;
 
@@ -30,7 +29,6 @@ public function __construct(
         array $validatorVariables
     ) {
         parent::__construct(
-            InvalidArgumentException::class,
             "Invalid value for {$property->getName()} declined by composition constraint",
             DIRECTORY_SEPARATOR . 'Validator' . DIRECTORY_SEPARATOR . 'ComposedItem.phptpl',
             $validatorVariables

src/Model/Validator/ConditionalPropertyValidator.php

@@ -4,7 +4,6 @@
 
 namespace PHPModelGenerator\Model\Validator;
 
-use PHPModelGenerator\Exception\InvalidArgumentException;
 use PHPModelGenerator\Model\Property\CompositionPropertyDecorator;
 use PHPModelGenerator\Model\Property\PropertyInterface;
 use PHPModelGenerator\PropertyProcessor\ComposedValue\IfProcessor;
@@ -29,7 +28,6 @@ public function __construct(
         array $validatorVariables
     ) {
         parent::__construct(
-            InvalidArgumentException::class,
             "Invalid value for {$property->getName()} declined by conditional composition constraint",
             DIRECTORY_SEPARATOR . 'Validator' . DIRECTORY_SEPARATOR . 'ConditionalComposedItem.phptpl',
             $validatorVariables

src/Model/Validator/PropertyTemplateValidator.php

@@ -25,18 +25,15 @@ class PropertyTemplateValidator extends AbstractPropertyValidator
     /**
      * PropertyValidator constructor.
      *
-     * @param string $exceptionClass
      * @param string $exceptionMessage
      * @param string $template
      * @param array  $templateValues
      */
     public function __construct(
-        string $exceptionClass,
         string $exceptionMessage,
         string $template,
         array $templateValues
     ) {
-        $this->exceptionClass = $exceptionClass;
         $this->exceptionMessage = $exceptionMessage;
         $this->template = $template;
         $this->templateValues = $templateValues;

src/Model/Validator/PropertyValidator.php

@@ -18,13 +18,11 @@ class PropertyValidator extends AbstractPropertyValidator
      * PropertyValidator constructor.
      *
      * @param string $check
-     * @param string $exceptionClass
      * @param string $exceptionMessage
      */
-    public function __construct(string $check, string $exceptionClass, string $exceptionMessage)
+    public function __construct(string $check, string $exceptionMessage)
     {
         $this->check = $check;
-        $this->exceptionClass = $exceptionClass;
         $this->exceptionMessage = $exceptionMessage;
     }
 

src/Model/Validator/PropertyValidatorInterface.php

@@ -18,13 +18,6 @@ interface PropertyValidatorInterface
      */
     public function getCheck(): string;
 
-    /**
-     * Get the exception class to be thrown if the validation fails
-     *
-     * @return string
-     */
-    public function getExceptionClass(): string;
-
     /**
      * Get the message of the exception which is thrown if the validation fails
      *

src/Model/Validator/RequiredPropertyValidator.php

@@ -4,7 +4,6 @@
 
 namespace PHPModelGenerator\Model\Validator;
 
-use PHPModelGenerator\Exception\InvalidArgumentException;
 use PHPModelGenerator\Model\Property\PropertyInterface;
 
 /**
@@ -23,7 +22,6 @@ public function __construct(PropertyInterface $property)
     {
         parent::__construct(
             "!array_key_exists('{$property->getName()}', \$modelData)",
-            InvalidArgumentException::class,
             "Missing required value for {$property->getName()}"
         );
     }

src/Model/Validator/TypeCheckValidator.php

@@ -4,7 +4,6 @@
 
 namespace PHPModelGenerator\Model\Validator;
 
-use PHPModelGenerator\Exception\InvalidArgumentException;
 use PHPModelGenerator\Model\Property\PropertyInterface;
 
 /**
@@ -24,7 +23,6 @@ public function __construct(string $type, PropertyInterface $property)
     {
             parent::__construct(
                 '!is_' . strtolower($type) . '($value)' . ($property->isRequired() ? '' : ' && $value !== null'),
-                InvalidArgumentException::class,
                 "invalid type for {$property->getName()}"
             );
     }