implemented PHP 8 constructor property promotion

Author: dg

readme.md

@@ -128,6 +128,25 @@ final protected function count(array &$items = []): ?int
 }
 ```
 
+Promoted parameters introduced by PHP 8.0 can be passed to the constructor:
+
+```php
+$method = $class->addMethod('__construct');
+$method->addPromotedParameter('name');
+$method->addPromotedParameter('args', [])
+		->setPrivate();
+```
+
+It results in:
+
+```php
+public function __construct(
+	public $name,
+	private $args = [],
+) {
+}
+```
+
 If the 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

@@ -46,7 +46,10 @@ public function fromClassReflection(\ReflectionClass $from, bool $withBodies = f
 		}
 		$props = $methods = $consts = [];
 		foreach ($from->getProperties() as $prop) {
-			if ($prop->isDefault() && $prop->getDeclaringClass()->name === $from->name) {
+			if ($prop->isDefault()
+				&& $prop->getDeclaringClass()->name === $from->name
+				&& (PHP_VERSION_ID < 80000 || !$prop->isPromoted())
+			) {
 				$props[] = $this->fromPropertyReflection($prop);
 			}
 		}
@@ -135,7 +138,9 @@ public function fromCallable(callable $from)
 
 	public function fromParameterReflection(\ReflectionParameter $from): Parameter
 	{
-		$param = new Parameter($from->name);
+		$param = PHP_VERSION_ID >= 80000 && $from->isPromoted()
+			? new PromotedParameter($from->name)
+			: new Parameter($from->name);
 		$param->setReference($from->isPassedByReference());
 		$param->setType($from->getType() instanceof \ReflectionNamedType ? $from->getType()->getName() : null);
 		$param->setNullable($from->hasType() && $from->getType()->allowsNull());

src/PhpGenerator/Method.php

@@ -119,6 +119,19 @@ public function isAbstract(): bool
 	}
 
 
+	/**
+	 * @param  string  $name without $
+	 */
+	public function addPromotedParameter(string $name, $defaultValue = null): PromotedParameter
+	{
+		$param = new PromotedParameter($name);
+		if (func_num_args() > 1) {
+			$param->setDefaultValue($defaultValue);
+		}
+		return $this->parameters[$name] = $param;
+	}
+
+
 	/** @throws Nette\InvalidStateException */
 	public function validate(): void
 	{

src/PhpGenerator/Parameter.php

@@ -13,11 +13,11 @@
 
 
 /**
- * Method parameter description.
+ * Function/Method parameter description.
  *
  * @property mixed $defaultValue
  */
-final class Parameter
+class Parameter
 {
 	use Nette\SmartObject;
 	use Traits\NameAware;

src/PhpGenerator/Printer.php

@@ -251,19 +251,29 @@ public function printParameters($function, PhpNamespace $namespace = null): stri
 	{
 		$params = [];
 		$list = $function->getParameters();
+		$special = false;
+
 		foreach ($list as $param) {
 			$variadic = $function->isVariadic() && $param === end($list);
 			$type = $param->getType();
-			$params[] = ltrim($this->printType($type, $param->isNullable(), $namespace) . ' ')
+			$promoted = $param instanceof PromotedParameter ? $param : null;
+			$params[] =
+				($promoted ? Helpers::formatDocComment((string) $promoted->getComment()) : '')
+				. ($promoted ? ($promoted->getVisibility() ?: 'public') . ' ' : '')
+				. ltrim($this->printType($type, $param->isNullable(), $namespace) . ' ')
 				. ($param->isReference() ? '&' : '')
 				. ($variadic ? '...' : '')
 				. '$' . $param->getName()
 				. ($param->hasDefaultValue() && !$variadic ? ' = ' . $this->dump($param->getDefaultValue()) : '');
+
+			$special = $special || $promoted;
 		}
 
-		return strlen($tmp = implode(', ', $params)) > (new Dumper)->wrapLength && count($params) > 1
-			? "(\n" . $this->indentation . implode(",\n" . $this->indentation, $params) . "\n)"
-			: "($tmp)";
+		$line = implode(', ', $params);
+
+		return count($params) > 1 && ($special || strlen($line) > (new Dumper)->wrapLength)
+			? "(\n" . $this->indent(implode(",\n", $params)) . "\n)"
+			: "($line)";
 	}
 
 

src/PhpGenerator/PromotedParameter.php

@@ -0,0 +1,20 @@
+<?php
+
+/**
+ * This file is part of the Nette Framework (https://nette.org)
+ * Copyright (c) 2004 David Grudl (https://davidgrudl.com)
+ */
+
+declare(strict_types=1);
+
+namespace Nette\PhpGenerator;
+
+
+/**
+ * Promoted parameter in constructor.
+ */
+final class PromotedParameter extends Parameter
+{
+	use Traits\VisibilityAware;
+	use Traits\CommentAware;
+}

tests/PhpGenerator/ClassType.from.80.phpt

@@ -0,0 +1,17 @@
+<?php
+
+/**
+ * @phpVersion 8.0
+ */
+
+declare(strict_types=1);
+
+use Nette\PhpGenerator\ClassType;
+
+
+require __DIR__ . '/../bootstrap.php';
+require __DIR__ . '/fixtures/classes.php80';
+
+$res[] = ClassType::from(new Abc\Class8(null));
+
+sameFile(__DIR__ . '/expected/ClassType.from.80.expect', implode("\n", $res));

tests/PhpGenerator/ClassType.promotion.phpt

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+use Nette\PhpGenerator\ClassType;
+
+
+require __DIR__ . '/../bootstrap.php';
+
+
+$class = new ClassType('Example');
+$method = $class->addMethod('__construct');
+$method->addParameter('a');
+$method->addPromotedParameter('b');
+$method->addPromotedParameter('c')
+	->setPrivate()
+	->setType('string')
+	->addComment('promo');
+
+sameFile(__DIR__ . '/expected/ClassType.promotion.expect', (string) $class);

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

@@ -0,0 +1,9 @@
+class Class8
+{
+	public function __construct(
+		public $a,
+		public int $b = 10,
+		$c = null
+	) {
+	}
+}

tests/PhpGenerator/expected/ClassType.promotion.expect

@@ -0,0 +1,10 @@
+class Example
+{
+	public function __construct(
+		$a,
+		public $b,
+		/** promo */
+		private string $c
+	) {
+	}
+}