Draft: Refactor enums

composer.json

@@ -30,7 +30,7 @@
 		"doctrine/annotations": "^1.0",
 		"doctrine/doctrine-bundle": "^2.3",
 		"doctrine/doctrine-migrations-bundle": "^3.1",
-		"doctrine/orm": "^2.8",
+		"doctrine/orm": "^2.11",
 		"doctrine/persistence": "^2.0",
 		"easyrdf/easyrdf": "^0.9.1",
 		"endroid/qr-code": "^4.1",

config/packages/doctrine.yaml

@@ -31,7 +31,6 @@ doctrine:
       enumGroepStatus: CsrDelft\common\Doctrine\Type\Enum\GroepStatusType
       enumHuisStatus: CsrDelft\common\Doctrine\Type\Enum\HuisStatusType
       enumCommissieSoort: CsrDelft\common\Doctrine\Type\Enum\CommissieSoortType
-      enumGeslacht: CsrDelft\common\Doctrine\Type\Enum\GeslachtType
       enumGroepVersie: CsrDelft\common\Doctrine\Type\Enum\GroepVersieType
       enumOnderverenigingStatus: CsrDelft\common\Doctrine\Type\Enum\OnderverenigingStatusType
       enumActiviteitSoort: CsrDelft\common\Doctrine\Type\Enum\ActiviteitSoortType

lib/DataFixtures/Util/ProfielFixtureUtil.php

@@ -34,8 +34,8 @@ public static function maakProfiel(
 		$profiel->uid = $uid;
 		$profiel->lidjaar = (int) ('20' . substr((string) $uid, 2));
 		$profiel->geslacht = [
-			'male' => Geslacht::Man(),
-			'female' => Geslacht::Vrouw(),
+			'male' => Geslacht::Man,
+			'female' => Geslacht::Vrouw,
 		][$geslacht];
 		// TODO $profiel->changelog;
 		$profiel->changelog = [new ProfielLogTextEntry('Aangemaakt door fixtures')];

lib/common/EnumTrait.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace CsrDelft\common;
+
+
+trait EnumTrait {
+	/**
+	 * @return string[]
+	 */
+	abstract public static function cases(): array;
+	abstract public function getValue(): string;
+	abstract public function getDescription(): string;
+	public static function getEnumValues(): array {
+		return array_column(self::cases(), 'value');
+	}
+	public static function isValidValue(string $value): bool {
+		return in_array($value, self::getEnumValues(), strict: true);
+	}
+
+}

lib/entity/Geslacht.php

@@ -2,29 +2,29 @@
 
 namespace CsrDelft\entity;
 
-use CsrDelft\common\Enum;
+use CsrDelft\common\EnumTrait;
 
-/**
- * @author P.W.G. Brussee <[email protected]>
- *
- * @method static Geslacht Man()
- * @method static Geslacht Vrouw()
- * @method static boolean isMan($geslacht)
- * @method static boolean isVrouw($geslacht)
- */
-class Geslacht extends Enum
-{
-	/**
-	 * Geslacht opties.
-	 */
-	const Man = 'm';
-	const Vrouw = 'v';
+enum Geslacht: string {
+	use EnumTrait;
+	case Man = 'm';
+	case Vrouw = 'v';
 
-	/**
-	 * @var string[]
-	 */
-	protected static $mapChoiceToDescription = [
-		self::Man => 'man',
-		self::Vrouw => 'vrouw',
-	];
+	public function getDescription(): string {
+		return match($this) {
+			Geslacht::Man => 'man',
+			Geslacht::Vrouw => 'vrouw'
+		};
+	}
+
+	public function getValue(): string {
+		return $this->value;
+	}
+
+	public function isVrouw(): bool {
+		return $this === self::Vrouw;
+	}
+
+	public function isMan(): bool {
+		return $this === self::Man;
+	}
 }

lib/entity/profiel/Profiel.php

@@ -109,12 +109,9 @@ public function __construct()
 	 */
 	#[ORM\Column(type: 'string', nullable: true)]
 	public $duckname;
-	// fysiek
-	/**
-	 * @var Geslacht
-	 */
-	#[ORM\Column(type: 'enumGeslacht')]
-	public $geslacht;
+
+	#[ORM\Column(type: 'string', enumType: Geslacht::class)]
+	public Geslacht $geslacht;
 	/**
 	 * @var DateTimeImmutable
 	 */
@@ -250,11 +247,8 @@ public function __construct()
 	 */
 	#[ORM\Column(type: 'date', nullable: true)]
 	public $lidafdatum;
-	/**
-	 * @var string
-	 */
-	#[ORM\Column(type: 'string')]
-	public $status;
+	#[ORM\Column(type: 'string', enumType: LidStatus::class)]
+	public LidStatus $status;
 	// geld
 	/**
 	 * @var string|null
@@ -728,7 +722,7 @@ public function getLink($vorm = 'civitas')
 			'"' .
 			$title .
 			' class="lidLink ' .
-			htmlspecialchars($this->status) .
+			htmlspecialchars($this->status->value) .
 			'" data-lid="' .
 			$this->uid .
 			'" data-lid-naam="' .
@@ -747,7 +741,7 @@ public function getLink($vorm = 'civitas')
 				'"><a href="/profiel/' .
 				$this->uid .
 				'" class="lidLink ' .
-				htmlspecialchars($this->status) .
+				htmlspecialchars($this->status->value) .
 				'">' .
 				$naam .
 				'</a></span>';
@@ -839,9 +833,9 @@ public function getNaam($vorm = 'volledig', $force = false)
 				} elseif ($this->isLid() || $this->isOudlid()) {
 					// voor novieten is het Dhr./ Mevr.
 					if (LoginService::getProfiel()->status === LidStatus::Noviet) {
-						$naam = Geslacht::isVrouw($this->geslacht) ? 'Mevr. ' : 'Dhr. ';
+						$naam = $this->geslacht === Geslacht::Vrouw ? 'Mevr. ' : 'Dhr. ';
 					} else {
-						$naam = Geslacht::isVrouw($this->geslacht) ? 'Ama. ' : 'Am. ';
+						$naam = $this->geslacht === Geslacht::Vrouw ? 'Ama. ' : 'Am. ';
 					}
 					if (!empty($this->tussenvoegsel)) {
 						$naam .= ucfirst($this->tussenvoegsel) . ' ';
@@ -852,7 +846,7 @@ public function getNaam($vorm = 'volledig', $force = false)
 					}
 					// status char weergeven bij oudleden en ereleden
 					if ($this->isOudlid()) {
-						$naam .= ' ' . LidStatus::from($this->status)->getChar();
+						$naam .= ' ' . $this->status->getChar();
 					}
 				}
 				// geen lid
@@ -868,7 +862,7 @@ public function getNaam($vorm = 'volledig', $force = false)
 					$naam .= $this->achternaam;
 					// status char weergeven bij kringels
 					if ($this->status === LidStatus::Kringel) {
-						$naam .= ' ' . LidStatus::from($this->status)->getChar();
+						$naam .= ' ' . $this->status->getChar();
 					}
 				}
 
@@ -1034,12 +1028,12 @@ public function getNageslachtGrootte()
 
 	public function isLid()
 	{
-		return LidStatus::isLidLike($this->status);
+		return $this->status->isLidLike();
 	}
 
 	public function isOudlid()
 	{
-		return LidStatus::isOudlidLike($this->status);
+		return $this->status->isOudlidLike();
 	}
 
 	/**
@@ -1106,7 +1100,7 @@ public function propertyMogelijk(string $name)
 		return in_array($this->status, Profiel::$properties_lidstatus[$name]);
 	}
 
-	public function getDataTableColumn()
+	public function getDataTableColumn(): DataTableColumn
 	{
 		return new DataTableColumn(
 			$this->getLink('volledig'),
@@ -1115,7 +1109,7 @@ public function getDataTableColumn()
 		);
 	}
 
-	public function getId()
+	public function getId(): string
 	{
 		return $this->uid;
 	}
@@ -1125,17 +1119,17 @@ public function getWeergave(): string
 		return $this->achternaam ? $this->getNaam('volledig') : '';
 	}
 
-	public function getChar()
+	public function getChar(): string
 	{
-		return LidStatus::from($this->status)->getChar();
+		return $this->status->getChar();
 	}
 
-	public function getLidStatusDescription()
+	public function getLidStatusDescription(): string
 	{
-		return LidStatus::from($this->status)->getDescription();
+		return $this->status->getDescription();
 	}
 
-	public function getLeeftijd()
+	public function getLeeftijd(): int
 	{
 		return $this->gebdatum->diff(date_create_immutable())->y;
 	}