Add description to properties

Author: wol-soft

src/Model/Property/Property.php

@@ -24,6 +24,8 @@ class Property implements PropertyInterface
     protected $type = 'null';
     /** @var bool */
     protected $isPropertyRequired = true;
+    /** @var string */
+    protected $description = '';
 
     /** @var Validator[] */
     protected $validator = [];
@@ -81,6 +83,24 @@ public function setType(string $type): PropertyInterface
         return $this;
     }
 
+    /**
+     * @inheritdoc
+     */
+    public function getDescription(): string
+    {
+        return $this->description;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function setDescription(string $description): PropertyInterface
+    {
+        $this->description = $description;
+
+        return $this;
+    }
+
     /**
      * @inheritdoc
      */

src/Model/Property/PropertyInterface.php

@@ -38,6 +38,22 @@ public function getType(): string;
      */
     public function setType(string $type): PropertyInterface;
 
+    /**
+     * Get a description for the property. If no description is available an empty string will be returned
+     *
+     * @return string
+     */
+    public function getDescription(): string;
+
+    /**
+     * Set a description for the property
+     *
+     * @param string $description
+     *
+     * @return PropertyInterface
+     */
+    public function setDescription(string $description): PropertyInterface;
+
     /**
      * Add a validator for the property
      *

src/Model/Property/PropertyProxy.php

@@ -75,6 +75,22 @@ public function setType(string $type): PropertyInterface
         return $this->getProperty()->setType($type);
     }
 
+    /**
+     * @inheritdoc
+     */
+    public function getDescription(): string
+    {
+        return $this->getProperty()->getDescription();
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function setDescription(string $description): PropertyInterface
+    {
+        return $this->getProperty()->setDescription($description);
+    }
+
     /**
      * @inheritdoc
      */

src/PropertyProcessor/Property/AbstractPropertyProcessor.php

@@ -5,6 +5,7 @@
 namespace PHPModelGenerator\PropertyProcessor\Property;
 
 use PHPModelGenerator\Exception\InvalidArgumentException;
+use PHPModelGenerator\Exception\SchemaException;
 use PHPModelGenerator\Model\Property\PropertyInterface;
 use PHPModelGenerator\Model\Schema;
 use PHPModelGenerator\Model\Validator\PropertyValidator;
@@ -88,6 +89,8 @@ protected function addEnumValidator(PropertyInterface $property, array $allowedV
     /**
      * @param PropertyInterface $property
      * @param array             $propertyData
+     *
+     * @throws SchemaException
      */
     protected function addComposedValueValidator(PropertyInterface $property, array $propertyData): void
     {

src/PropertyProcessor/Property/AbstractValueProcessor.php

@@ -43,6 +43,7 @@ public function __construct(
     public function process(string $propertyName, array $propertyData): PropertyInterface
     {
         $property = (new Property($propertyName, $this->type))
+            ->setDescription($propertyData['description'] ?? '')
             // the property is either required if defined as required
             // or if the property is related to a typed enum (strict type checks)
             ->setRequired(

src/PropertyProcessor/Property/ConstProcessor.php

@@ -23,6 +23,7 @@ class ConstProcessor implements PropertyProcessorInterface
     public function process(string $propertyName, array $propertyData): PropertyInterface
     {
         return (new Property($propertyName, gettype($propertyData['const'])))
+            ->setDescription($propertyData['description'] ?? '')
             ->addValidator(new PropertyValidator(
                 '$value !== ' . var_export($propertyData['const'], true),
                 InvalidArgumentException::class,

src/Templates/Model.phptpl

@@ -17,7 +17,7 @@ declare(strict_types = 1);
 class {{ class }}
 {
     {% foreach properties as property %}
-        /** @var {% if property.getType() %}{{ property.getType() }}{% else %}mixed{% endif %} */
+        /** @var {% if property.getType() %}{{ property.getType() }}{% else %}mixed{% endif %}{% if property.getDescription() %} {{ property.getDescription() }}{% endif %} */
         protected ${{ property.getAttribute() }};
     {% endforeach %}
     /** @var array */