Implementation draft for advanced filter logic

 * Add support for filters which modify the internal type of a property (eg. transforming a string into an object). The modified type will be reflected into the generated Model (eg. the getter for a former string property may return a object now if the property was transformed by a filter)
 * Add support for filter options which may be defined in the JSON-Schema and passed through into the filter
 * Added additional builtin filter dateTime (transforms a string into a DateTime object)

Cleaned up some namespace quirks

Author: wol-soft

composer.json

@@ -12,7 +12,7 @@
     ],
     "require": {
         "symplify/easy-coding-standard": "^7.2.3",
-        "wol-soft/php-json-schema-model-generator-production": "0.7.0",
+        "wol-soft/php-json-schema-model-generator-production": "dev-AdvancedFilter",
         "wol-soft/php-micro-template": "^1.3.1",
 
         "php": ">=7.2",

docs/source/nonStandardExtensions/filter.rst

@@ -23,6 +23,31 @@ Filters can be either supplied as a string or as a list of filters (multiple fil
         }
     }
 
+If a list is used filters may include additional option parameters. In this case a single filter must be provided as an object with the key **filter** defining the filter:
+
+.. code-block:: json
+
+    {
+        "type": "object",
+        "properties": {
+            "created": {
+                "type": "string",
+                "filter": [
+                    {
+                        "filter": "dateTime",
+                        "denyEmptyValue": true
+                    }
+                ]
+            }
+        }
+    }
+
+.. warning::
+
+    Filters may change the type of the property. For example the builtin filter **dateTime** creates a DateTime object. Consequently further validations like pattern checks for the string property won't be performed.
+
+    The return type of the last applied filter will be used to define the type of the property inside the generated model (in the example given above the method **getCreated** will return a DateTime object).
+
 Builtin filter
 --------------
 
@@ -62,14 +87,69 @@ Let's have a look how the generated model behaves:
     // the raw model data input is not affected by the filter
     $person->getRawModelDataInput(); // returns ['name' => '   Albert ']
 
-    // If setters are generated the setters also perform validations.
+    // If setters are generated the setters also execute the filter and perform validations.
     // Exception: 'Value for name must not be shorter than 2'
     $person->setName('  D ');
 
 If the filter trim is used for a property which doesn't require a string value and a non string value is provided an exception will be thrown:
 
 * Filter trim is not compatible with property type __TYPE__ for property __PROPERTY_NAME__
 
+dateTime
+^^^^^^^^
+
+The dateTime filter is only valid for string properties.
+
+.. code-block:: json
+
+    {
+        "$id": "car",
+        "type": "object",
+        "properties": {
+            "productionDate": {
+                "type": "string",
+                "filter": "dateTime"
+            }
+        }
+    }
+
+.. warning::
+
+    The dateTime filter modifies the type of your property
+
+Generated interface:
+
+.. code-block:: php
+
+    public function setProductionDate(?string $productionDate): self;
+    public function getProductionDate(): ?DateTime;
+
+Let's have a look how the generated model behaves:
+
+.. code-block:: php
+
+    // valid, the name will be NULL as the productionDate is not required
+    $person = new Car([]);
+
+    // Throws an exception as the provided value is not valid for the DateTime constructor
+    $person = new Car(['productionDate' => 'Hello']);
+
+    // A valid example
+    $person = new Car(['productionDate' => '2020-10-10']);
+    $person->productionDate(); // returns a DateTime object
+    // the raw model data input is not affected by the filter
+    $person->getRawModelDataInput(); // returns ['productionDate' => '2020-10-10']
+
+Additional options
+~~~~~~~~~~~~~~~~~~
+
+================ ============= ===========
+Option           Default value Description
+================ ============= ===========
+convertNullToNow false         If null is provided a DateTime object with the current time will be created (works only if the property isn't required as null would be denied otherwise before the filter is executed)
+denyEmptyValue   false         An empty string value will be denied (by default an empty string value will result in a DateTime object with the current time)
+================ ============= ===========
+
 Custom filter
 -------------
 
@@ -83,7 +163,7 @@ You can implement custom filter and use them in your schema files. You must add
     );
 
 Your filter must implement the interface **PHPModelGenerator\\PropertyProcessor\\Filter\\FilterInterface**. Make sure the given callable array returned by **getFilter** is accessible as well during the generation process as during code execution using the generated model.
-The callable filter method must be a static method. Internally it will be called via *call_user_func*. A custom filter may look like:
+The callable filter method must be a static method. Internally it will be called via *call_user_func_array*. A custom filter may look like:
 
 .. code-block:: php
 
@@ -138,3 +218,41 @@ If the custom filter is added to the generator configuration you can now use the
 
     $person = new Person(['name' => '   Albert ']);
     $person->getName(); // returns 'ALBERT'
+
+Accessing additional filter options
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Filters may handle additional configuration options like the builtin dateTime-filter. The options will be passed as an array as the second argument of your filter function. Let's assume you want to add additional options to your uppercase-filter you'd add the options parameter to your static filter implementation:
+
+.. code-block:: php
+
+    public static function uppercase(?string $value, array $options): ?string
+    {
+        // do something with a custom option
+        if ($options['onlyVocals'] ?? false) {
+            // uppercase only the vocals of the provided value
+        }
+
+        // ... default implementation
+    }
+
+The option will be available if your JSON-Schema uses the object-notation for the filter:
+
+.. code-block:: json
+
+    {
+        "$id": "person",
+        "type": "object",
+        "properties": {
+            "name": {
+                "type": "string",
+                "filter": [
+                    {
+                        "filter": "uppercase",
+                        "onlyVocals": true
+                    },
+                    "trim"
+                ]
+            }
+        }
+    }

src/Model/GeneratorConfiguration.php

@@ -5,6 +5,7 @@
 namespace PHPModelGenerator\Model;
 
 use PHPModelGenerator\Exception\InvalidFilterException;
+use PHPModelGenerator\PropertyProcessor\Filter\DateTimeFilter;
 use PHPModelGenerator\PropertyProcessor\Filter\FilterInterface;
 use PHPModelGenerator\PropertyProcessor\Filter\TrimFilter;
 use PHPModelGenerator\Utils\ClassNameGenerator;
@@ -47,7 +48,9 @@ public function __construct()
     {
         $this->classNameGenerator = new ClassNameGenerator();
 
-        $this->addFilter(new TrimFilter());
+        $this
+            ->addFilter(new DateTimeFilter())
+            ->addFilter(new TrimFilter());
     }
 
     /**

src/Model/Property/Property.php

@@ -24,6 +24,8 @@ class Property implements PropertyInterface
     protected $attribute = '';
     /** @var string */
     protected $type = 'null';
+    /** @var string|null */
+    protected $outputType = null;
     /** @var bool */
     protected $isPropertyRequired = true;
     /** @var bool */
@@ -78,27 +80,28 @@ public function getAttribute(): string
     /**
      * @inheritdoc
      */
-    public function getType(): string
+    public function getType(bool $outputType = false): string
     {
-        return $this->type;
+        return $outputType && $this->outputType !== null ? $this->outputType : $this->type;
     }
 
     /**
      * @inheritdoc
      */
-    public function setType(string $type): PropertyInterface
+    public function setType(string $type, ?string $outputType = null): PropertyInterface
     {
         $this->type = $type;
+        $this->outputType = $outputType;
 
         return $this;
     }
 
     /**
      * @inheritdoc
      */
-    public function getTypeHint(): string
+    public function getTypeHint(bool $outputType = false): string
     {
-        $input = $this->type;
+        $input = $outputType && $this->outputType !== null ? $this->outputType : $this->type;
 
         foreach ($this->typeHintDecorators as $decorator) {
             $input = $decorator->decorate($input);

src/Model/Property/PropertyInterface.php

@@ -28,21 +28,27 @@ public function getName(): string;
     public function getAttribute(): string;
 
     /**
+     * @param bool $outputType If set to true the output type will be returned (may differ from the base type)
+     *
      * @return string
      */
-    public function getType(): string;
+    public function getType(bool $outputType = false): string;
 
     /**
      * @param string $type
+     * @param string|null $outputType By default the output type will be equal to the base type but due to applied
+     *                                filters the output type may change
      *
      * @return PropertyInterface
      */
-    public function setType(string $type): PropertyInterface;
+    public function setType(string $type, ?string $outputType = null): PropertyInterface;
 
     /**
+     * @param bool $outputType If set to true the output type hint will be returned (may differ from the base type)
+     *
      * @return string
      */
-    public function getTypeHint(): string;
+    public function getTypeHint(bool $outputType = false): string;
 
     /**
      * @param TypeHintDecoratorInterface $typeHintDecorator

src/Model/Property/PropertyProxy.php

@@ -63,25 +63,25 @@ public function getAttribute(): string
     /**
      * @inheritdoc
      */
-    public function getType(): string
+    public function getType(bool $outputType = false): string
     {
-        return $this->getProperty()->getType();
+        return $this->getProperty()->getType($outputType);
     }
 
     /**
      * @inheritdoc
      */
-    public function setType(string $type): PropertyInterface
+    public function setType(string $type, ?string $outputType = null): PropertyInterface
     {
-        return $this->getProperty()->setType($type);
+        return $this->getProperty()->setType($type, $outputType);
     }
 
     /**
      * @inheritdoc
      */
-    public function getTypeHint(): string
+    public function getTypeHint(bool $outputType = false): string
     {
-        return $this->getProperty()->getTypeHint();
+        return $this->getProperty()->getTypeHint($outputType);
     }
 
     /**

src/Model/RenderJob.php

@@ -72,7 +72,7 @@ public function render(string $destination, GeneratorConfiguration $generatorCon
         }
 
         if ($generatorConfiguration->isOutputEnabled()) {
-            echo "Rendered class {$generatorConfiguration->getNamespacePrefix()}$this->classPath\\$this->className\n";
+            echo "Rendered class {$generatorConfiguration->getNamespacePrefix()}\\$this->classPath\\$this->className\n";
         }
     }
 
@@ -107,24 +107,20 @@ protected function generateModelDirectory(string $destination, string $classPath
      */
     protected function renderClass(GeneratorConfiguration $generatorConfiguration): string
     {
-        $getFullNamespace = function (string $classPath) use ($generatorConfiguration): string {
-            return trim($generatorConfiguration->getNamespacePrefix() . $classPath, '\\');
-        };
-
-        $render = new Render(__DIR__ . "/../Templates/");
-        $namespace = $getFullNamespace($this->classPath);
+        $render = new Render(__DIR__ . '/../Templates/');
+        $namespace = trim(join('\\', [$generatorConfiguration->getNamespacePrefix(), $this->classPath]), '\\');
 
         $use = array_merge(
-            array_map($getFullNamespace, $this->schema->getUsedClasses()),
+            $this->schema->getUsedClasses(),
             $generatorConfiguration->collectErrors()
                 ? [$generatorConfiguration->getErrorRegistryClass()]
                 : [$generatorConfiguration->getExceptionClass()]
         );
 
-        // TODO: filter out uses in the same namespace
-        // filter out non-compound namespaces
-        $use = array_filter($use, function ($classPath) {
-            return strstr($classPath, '\\');
+        // filter out non-compound uses and uses which link to the current namespace
+        $use = array_filter($use, function ($classPath) use ($namespace) {
+            return strstr(str_replace($namespace, '', $classPath), '\\') ||
+                (!strstr($classPath, '\\') && !empty($namespace));
         });
 
         try {
@@ -139,6 +135,8 @@ protected function renderClass(GeneratorConfiguration $generatorConfiguration):
                     'generatorConfiguration' => $generatorConfiguration,
                     'viewHelper'             => new RenderHelper($generatorConfiguration),
                     'initialClass'           => $this->initialClass,
+                    // one hack a day keeps the problems away. Make true literal available for the templating. Easy fix
+                    'true'                   => true,
                 ]
             );
         } catch (PHPMicroTemplateException $exception) {

src/Model/Schema.php

@@ -159,7 +159,7 @@ public function getSchemaDictionary(): SchemaDefinitionDictionary
      */
     public function addUsedClass(string $path): self
     {
-        $this->usedClasses[] = $path;
+        $this->usedClasses[] = trim($path, '\\');
 
         return $this;
     }