* Extended array type hints to contain the value of each element (eg. string[]). Especially useful for object auto completion

* Added root node to SchemaDefinitionDictionary to be aple to process references to whole files
* Implemented "null" or no provided value for optional enums
* Extended DocBlocks of generated getter/setter methods
* Fixed external path references for model-files which aren't located in the root directory of the generation process
* Renamed Generator to avoid collisions with built-in Generator
* Added a public method to generate/clean-up the model directory for a generation process
* Removed unused file

Author: wol-soft

README.md

@@ -27,7 +27,7 @@ The base object for generating models is the *Generator*. After you have created
     ->generateModels(__DIR__ . '/schema', __DIR__ . '/result');
 ```
 
-As an optional parameter you can set up a *GeneratorConfiguration* object to configure your Generator:
+As an optional parameter you can set up a *GeneratorConfiguration* object to configure your Generator and/or use the method *generateModelDirectory* to generate your model directory (will generate the directory if it doesn't exist; if it exists, all contained files and folders will be removed for a clean generation process):
 
 ```php
 $generator = new Generator(
@@ -36,7 +36,9 @@ $generator = new Generator(
         ->setImmutable(true)
 );
 
-$generator->generateModels(__DIR__ . '/schema', __DIR__ . '/result');
+$generator
+    ->generateModelDirectory(__DIR__ . '/result');
+    ->generateModels(__DIR__ . '/schema', __DIR__ . '/result');
 ```
 
 The generator will check the given source directory recursive and convert all found *.json files to models. All JSON-Schema files inside the source directory must provide a schema of an object.

src/Model/Property/Property.php

@@ -8,6 +8,7 @@
 use PHPModelGenerator\Model\Validator;
 use PHPModelGenerator\Model\Validator\PropertyValidatorInterface;
 use PHPModelGenerator\PropertyProcessor\Decorator\PropertyDecoratorInterface;
+use PHPModelGenerator\PropertyProcessor\Decorator\TypeHintDecoratorInterface;
 
 /**
  * Class Property
@@ -37,6 +38,8 @@ class Property implements PropertyInterface
     protected $schema;
     /** @var PropertyDecoratorInterface[] */
     public $decorators = [];
+    /** @var TypeHintDecoratorInterface[] */
+    public $typeHintDecorators = [];
 
     /**
      * Property constructor.
@@ -85,6 +88,30 @@ public function setType(string $type): PropertyInterface
         return $this;
     }
 
+    /**
+     * @inheritdoc
+     */
+    public function getTypeHint(): string
+    {
+        $input =  $this->type ?: 'mixed';
+
+        foreach ($this->typeHintDecorators as $decorator) {
+            $input = $decorator->decorate($input);
+        }
+
+        return $input;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function addTypeHintDecorator(TypeHintDecoratorInterface $typeHintDecorator): PropertyInterface
+    {
+        $this->typeHintDecorators[] = $typeHintDecorator;
+
+        return $this;
+    }
+
     /**
      * @inheritdoc
      */

src/Model/Property/PropertyInterface.php

@@ -8,6 +8,7 @@
 use PHPModelGenerator\Model\Validator;
 use PHPModelGenerator\Model\Validator\PropertyValidatorInterface;
 use PHPModelGenerator\PropertyProcessor\Decorator\PropertyDecoratorInterface;
+use PHPModelGenerator\PropertyProcessor\Decorator\TypeHintDecoratorInterface;
 
 /**
  * Interface PropertyInterface
@@ -38,6 +39,18 @@ public function getType(): string;
      */
     public function setType(string $type): PropertyInterface;
 
+    /**
+     * @return string
+     */
+    public function getTypeHint(): string;
+
+    /**
+     * @param TypeHintDecoratorInterface $typeHintDecorator
+     *
+     * @return PropertyInterface
+     */
+    public function addTypeHintDecorator(TypeHintDecoratorInterface $typeHintDecorator): PropertyInterface;
+
     /**
      * Get a description for the property. If no description is available an empty string will be returned
      *

src/Model/Property/PropertyProxy.php

@@ -8,6 +8,7 @@
 use PHPModelGenerator\Model\Schema;
 use PHPModelGenerator\Model\Validator\PropertyValidatorInterface;
 use PHPModelGenerator\PropertyProcessor\Decorator\PropertyDecoratorInterface;
+use PHPModelGenerator\PropertyProcessor\Decorator\TypeHintDecoratorInterface;
 
 /**
  * Class PropertyProxy
@@ -75,6 +76,22 @@ public function setType(string $type): PropertyInterface
         return $this->getProperty()->setType($type);
     }
 
+    /**
+     * @inheritdoc
+     */
+    public function getTypeHint(): string
+    {
+        return $this->getProperty()->getTypeHint();
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function addTypeHintDecorator(TypeHintDecoratorInterface $typeHintDecorator): PropertyInterface
+    {
+        return $this->getProperty()->addTypeHintDecorator($typeHintDecorator);
+    }
+
     /**
      * @inheritdoc
      */

src/Model/SchemaDefinition/SchemaDefinitionDictionary.php

@@ -45,6 +45,9 @@ public function setUpDefinitionDictionary(
         SchemaProcessor $schemaProcessor,
         Schema $schema
     ): void {
+        // attach the root node to the definition dictionary
+        $this->addDefinition('#', new SchemaDefinition($propertyData, $schemaProcessor, $schema));
+
         foreach ($propertyData as $key => $propertyEntry) {
             if (!is_array($propertyEntry)) {
                 continue;
@@ -115,8 +118,13 @@ public function getDefinition(string $key, SchemaProcessor $schemaProcessor, arr
             $key  = array_shift($path);
         }
 
-        if (!isset($this[$key]) && strstr($key, '#', true)) {
-            [$jsonSchemaFile, $externalKey] = explode('#', $key);
+        if (!isset($this[$key])) {
+            if (strstr($key, '#', true)) {
+                [$jsonSchemaFile, $externalKey] = explode('#', $key);
+            } else {
+                $jsonSchemaFile = $key;
+                $externalKey = '';
+            }
 
             if (array_key_exists($jsonSchemaFile, $this->parsedExternalFileSchemas)) {
                 return $this->parsedExternalFileSchemas[$jsonSchemaFile]->getSchemaDictionary()->getDefinition(
@@ -155,7 +163,7 @@ protected function parseExternalFile(
             : $this->sourceDirectory . '/' . $jsonSchemaFile;
 
         if (!filter_var($jsonSchemaFilePath, FILTER_VALIDATE_URL) && !is_file($jsonSchemaFilePath)) {
-            throw new SchemaException("Reference to non existing JSON-Schema file $path");
+            throw new SchemaException("Reference to non existing JSON-Schema file $jsonSchemaFilePath");
         }
 
         $jsonSchema = file_get_contents($jsonSchemaFilePath);

src/Generator.php renamed to src/ModelGenerator.php

@@ -4,6 +4,7 @@
 
 namespace PHPModelGenerator;
 
+use FilesystemIterator;
 use PHPModelGenerator\Exception\FileSystemException;
 use PHPModelGenerator\Exception\RenderException;
 use PHPModelGenerator\Exception\SchemaException;
@@ -16,11 +17,11 @@
 use RegexIterator;
 
 /**
- * Class Generator
+ * Class ModelGenerator
  *
  * @package PHPModelGenerator
  */
-class Generator
+class ModelGenerator
 {
     /** @var GeneratorConfiguration */
     protected $generatorConfiguration;
@@ -35,6 +36,32 @@ public function __construct(GeneratorConfiguration $generatorConfiguration = nul
         $this->generatorConfiguration = $generatorConfiguration ?? new GeneratorConfiguration();
     }
 
+    /**
+     * Create an directory to store the models in. If the directory already exists and contains files all files will be
+     * removed to provide an empty directory for model generation.
+     *
+     * @param string $modelPath     The absolute path to the directory
+     * @param int    $directoryMode The mode to create the directory with
+     *
+     * @return ModelGenerator
+     */
+    public function generateModelDirectory(string $modelPath, int $directoryMode = 0777): self
+    {
+        if (!is_dir($modelPath)) {
+            mkdir($modelPath, $directoryMode, true);
+        }
+
+        $di = new RecursiveDirectoryIterator($modelPath, FilesystemIterator::SKIP_DOTS);
+
+        $ri = new RecursiveIteratorIterator($di, RecursiveIteratorIterator::CHILD_FIRST);
+
+        foreach ($ri as $file ) {
+            $file->isDir() ?  rmdir($file) : unlink($file);
+        }
+
+        return $this;
+    }
+
     /**
      * Generate models from JSON-Schema files. Returns an array of generated file names on success.
      *
@@ -63,7 +90,7 @@ public function generateModels(string $source, string $destination): array
         $schemaProcessor = new SchemaProcessor($source, $destination, $this->generatorConfiguration, $renderProxy);
 
         foreach ($this->getSchemaFiles($source) as $jsonSchemaFile) {
-            $schemaProcessor->process($jsonSchemaFile, $source);
+            $schemaProcessor->process($jsonSchemaFile);
         }
 
         // render all collected classes

src/PropertyProcessor/ComposedValue/AbstractComposedPropertiesProcessor.php

@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace PHPModelGenerator\PropertyProcessor\Decorator;
+
+use PHPModelGenerator\Model\Property\PropertyInterface;
+
+/**
+ * Class ArrayTypeHintDecorator
+ *
+ * @package PHPModelGenerator\PropertyProcessor\Decorator
+ */
+class ArrayTypeHintDecorator implements TypeHintDecoratorInterface
+{
+    /** @var PropertyInterface */
+    protected $nestedProperty;
+
+    /**
+     * ArrayTypeHintDecorator constructor.
+     *
+     * @param PropertyInterface $nestedProperty
+     */
+    public function __construct(PropertyInterface $nestedProperty)
+    {
+        $this->nestedProperty = $nestedProperty;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function decorate(string $input): string
+    {
+        return "{$this->nestedProperty->getTypeHint()}[]";
+    }
+}

src/PropertyProcessor/Decorator/ArrayTypeHintDecorator.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace PHPModelGenerator\PropertyProcessor\Decorator;
+
+/**
+ * Interface TypeHintDecoratorInterface
+ *
+ * @package PHPModelGenerator\PropertyProcessor\Decorator
+ */
+interface TypeHintDecoratorInterface
+{
+    /**
+     * Decorate a given string
+     *
+     * @param string $input The input getting decorated
+     *
+     * @return string
+     */
+    public function decorate(string $input): string;
+}

src/PropertyProcessor/Decorator/TypeHintDecoratorInterface.php

@@ -79,7 +79,7 @@ protected function addEnumValidator(PropertyInterface $property, array $allowedV
         $property->addValidator(
             new PropertyValidator(
                 '!in_array($value, ' .
-                    preg_replace('(\d+\s=>)', '', var_export(array_values($allowedValues), true)) .
+                    preg_replace('(\d+\s=>)', '', var_export(array_merge([null], array_values($allowedValues)), true)) .
                     ', true)',
                 InvalidArgumentException::class,
                 "Invalid value for {$property->getName()} declined by enum constraint"