added Visibility

Author: dg

src/PhpGenerator/ClassLike.php

@@ -20,19 +20,17 @@ abstract class ClassLike
 	use Traits\CommentAware;
 	use Traits\AttributeAware;
 
-	public const
-		VisibilityPublic = 'public',
-		VisibilityProtected = 'protected',
-		VisibilityPrivate = 'private';
+	/** @deprecated use Visibility::Public */
+	public const VisibilityPublic = Visibility::Public,
+		VISIBILITY_PUBLIC = Visibility::Public;
 
-	/** @deprecated use ClassLike::VisibilityPublic */
-	public const VISIBILITY_PUBLIC = self::VisibilityPublic;
+	/** @deprecated use Visibility::Protected */
+	public const VisibilityProtected = Visibility::Protected,
+		VISIBILITY_PROTECTED = Visibility::Protected;
 
-	/** @deprecated use ClassLike::VisibilityProtected */
-	public const VISIBILITY_PROTECTED = self::VisibilityProtected;
-
-	/** @deprecated use ClassLike::VisibilityPrivate */
-	public const VISIBILITY_PRIVATE = self::VisibilityPrivate;
+	/** @deprecated use Visibility::Private */
+	public const VisibilityPrivate = Visibility::Private,
+		VISIBILITY_PRIVATE = Visibility::Private;
 
 	private ?PhpNamespace $namespace;
 	private ?string $name;

src/PhpGenerator/Extractor.php

@@ -483,9 +483,9 @@ private function toValue(Node\Expr $node): mixed
 	private function toVisibility(int $flags): ?string
 	{
 		return match (true) {
-			(bool) ($flags & Node\Stmt\Class_::MODIFIER_PUBLIC) => ClassType::VisibilityPublic,
-			(bool) ($flags & Node\Stmt\Class_::MODIFIER_PROTECTED) => ClassType::VisibilityProtected,
-			(bool) ($flags & Node\Stmt\Class_::MODIFIER_PRIVATE) => ClassType::VisibilityPrivate,
+			(bool) ($flags & Node\Stmt\Class_::MODIFIER_PUBLIC) => Visibility::Public,
+			(bool) ($flags & Node\Stmt\Class_::MODIFIER_PROTECTED) => Visibility::Protected,
+			(bool) ($flags & Node\Stmt\Class_::MODIFIER_PRIVATE) => Visibility::Private,
 			default => null,
 		};
 	}

src/PhpGenerator/Factory.php

@@ -307,8 +307,8 @@ private function getAttributes($from): array
 	private function getVisibility($from): string
 	{
 		return $from->isPrivate()
-			? ClassLike::VisibilityPrivate
-			: ($from->isProtected() ? ClassLike::VisibilityProtected : ClassLike::VisibilityPublic);
+			? Visibility::Private
+			: ($from->isProtected() ? Visibility::Protected : Visibility::Public);
 	}
 
 

src/PhpGenerator/Method.php

@@ -98,7 +98,7 @@ public function addPromotedParameter(string $name, mixed $defaultValue = null):
 	/** @throws Nette\InvalidStateException */
 	public function validate(): void
 	{
-		if ($this->abstract && ($this->final || $this->visibility === ClassLike::VisibilityPrivate)) {
+		if ($this->abstract && ($this->final || $this->visibility === Visibility::Private)) {
 			throw new Nette\InvalidStateException("Method $this->name() cannot be abstract and final or private at the same time.");
 		}
 	}

src/PhpGenerator/Traits/VisibilityAware.php

@@ -9,8 +9,7 @@
 
 namespace Nette\PhpGenerator\Traits;
 
-use Nette;
-use Nette\PhpGenerator\ClassLike;
+use Nette\PhpGenerator\Visibility;
 
 
 /**
@@ -22,16 +21,10 @@ trait VisibilityAware
 	private ?string $visibility = null;
 
 
-	/**
-	 * @param  string|null  $val  public|protected|private
-	 */
-	public function setVisibility(?string $val): static
+	/** @param  'public'|'protected'|'private'|null  $value */
+	public function setVisibility(?string $value): static
 	{
-		if (!in_array($val, [ClassLike::VisibilityPublic, ClassLike::VisibilityProtected, ClassLike::VisibilityPrivate, null], true)) {
-			throw new Nette\InvalidArgumentException('Argument must be public|protected|private.');
-		}
-
-		$this->visibility = $val;
+		$this->visibility = $value === null ? $value : Visibility::from($value);
 		return $this;
 	}
 
@@ -44,39 +37,39 @@ public function getVisibility(): ?string
 
 	public function setPublic(): static
 	{
-		$this->visibility = ClassLike::VisibilityPublic;
+		$this->visibility = Visibility::Public;
 		return $this;
 	}
 
 
 	public function isPublic(): bool
 	{
-		return $this->visibility === ClassLike::VisibilityPublic || $this->visibility === null;
+		return $this->visibility === Visibility::Public || $this->visibility === null;
 	}
 
 
 	public function setProtected(): static
 	{
-		$this->visibility = ClassLike::VisibilityProtected;
+		$this->visibility = Visibility::Protected;
 		return $this;
 	}
 
 
 	public function isProtected(): bool
 	{
-		return $this->visibility === ClassLike::VisibilityProtected;
+		return $this->visibility === Visibility::Protected;
 	}
 
 
 	public function setPrivate(): static
 	{
-		$this->visibility = ClassLike::VisibilityPrivate;
+		$this->visibility = Visibility::Private;
 		return $this;
 	}
 
 
 	public function isPrivate(): bool
 	{
-		return $this->visibility === ClassLike::VisibilityPrivate;
+		return $this->visibility === Visibility::Private;
 	}
 }

src/PhpGenerator/Visibility.php

@@ -0,0 +1,34 @@
+<?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;
+
+
+/**
+ * Member visibility.
+ */
+/*enum*/ final class Visibility
+{
+	use Nette\StaticClass;
+
+	public const Public = 'public';
+	public const Protected = 'protected';
+	public const Private = 'private';
+
+
+	/** @internal */
+	public static function from(string $value): string
+	{
+		return $value === self::Public || $value === self::Protected || $value === self::Private
+			? $value
+			: throw new \ValueError("'$value' is not a valid value of visibility");
+	}
+}

tests/PhpGenerator/ClassType.phpt

@@ -177,8 +177,7 @@ Assert::same($parameters, $method->getParameters());
 
 Assert::exception(
 	fn() => (new ClassType)->addMethod('method')->setVisibility('unknown'),
-	Nette\InvalidArgumentException::class,
-	'Argument must be public|protected|private.',
+	ValueError::class,
 );