added support for properties hooks [Closes #171]

Author: shanginn

composer.json

@@ -1,6 +1,6 @@
 {
 	"name": "nette/php-generator",
-	"description": "🐘 Nette PHP Generator: generates neat PHP code for you. Supports new PHP 8.3 features.",
+	"description": "🐘 Nette PHP Generator: generates neat PHP code for you. Supports new PHP 8.4 features.",
 	"keywords": ["nette", "php", "code", "scaffolding"],
 	"homepage": "https://nette.org",
 	"license": ["BSD-3-Clause", "GPL-2.0-only", "GPL-3.0-only"],

readme.md

@@ -8,7 +8,7 @@ Are you looking for a tool to generate PHP code for [classes](#classes), [functi
 
 <h3>
 
-✅ Supports all the latest PHP features like [enums](#enums), [attributes](#attributes), etc.<br>
+✅ Supports all the latest PHP features like [property hooks](#property-hooks), [enums](#enums), [attributes](#attributes), etc.<br>
 ✅ Allows you to easily modify [existing classes](#generating-from-existing-ones)<br>
 ✅ Output compliant with [PSR-12 / PER coding style](#printer-and-psr-compliance)<br>
 ✅ Highly mature, stable, and widely used library
@@ -665,6 +665,42 @@ class Demo
 
  <!---->
 
+Property Hooks
+--------------
+
+You can also define property hooks (represented by the class [PropertyHook](https://api.nette.org/php-generator/master/Nette/PhpGenerator/PropertyHook.html)) for get and set operations, a feature introduced in PHP 8.4:
+
+```php
+$class = new Nette\PhpGenerator\ClassType('Demo');
+$prop = $class->addProperty('firstName')
+    ->setType('string');
+
+$prop->addHook('set', 'strtolower($value)')
+    ->addParameter('value')
+	    ->setType('string');
+
+$prop->addHook('get')
+	->setBody('return ucfirst($this->firstName);');
+
+echo $class;
+```
+
+This generates:
+
+```php
+class Demo
+{
+    public string $firstName {
+        set(string $value) => strtolower($value);
+        get {
+            return ucfirst($this->firstName);
+        }
+    }
+}
+```
+
+ <!---->
+
 Namespace
 ---------
 

src/PhpGenerator/Printer.php

@@ -129,7 +129,7 @@ public function printMethod(Method $method, ?PhpNamespace $namespace = null, boo
 	}
 
 
-	private function printFunctionBody(Closure|GlobalFunction|Method $function): string
+	private function printFunctionBody(Closure|GlobalFunction|Method|PropertyHook $function): string
 	{
 		$code = Helpers::simplifyTaggedNames($function->getBody(), $this->namespace);
 		$code = Strings::normalize($code);
@@ -313,7 +313,7 @@ protected function printUses(PhpNamespace $namespace, string $of = PhpNamespace:
 	}
 
 
-	protected function printParameters(Closure|GlobalFunction|Method $function, int $column = 0): string
+	protected function printParameters(Closure|GlobalFunction|Method|PropertyHook $function, int $column = 0): string
 	{
 		$special = false;
 		foreach ($function->getParameters() as $param) {
@@ -332,13 +332,13 @@ protected function printParameters(Closure|GlobalFunction|Method $function, int
 	}
 
 
-	private function formatParameters(Closure|GlobalFunction|Method $function, bool $multiline): string
+	private function formatParameters(Closure|GlobalFunction|Method|PropertyHook $function, bool $multiline): string
 	{
 		$params = $function->getParameters();
 		$res = '';
 
 		foreach ($params as $param) {
-			$variadic = $function->isVariadic() && $param === end($params);
+			$variadic = !$function instanceof PropertyHook && $function->isVariadic() && $param === end($params);
 			$attrs = $this->printAttributes($param->getAttributes(), inline: true);
 			$res .=
 				$this->printDocComment($param)
@@ -351,6 +351,7 @@ private function formatParameters(Closure|GlobalFunction|Method $function, bool
 				. ($variadic ? '...' : '')
 				. '$' . $param->getName()
 				. ($param->hasDefaultValue() && !$variadic ? ' = ' . $this->dump($param->getDefaultValue()) : '')
+				. ($param instanceof PromotedParameter ? $this->printHooks($param) : '')
 				. ($multiline ? ",\n" : ', ');
 		}
 
@@ -386,13 +387,16 @@ private function printProperty(Property $property, bool $readOnlyClass = false):
 			. ltrim($this->printType($type, $property->isNullable()) . ' ')
 			. '$' . $property->getName());
 
+		$defaultValue = $property->getValue() === null && !$property->isInitialized()
+			? ''
+			: ' = ' . $this->dump($property->getValue(), strlen($def) + 3); // 3 = ' = '
+
 		return $this->printDocComment($property)
 			. $this->printAttributes($property->getAttributes())
 			. $def
-			. ($property->getValue() === null && !$property->isInitialized()
-				? ''
-				: ' = ' . $this->dump($property->getValue(), strlen($def) + 3)) // 3 = ' = '
-			. ";\n";
+			. $defaultValue
+			. ($this->printHooks($property) ?: ';')
+			. "\n";
 	}
 
 
@@ -452,6 +456,30 @@ protected function printAttributes(array $attrs, bool $inline = false): string
 	}
 
 
+	private function printHooks(Property|PromotedParameter $property): string
+	{
+		$hooks = $property->getHooks();
+		if (!$hooks) {
+			return '';
+		}
+
+		foreach ($property->getHooks() as $type => $hook) {
+			$hooks[$type] = $this->printDocComment($hook)
+				. $this->printAttributes($hook->getAttributes())
+				. ($hook->isFinal() ? 'final ' : '')
+				. ($hook->getReturnReference() ? '&' : '')
+				. $type
+				. ($hook->getParameters() ? $this->printParameters($hook) : '')
+				. ' '
+				. ($hook->isShort()
+					? '=> ' . $hook->getBody() . ';'
+					: "{\n" . $this->indent($this->printFunctionBody($hook)) . '}');
+		}
+
+		return " {\n" . $this->indent(implode("\n", $hooks)) . "\n}";
+	}
+
+
 	public function setTypeResolving(bool $state = true): static
 	{
 		$this->resolveTypes = $state;

src/PhpGenerator/PromotedParameter.php

@@ -26,4 +26,10 @@ public function validate(): void
 			throw new Nette\InvalidStateException("Property \${$this->getName()}: Read-only properties are only supported on typed property.");
 		}
 	}
+
+
+	public function __clone(): void
+	{
+		$this->hooks = array_map(fn($item) => $item ? clone $item : $item, $this->hooks);
+	}
 }

src/PhpGenerator/Property.php

@@ -106,4 +106,10 @@ public function validate(): void
 			throw new Nette\InvalidStateException("Property \$$this->name: Read-only properties are only supported on typed property.");
 		}
 	}
+
+
+	public function __clone(): void
+	{
+		$this->hooks = array_map(fn($item) => $item ? clone $item : $item, $this->hooks);
+	}
 }

src/PhpGenerator/PropertyHook.php

@@ -0,0 +1,109 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Nette\PhpGenerator;
+
+use JetBrains\PhpStorm\Language;
+
+
+/**
+ * Definition of a property hook.
+ */
+final class PropertyHook
+{
+	use Traits\AttributeAware;
+	use Traits\CommentAware;
+
+	private string $body = '';
+	private bool $short = false;
+	private bool $final = false;
+
+	/** @var Parameter[] */
+	private array $parameters = [];
+	private bool $returnReference = false;
+
+
+	/** @param  ?mixed[]  $args */
+	public function setBody(
+		#[Language('PHP')]
+		string $code,
+		?array $args = null,
+		bool $short = false,
+	): static
+	{
+		$this->body = $args === null
+			? $code
+			: (new Dumper)->format($code, ...$args);
+		$this->short = $short;
+		return $this;
+	}
+
+
+	public function getBody(): string
+	{
+		return $this->body;
+	}
+
+
+	public function isShort(): bool
+	{
+		return $this->short && trim($this->body) !== '';
+	}
+
+
+	public function setFinal(bool $state = true): static
+	{
+		$this->final = $state;
+		return $this;
+	}
+
+
+	public function isFinal(): bool
+	{
+		return $this->final;
+	}
+
+
+	/** @internal */
+	public function setParameters(array $val): static
+	{
+		(function (Parameter ...$val) {})(...$val);
+		$this->parameters = [];
+		foreach ($val as $v) {
+			$this->parameters[$v->getName()] = $v;
+		}
+
+		return $this;
+	}
+
+
+	/** @internal */
+	public function getParameters(): array
+	{
+		return $this->parameters;
+	}
+
+
+	/**
+	 * Adds a parameter. If it already exists, it overwrites it.
+	 * @param  string  $name without $
+	 */
+	public function addParameter(string $name): Parameter
+	{
+		return $this->parameters[$name] = new Parameter($name);
+	}
+
+
+	public function setReturnReference(bool $state = true): static
+	{
+		$this->returnReference = $state;
+		return $this;
+	}
+
+
+	public function getReturnReference(): bool
+	{
+		return $this->returnReference;
+	}
+}

src/PhpGenerator/PropertyHookType.php

@@ -0,0 +1,33 @@
+<?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;
+
+use Nette;
+
+
+/**
+ * Property hook type.
+ */
+/*enum*/ final class PropertyHookType
+{
+	use Nette\StaticClass;
+
+	public const Set = 'set';
+	public const Get = 'get';
+
+
+	/** @internal */
+	public static function from(string $value): string
+	{
+		return $value === self::Set || $value === self::Get
+			? $value
+			: throw new \ValueError("'$value' is not a valid value of hook type");
+	}
+}

src/PhpGenerator/Traits/PropertyLike.php

@@ -9,6 +9,8 @@
 
 namespace Nette\PhpGenerator\Traits;
 
+use Nette\PhpGenerator\PropertyHook;
+use Nette\PhpGenerator\PropertyHookType;
 
 
 /**
@@ -20,6 +22,9 @@ trait PropertyLike
 
 	private bool $readOnly = false;
 
+	/** @var array<string, ?PropertyHook> */
+	private array $hooks = [PropertyHookType::Set => null, PropertyHookType::Get => null];
+
 
 	public function setReadOnly(bool $state = true): static
 	{
@@ -32,4 +37,45 @@ public function isReadOnly(): bool
 	{
 		return $this->readOnly;
 	}
+
+
+	/**
+	 * Replaces all hooks.
+	 * @param  PropertyHook[]  $hooks
+	 */
+	public function setHooks(array $hooks): static
+	{
+		(function (PropertyHook ...$hooks) {})(...$hooks);
+		$this->hooks = $hooks;
+		return $this;
+	}
+
+
+	/** @return array<string, PropertyHook> */
+	public function getHooks(): array
+	{
+		return array_filter($this->hooks);
+	}
+
+
+	/** @param  'set'|'get'  $type */
+	public function addHook(string $type, string $shortBody = ''): PropertyHook
+	{
+		return $this->hooks[PropertyHookType::from($type)] = (new PropertyHook)
+			->setBody($shortBody, short: true);
+	}
+
+
+	/** @param  'set'|'get'  $type */
+	public function getHook(string $type): ?PropertyHook
+	{
+		return $this->hooks[PropertyHookType::from($type)] ?? null;
+	}
+
+
+	/** @param  'set'|'get'  $type */
+	public function hasHook(string $type): bool
+	{
+		return isset($this->hooks[PropertyHookType::from($type)]);
+	}
 }