Merge pull request #19 from wol-soft/SchemaHooks

Schema Hooks

Author: wol-soft

docs/source/generator/postProcessor.rst

@@ -79,6 +79,8 @@ Now let's have a look at the behaviour of the generated model:
 
     If the **PopulatePostProcessor** is added to your model generator the populate method will be added to the model independently of the `immutable setting <../gettingStarted.html#immutable-classes>`__.
 
+The **PopulatePostProcessor** will also resolve all hooks which are applied to setters. Added code will be executed for all properties changed by a populate call.
+
 AdditionalPropertiesAccessorPostProcessor
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
@@ -163,3 +165,15 @@ A custom post processor which adds a custom trait to the generated model (eg. a
 .. hint::
 
     For examples how to implement a custom post processor have a look at the built in post processors located at **src/SchemaProcessor/PostProcessor/**
+
+What can you do inside your custom post processor?
+
+* Add additional traits and interfaces to your models
+* Add additional methods and properties to your models
+* Hook via SchemaHooks into the generated source code and add your snippets at defined places inside the model:
+
+    * Implement the **ConstructorBeforeValidationHookInterface** to add code to the beginning of your constructor
+    * Implement the **ConstructorAfterValidationHookInterface** to add code to the end of your constructor
+    * Implement the **GetterHookInterface** to add code to your getter methods
+    * Implement the **SetterBeforeValidationHookInterface** to add code to the beginning of your setter methods
+    * Implement the **SetterAfterValidationHookInterface** to add code to the end of your setter methods

docs/source/gettingStarted.rst

@@ -147,7 +147,7 @@ Immutable classes
 
     setImmutable(bool $immutable);
 
-If set to true the generated model classes will be delivered without setter methods for the object properties. By default the classes are generated without setter methods.
+If set to true the generated model classes will be delivered without setter methods for the object properties. By default the classes are generated without setter methods. Each setter will validate the provided value and throw either a specific exception or a collection exception depending on the `error collection configuration <#collect-errors-vs-early-return>`__. If all validations pass the internal value will be updated as well as the value which will be returned when `getRawModelDataInput` is called.
 
 .. code-block:: php
 

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;
+}