added support for readonly properties

Author: dg

readme.md

@@ -160,7 +160,11 @@ public function __construct(
 }
 ```
 
-If the property, constant, method or parameter already exist, it will be overwritten.
+Readonly properties introduced by PHP 8.1 can be marked via `setReadOnly()`.
+
+------
+
+If the added property, constant, method or parameter already exist, it will be overwritten.
 
 Members can be removed using `removeProperty()`, `removeConstant()`, `removeMethod()` or `removeParameter()`.
 

src/PhpGenerator/Factory.php

@@ -244,6 +244,7 @@ public function fromPropertyReflection(\ReflectionProperty $from): Property
 				$prop->setType((string) $from->getType());
 			}
 			$prop->setInitialized($from->hasType() && array_key_exists($prop->getName(), $defaults));
+			$prop->setReadOnly(PHP_VERSION_ID >= 80100 ? $from->isReadOnly() : false);
 		} else {
 			$prop->setInitialized(false);
 		}

src/PhpGenerator/Printer.php

@@ -152,7 +152,10 @@ public function printClass(ClassType $class, PhpNamespace $namespace = null): st
 		$properties = [];
 		foreach ($class->getProperties() as $property) {
 			$type = $property->getType();
-			$def = (($property->getVisibility() ?: 'public') . ($property->isStatic() ? ' static' : '') . ' '
+			$def = (($property->getVisibility() ?: 'public')
+				. ($property->isStatic() ? ' static' : '')
+				. ($property->isReadOnly() && $type ? ' readonly' : '')
+				. ' '
 				. ltrim($this->printType($type, $property->isNullable(), $namespace) . ' ')
 				. '$' . $property->getName());
 
@@ -286,7 +289,10 @@ public function printParameters($function, PhpNamespace $namespace = null, int $
 			$params[] =
 				($promoted ? Helpers::formatDocComment((string) $promoted->getComment()) : '')
 				. ($attrs = self::printAttributes($param->getAttributes(), $namespace, true))
-				. ($promoted ? ($promoted->getVisibility() ?: 'public') . ' ' : '')
+				. ($promoted ?
+					($promoted->getVisibility() ?: 'public')
+					. ($promoted->isReadOnly() && $type ? ' readonly' : '')
+					. ' ' : '')
 				. ltrim($this->printType($type, $param->isNullable(), $namespace) . ' ')
 				. ($param->isReference() ? '&' : '')
 				. ($variadic ? '...' : '')

src/PhpGenerator/PromotedParameter.php

@@ -17,4 +17,21 @@ final class PromotedParameter extends Parameter
 {
 	use Traits\VisibilityAware;
 	use Traits\CommentAware;
+
+	/** @var bool */
+	private $readOnly = false;
+
+
+	/** @return static */
+	public function setReadOnly(bool $state = true): self
+	{
+		$this->readOnly = $state;
+		return $this;
+	}
+
+
+	public function isReadOnly(): bool
+	{
+		return $this->readOnly;
+	}
 }

src/PhpGenerator/Property.php

@@ -40,6 +40,9 @@ final class Property
 	/** @var bool */
 	private $initialized = false;
 
+	/** @var bool */
+	private $readOnly = false;
+
 
 	/** @return static */
 	public function setValue($val): self
@@ -114,4 +117,18 @@ public function isInitialized(): bool
 	{
 		return $this->initialized || $this->value !== null;
 	}
+
+
+	/** @return static */
+	public function setReadOnly(bool $state = true): self
+	{
+		$this->readOnly = $state;
+		return $this;
+	}
+
+
+	public function isReadOnly(): bool
+	{
+		return $this->readOnly;
+	}
 }

tests/PhpGenerator/ClassType.phpt

@@ -58,7 +58,8 @@ $class->addProperty('order')
 	->setValue(new Literal('RecursiveIteratorIterator::SELF_FIRST'));
 
 $class->addProperty('typed1')
-	->setType(Type::ARRAY);
+	->setType(Type::ARRAY)
+	->setReadOnly();
 
 $class->addProperty('typed2')
 	->setType(Type::ARRAY)

tests/PhpGenerator/ClassType.promotion.phpt

@@ -3,6 +3,7 @@
 declare(strict_types=1);
 
 use Nette\PhpGenerator\ClassType;
+use Nette\PhpGenerator\Literal;
 
 
 require __DIR__ . '/../bootstrap.php';
@@ -18,4 +19,8 @@ $method->addPromotedParameter('c')
 	->addComment('promo')
 	->addAttribute('Example');
 
+$method->addPromotedParameter('d', new Literal('new Draft'))
+	->setType('Draft')
+	->setReadOnly();
+
 sameFile(__DIR__ . '/expected/ClassType.promotion.expect', (string) $class);

tests/PhpGenerator/expected/ClassType.expect

@@ -20,7 +20,7 @@ abstract class Example extends ParentClass implements IExample, IOne
 	/** @var resource  orignal file handle */
 	private $handle;
 	public $order = RecursiveIteratorIterator::SELF_FIRST;
-	public array $typed1;
+	public readonly array $typed1;
 	public ?array $typed2 = null;
 	public array $typed3 = null;
 	public static $sections = ['first' => true];

tests/PhpGenerator/expected/ClassType.from.81.expect

@@ -1,6 +1,7 @@
 class Class11
 {
 	public Foo&Bar $foo;
+	public readonly array $ro;
 
 
 	public function foo(Foo&Bar $c): Foo&Bar

tests/PhpGenerator/expected/ClassType.promotion.expect

@@ -5,6 +5,7 @@ class Example
 		public $b,
 		/** promo */
 		#[Example] private string $c,
+		public readonly Draft $d = new Draft,
 	) {
 	}
 }