Add readOnly property modifier

Author: wol-soft

src/Model/Property/Property.php

@@ -25,6 +25,8 @@ class Property implements PropertyInterface
     protected $type = 'null';
     /** @var bool */
     protected $isPropertyRequired = true;
+    /** @var bool */
+    protected $isPropertyReadOnly = false;
     /** @var string */
     protected $description = '';
     /** @var mixed */
@@ -262,6 +264,17 @@ function ($element) {
     public function setRequired(bool $isPropertyRequired): PropertyInterface
     {
         $this->isPropertyRequired = $isPropertyRequired;
+
+        return $this;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function setReadOnly(bool $isPropertyReadOnly): PropertyInterface
+    {
+        $this->isPropertyReadOnly = $isPropertyReadOnly;
+
         return $this;
     }
 
@@ -291,6 +304,14 @@ public function isRequired(): bool
         return $this->isPropertyRequired;
     }
 
+    /**
+     * @inheritdoc
+     */
+    public function isReadOnly(): bool
+    {
+        return $this->isPropertyReadOnly;
+    }
+
     /**
      * @inheritdoc
      */

src/Model/Property/PropertyInterface.php

@@ -140,6 +140,13 @@ public function hasDecorators(): bool;
      */
     public function setRequired(bool $isPropertyRequired): PropertyInterface;
 
+    /**
+     * @param bool $isPropertyReadOnly
+     *
+     * @return PropertyInterface
+     */
+    public function setReadOnly(bool $isPropertyReadOnly): PropertyInterface;
+
     /**
      * @param mixed $defaultValue
      *
@@ -157,6 +164,11 @@ public function getDefaultValue();
      */
     public function isRequired(): bool;
 
+    /**
+     * @return bool
+     */
+    public function isReadOnly(): bool;
+
     /**
      * Set a nested schema
      *

src/Model/Property/PropertyProxy.php

@@ -196,6 +196,22 @@ public function isRequired(): bool
         return $this->getProperty()->isRequired();
     }
 
+    /**
+     * @inheritdoc
+     */
+    public function setReadOnly(bool $isPropertyReadOnly): PropertyInterface
+    {
+        return $this->getProperty()->setReadOnly($isPropertyReadOnly);
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function isReadOnly(): bool
+    {
+        return $this->getProperty()->isReadOnly();
+    }
+
     /**
      * @inheritdoc
      */

src/PropertyProcessor/Property/AbstractValueProcessor.php

@@ -4,6 +4,7 @@
 
 namespace PHPModelGenerator\PropertyProcessor\Property;
 
+use PHPModelGenerator\Exception\SchemaException;
 use PHPModelGenerator\Model\Property\Property;
 use PHPModelGenerator\Model\Property\PropertyInterface;
 use PHPModelGenerator\Model\Schema;
@@ -39,12 +40,18 @@ public function __construct(
 
     /**
      * @inheritdoc
+     *
+     * @throws SchemaException
      */
     public function process(string $propertyName, array $propertyData): PropertyInterface
     {
         $property = (new Property($propertyName, $this->type))
             ->setDescription($propertyData['description'] ?? '')
-            ->setRequired($this->propertyCollectionProcessor->isAttributeRequired($propertyName));
+            ->setRequired($this->propertyCollectionProcessor->isAttributeRequired($propertyName))
+            ->setReadOnly(
+                (isset($propertyData['readOnly']) && $propertyData['readOnly'] === true) ||
+                $this->schemaProcessor->getGeneratorConfiguration()->isImmutable()
+            );
 
         $this->generateValidators($property, $propertyData);
 

src/Templates/Model.phptpl

@@ -103,7 +103,7 @@ class {{ class }}
             return $this->{{ property.getAttribute() }};
         }
 
-        {% if not generatorConfiguration.isImmutable() %}
+        {% if not property.isReadOnly() %}
             /**
              * Set the value of {{ property.getName() }}.
              *

tests/Basic/BasicSchemaGenerationTest.php

@@ -39,6 +39,22 @@ public function testImmutableGeneratorDoesntGenerateSetter(): void
         $this->assertNull($object->getProperty());
     }
 
+    public function testReadOnlyPropertyDoesntGenerateSetter(): void
+    {
+        $className = $this->generateClassFromFile('ReadOnly.json');
+
+        $object = new $className([]);
+
+        $this->assertTrue(is_callable([$object, 'getReadOnlyTrue']));
+        $this->assertFalse(is_callable([$object, 'setReadOnlyTrue']));
+
+        $this->assertTrue(is_callable([$object, 'getReadOnlyFalse']));
+        $this->assertTrue(is_callable([$object, 'setReadOnlyFalse']));
+
+        $this->assertTrue(is_callable([$object, 'getNoReadOnly']));
+        $this->assertTrue(is_callable([$object, 'setNoReadOnly']));
+    }
+
     public function testSetterChangeTheInternalState(): void
     {
         $className = $this->generateClassFromFile('BasicSchema.json');

tests/Schema/BasicSchemaGenerationTest/ReadOnly.json

@@ -0,0 +1,16 @@
+{
+  "type": "object",
+  "properties": {
+    "readOnlyTrue": {
+      "type": "string",
+      "readOnly": true
+    },
+    "readOnlyFalse": {
+      "type": "string",
+      "readOnly": false
+    },
+    "noReadOnly": {
+      "type": "string"
+    }
+  }
+}