Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add enum_cases function #3872

Open
wants to merge 1 commit into
base: 3.x
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
40 changes: 40 additions & 0 deletions src/Extension/EnumExtension.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
<?php

namespace Twig\Extension;

/*
* This file is part of Twig.
*
* (c) Fabien Potencier
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

use Twig\TwigFunction;

class EnumExtension extends AbstractExtension
{
public function getFunctions(): array
{
return [
new TwigFunction('enum_cases', __CLASS__.'::enumCases'),
];
}

/**
* @template T of \BackedEnum
*
* @param class-string<T> $backedEnum
*
* @return T[]
*/
public static function enumCases(string $backedEnum): array
{
if (!is_a($backedEnum, \BackedEnum::class, true)) {
throw new \InvalidArgumentException(sprintf('The enum must be a "\BackedEnum", "%s" given.', $backedEnum));
Copy link
Contributor

@GromNaN GromNaN Oct 8, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The restriction on BackedEnum is not necessary. As we can see in you Locale::flag example, the enum case can be used as argument to call a function, or directly to call a method on it.

}

return $backedEnum::cases();
}
}
50 changes: 50 additions & 0 deletions tests/Extension/EnumExtensionTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
<?php

namespace Twig\Tests\Extension;

/*
* This file is part of Twig.
*
* (c) Fabien Potencier
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

use PHPUnit\Framework\TestCase;
use Twig\Extension\EnumExtension;

/**
* @requires PHP 8.1
*/
class EnumExtensionTest extends TestCase
{
public function testEnumCases()
{
$cases = EnumExtension::enumCases(MyBackedEnum::class);

$this->assertSame(MyBackedEnum::cases(), $cases);
}

public function testEnumCasesThrowsIfNotBacked()
{
$this->expectException(\InvalidArgumentException::class);
$this->expectExceptionMessage('The enum must be a "\BackedEnum", "Twig\Tests\Extension\MyUnitEnum" given.');

EnumExtension::enumCases(MyUnitEnum::class);
}
}

if (80100 <= \PHP_VERSION_ID) {
enum MyBackedEnum: string
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Even if you put an if around it, enum is a syntax error for PHP < 8.1. The @requires PHP 8.1 doesn't help either since the file can't be compiled on PHP 8.0 and bellow. That should be OK if you move this enum declarations in other files.

{
case ONE = 'one';
case TWO = 'two';
}

enum MyUnitEnum
{
case ONE;
case TWO;
}
}