Add schema hooks to add code to specific locations inside the generated models

Author: wol-soft

src/Model/RenderJob.php

@@ -9,6 +9,7 @@
 use PHPModelGenerator\Exception\FileSystemException;
 use PHPModelGenerator\Exception\RenderException;
 use PHPModelGenerator\Exception\ValidationException;
+use PHPModelGenerator\SchemaProcessor\Hook\SchemaHookResolver;
 use PHPModelGenerator\SchemaProcessor\PostProcessor\PostProcessorInterface;
 use PHPModelGenerator\Utils\RenderHelper;
 
@@ -144,6 +145,7 @@ protected function renderClass(GeneratorConfiguration $generatorConfiguration):
                     'use'                    => 'use ' . join(";\nuse ", array_unique($use)) . ';',
                     'class'                  => $this->className,
                     'schema'                 => $this->schema,
+                    'schemaHookResolver'     => new SchemaHookResolver($this->schema),
                     'generatorConfiguration' => $generatorConfiguration,
                     'viewHelper'             => new RenderHelper($generatorConfiguration),
                     // one hack a day keeps the problems away. Make true literal available for the templating. Easy fix

src/Model/Schema.php

@@ -12,6 +12,7 @@
 use PHPModelGenerator\Model\Validator\PropertyValidatorInterface;
 use PHPModelGenerator\Model\Validator\SchemaDependencyValidator;
 use PHPModelGenerator\PropertyProcessor\Decorator\SchemaNamespaceTransferDecorator;
+use PHPModelGenerator\SchemaProcessor\Hook\SchemaHookInterface;
 
 /**
  * Class Schema
@@ -40,10 +41,12 @@ class Schema
      *                                    before adding properties to the model
      */
     protected $baseValidators = [];
-    /** @var array */
+    /** @var string[] */
     protected $usedClasses = [];
     /** @var SchemaNamespaceTransferDecorator[] */
     protected $namespaceTransferDecorators = [];
+    /** @var SchemaHookInterface[] */
+    protected $schemaHooks = [];
 
     /** @var SchemaDefinitionDictionary */
     protected $schemaDefinitionDictionary;
@@ -200,7 +203,7 @@ public function addNamespaceTransferDecorator(SchemaNamespaceTransferDecorator $
     /**
      * @param Schema[] $visitedSchema
      *
-     * @return array
+     * @return string[]
      */
     public function getUsedClasses(array $visitedSchema = []): array
     {
@@ -244,6 +247,7 @@ public function getTraits(): array
 
     /**
      * @param string $trait
+     *
      * @return Schema
      */
     public function addTrait(string $trait): self
@@ -264,6 +268,7 @@ public function getInterfaces(): array
 
     /**
      * @param string $interface
+     *
      * @return Schema
      */
     public function addInterface(string $interface): self
@@ -273,4 +278,26 @@ public function addInterface(string $interface): self
 
         return $this;
     }
+
+    /**
+     * Add an additional schema hook
+     *
+     * @param SchemaHookInterface $schemaHook
+     *
+     * @return $this
+     */
+    public function addSchemaHook(SchemaHookInterface $schemaHook): self
+    {
+        $this->schemaHooks[] = $schemaHook;
+
+        return $this;
+    }
+
+    /**
+     * @return SchemaHookInterface[]
+     */
+    public function getSchemaHooks(): array
+    {
+        return $this->schemaHooks;
+    }
 }

src/SchemaProcessor/Hook/ConstructorAfterValidationHookInterface.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PHPModelGenerator\SchemaProcessor\Hook;
+
+interface ConstructorAfterValidationHookInterface extends SchemaHookInterface
+{
+    public function getCode(): string;
+}

src/SchemaProcessor/Hook/ConstructorBeforeValidationHookInterface.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PHPModelGenerator\SchemaProcessor\Hook;
+
+interface ConstructorBeforeValidationHookInterface extends SchemaHookInterface
+{
+    public function getCode(): string;
+}

src/SchemaProcessor/Hook/GetterHookInterface.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PHPModelGenerator\SchemaProcessor\Hook;
+
+use PHPModelGenerator\Model\Property\PropertyInterface;
+
+interface GetterHookInterface extends SchemaHookInterface
+{
+    public function getCode(PropertyInterface $property): string;
+}

src/SchemaProcessor/Hook/SchemaHookInterface.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PHPModelGenerator\SchemaProcessor\Hook;
+
+interface SchemaHookInterface
+{
+}

src/SchemaProcessor/Hook/SchemaHookResolver.php

@@ -0,0 +1,74 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PHPModelGenerator\SchemaProcessor\Hook;
+
+use PHPModelGenerator\Model\Property\PropertyInterface;
+use PHPModelGenerator\Model\Schema;
+
+class SchemaHookResolver
+{
+    /** @var Schema */
+    private $schema;
+
+    public function __construct(Schema $schema)
+    {
+        $this->schema = $schema;
+    }
+
+    public function resolveConstructorBeforeValidationHook(): string
+    {
+        return $this->resolveHook(ConstructorBeforeValidationHookInterface::class);
+    }
+
+    public function resolveConstructorAfterValidationHook(): string
+    {
+        return $this->resolveHook(ConstructorAfterValidationHookInterface::class);
+    }
+
+    public function resolveGetterHook(PropertyInterface $property): string
+    {
+        return $this->resolveHookWithProperty(GetterHookInterface::class, $property);
+    }
+
+    public function resolveSetterBeforeValidationHook(PropertyInterface $property): string
+    {
+        return $this->resolveHookWithProperty(SetterBeforeValidationHookInterface::class, $property);
+    }
+
+    public function resolveSetterAfterValidationHook(PropertyInterface $property): string
+    {
+        return $this->resolveHookWithProperty(SetterAfterValidationHookInterface::class, $property);
+    }
+
+    private function getHooks(string $filterHook): array
+    {
+        return array_filter(
+            $this->schema->getSchemaHooks(),
+            function (SchemaHookInterface $hook) use ($filterHook): bool {
+                return is_a($hook, $filterHook);
+            }
+        );
+    }
+
+    private function resolveHook(string $filterHook): string
+    {
+        return join(
+            "\n\n",
+            array_map(function ($hook): string {
+                return $hook->getCode();
+            }, $this->getHooks($filterHook))
+        );
+    }
+
+    private function resolveHookWithProperty(string $filterHook, PropertyInterface $property): string
+    {
+        return join(
+            "\n\n",
+            array_map(function ($hook) use ($property): string {
+                return $hook->getCode($property);
+            }, $this->getHooks($filterHook))
+        );
+    }
+}

src/SchemaProcessor/Hook/SetterAfterValidationHookInterface.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PHPModelGenerator\SchemaProcessor\Hook;
+
+use PHPModelGenerator\Model\Property\PropertyInterface;
+
+interface SetterAfterValidationHookInterface extends SchemaHookInterface
+{
+    public function getCode(PropertyInterface $property): string;
+}

src/SchemaProcessor/Hook/SetterBeforeValidationHookInterface.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PHPModelGenerator\SchemaProcessor\Hook;
+
+use PHPModelGenerator\Model\Property\PropertyInterface;
+
+interface SetterBeforeValidationHookInterface extends SchemaHookInterface
+{
+    public function getCode(PropertyInterface $property): string;
+}

src/Templates/Model.phptpl

@@ -45,6 +45,8 @@ class {{ class }} {% if schema.getInterfaces() %}implements {{ viewHelper.joinCl
             $this->errorRegistry = new {{ viewHelper.getSimpleClassName(generatorConfiguration.getErrorRegistryClass()) }}();
         {% endif %}
 
+        {{ schemaHookResolver.resolveConstructorBeforeValidationHook() }}
+
         {% if schema.getBaseValidators() %}
             $this->executeBaseValidators($modelData);
         {% endif %}
@@ -60,6 +62,8 @@ class {{ class }} {% if schema.getInterfaces() %}implements {{ viewHelper.joinCl
         {% endif %}
 
         $this->rawModelDataInput = $modelData;
+
+        {{ schemaHookResolver.resolveConstructorAfterValidationHook() }}
     }
 
     {% if schema.getBaseValidators() %}
@@ -97,6 +101,8 @@ class {{ class }} {% if schema.getInterfaces() %}implements {{ viewHelper.joinCl
         public function get{{ viewHelper.ucfirst(property.getAttribute()) }}()
             {% if property.getType(true) %}: {% if viewHelper.isPropertyNullable(property) %}?{% endif %}{{ property.getType(true) }}{% endif %}
         {
+            {{ schemaHookResolver.resolveGetterHook(property) }}
+
             return $this->{{ property.getAttribute() }};
         }
 
@@ -113,6 +119,8 @@ class {{ class }} {% if schema.getInterfaces() %}implements {{ viewHelper.joinCl
             public function set{{ viewHelper.ucfirst(property.getAttribute()) }}(
                 {% if property.getType() %}{% if viewHelper.isPropertyNullable(property, true) %}?{% endif %}{{ property.getType() }} {% endif %}${{ property.getAttribute() }}
             ): self {
+                {{ schemaHookResolver.resolveSetterBeforeValidationHook(property) }}
+
                 $value = $modelData['{{ property.getName() }}'] = ${{ property.getAttribute() }};
 
                 {% if generatorConfiguration.collectErrors() %}
@@ -129,6 +137,8 @@ class {{ class }} {% if schema.getInterfaces() %}implements {{ viewHelper.joinCl
 
                 $this->{{ property.getAttribute() }} = $value;
 
+                {{ schemaHookResolver.resolveSetterAfterValidationHook(property) }}
+
                 return $this;
             }
         {% endif %}