Add support for properties hooks [Closes #171]

Author: shanginn

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)
@@ -386,13 +386,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 +455,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/Property.php

@@ -30,6 +30,9 @@ final class Property
 	private bool $initialized = false;
 	private bool $readOnly = false;
 
+	/** @var array<string, ?PropertyHook> */
+	private array $hooks = ['set' => null, 'get' => null];
+
 
 	public function setValue(mixed $val): static
 	{
@@ -113,6 +116,46 @@ public function isReadOnly(): bool
 	}
 
 
+	/**
+	 * 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);
+	}
+
+
+	public function getHook(\PropertyHookType|string $type): ?PropertyHook
+	{
+		$type = is_string($type) ? $type : $type->value;
+		return $this->hooks[$type] ?? null;
+	}
+
+
+	public function addHook(\PropertyHookType|string $type, string $body = '', bool $short = false): PropertyHook
+	{
+		$type = is_string($type) ? $type : $type->value;
+		return $this->hooks[$type] = (new PropertyHook)
+			->setBody($body, short: $short);
+	}
+
+
+	public function hasHook(\PropertyHookType|string $type): bool
+	{
+		return isset($this->hooks[$type]);
+	}
+
+
 	/** @throws Nette\InvalidStateException */
 	public function validate(): void
 	{

src/PhpGenerator/PropertyHook.php

@@ -0,0 +1,106 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Nette\PhpGenerator;
+
+use JetBrains\PhpStorm\Language;
+
+
+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;
+	}
+}

tests/PhpGenerator/Property.hooks.classes.phpt

@@ -0,0 +1,59 @@
+<?php
+
+/**
+ * Test: PHP 8.4 property hooks for classes
+ */
+
+declare(strict_types=1);
+
+use Nette\PhpGenerator\ClassType;
+
+require __DIR__ . '/../bootstrap.php';
+
+
+$class = new ClassType('Demo');
+
+$class->addProperty('first')
+	->setType('string')
+	->setValue('x')
+	->setPublic()
+	->addHook('set')
+		->setBody('$value . ?', ['x'], short: true)
+		->addComment('comment')
+		->addAttribute('Example')
+		->addParameter('value')
+			->setType('string');
+
+$prop = $class->addProperty('second')
+	->setType('string')
+	->setPublic();
+
+$prop->addHook('get')
+	->setBody('return $this->second;')
+	->setReturnReference()
+	->setFinal();
+
+$prop->addHook('set', '$this->second = $value;')
+	->addParameter('value')
+		->setType('string');
+
+same(<<<'XX'
+	class Demo
+	{
+		public string $first = 'x' {
+			/** comment */
+			#[Example]
+			set(string $value) => $value . 'x';
+		}
+
+		public string $second {
+			set(string $value) {
+				$this->second = $value;
+			}
+			final &get {
+				return $this->second;
+			}
+		}
+	}
+
+	XX, (string) $class);