Added support for generating Override attributes in generated enum

elephox-dev · Dec 16, 2023 · e2d86d3 · e2d86d3
1 parent 888a993
commit e2d86d3
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 8 deletions.
diff --git a/src/MimeMappingGenerator.php b/src/MimeMappingGenerator.php
@@ -70,16 +70,29 @@ public function generateJson(bool $minify = true): string
 	}
 
 	/**
-	 * @param non-empty-string $classname
-	 * @param non-empty-string $namespace
+	 * @param non-empty-string $classname The name of the generated enum (defaults to: "MimeType")
+	 * @param non-empty-string $namespace The namespace to put the enum into (defaults to this namespace)
+	 * @param bool|null $withOverrideAttribute Whether to add the #[Override] attribute to the generated enum (requires PHP 8.3, defaults to true if PHP >= 8.3, false otherwise)
 	 * @return non-empty-string
 	 */
-	public function generatePhpEnum(string $classname = "MimeType", string $namespace = __NAMESPACE__): string
+	public function generatePhpEnum(string $classname = "MimeType", string $namespace = __NAMESPACE__, ?bool $withOverrideAttribute = null): string
 	{
+		$usages = [];
+		if ($namespace !== __NAMESPACE__) {
+			$usages[] = "use " . MimeTypeInterface::class . ";";
+		}
+
+		$overrideAttribute = '';
+		if (($withOverrideAttribute === null && PHP_VERSION_ID >= 80300) || $withOverrideAttribute) {
+			$usages[] = "use Override;";
+			$overrideAttribute = "\n\t#[Override]";
+		}
+
 		$values = [
 			'namespace' => $namespace,
 			'classname' => $classname,
-			'interface_usage' => $namespace !== __NAMESPACE__ ? ("use " . MimeTypeInterface::class . ";\n") : '',
+			'usages' => implode("\n", $usages),
+			'overrideAttribute' => $overrideAttribute,
 			'cases' => "",
 			'type2ext' => "",
 			'ext2type' => "",

diff --git a/stubs/mimeType.php.stub b/stubs/mimeType.php.stub
@@ -12,18 +12,19 @@ namespace %namespace%;
 
 use RuntimeException;
 use InvalidArgumentException;
-%interface_usage%
+%usages%
+
 enum %classname%: string implements MimeTypeInterface
 {
-%cases%
+%cases%%overrideAttribute%
 	public function getExtension(): string
 	{
 		return match($this) {
 %type2ext%
 			default => throw new RuntimeException("Unknown extension for type: " . $this->value),
 		};
 	}
-
+%overrideAttribute%
 	public function getValue(): string
 	{
 		return $this->value;

diff --git a/tests/src/MimeMappingGeneratorTest.php b/tests/src/MimeMappingGeneratorTest.php
@@ -84,7 +84,7 @@ public function testGeneratePhpEnum(): void
 EOF
 		);
 
-		$phpEnum = $generator->generatePhpEnum("TestMimeClass", "TestMimeNamespace");
+		$phpEnum = $generator->generatePhpEnum("TestMimeClass", "TestMimeNamespace", withOverrideAttribute: false);
 
 		self::assertEquals(<<<EOF
 <?php