add new filter to filter to an enum

[reinfi]

Q	A
Documentation	no
Bugfix	no
BC Break	no
New Feature	yes
RFC	no
QA	no

Description

I added a filter to filter a given value to an enum. Is a bit like the pull request here.

I'm unsure if the filter should return the original value if it is not in the enum or null. I actually added it as null because than you can be sure that your value is either null or the expected enum.

Hopefully I added everything related to your contribution guidelines.

Of course this filter only works > PHP 8.0.

And I think psalm will fail for my new class, but hopefully someone of you can help me how to solve it.

[Ocramius]

Good direction! Needs some feedback from @gsteel too, but overall nice idea to start handling ENUMs directly 👍

[Ocramius]

I wonder if we should keep extending AbstractFilter at all, but that's something @gsteel should help us decide.

In this case, new ToEnum(MyEnum::class) seems cleaner to me, and doesn't really need the API inherited from AbstractFilter, although unsure if divergence from that is better or worse.

Adding AbstractFilter can also be done afterwards too.

[reinfi]

But that would not work with the factory? Or should I add a factory to handle the case?
Extending AbstractFilter could be easily removed because I do not really need it.

[Ocramius]

The psalm errors detected here should be similar to laminas/laminas-validator#168

Perhaps polyfilling with a .phpstub file in Psalm could suffice.

[Ocramius]

I would love for this to only accept class-string<UnitEnum> :D

[gsteel]

The constructor arg needs to be

Suggested change

	public function __construct($enumOrOptions)
	public function __construct($enumOrOptions = [])

or

Suggested change

	public function __construct($enumOrOptions)
	public function __construct($enumOrOptions = null)

(null would also need to be added to the @param in this case)

The FilterPluginManager will just new the filter without arguments unless a factory is created (which is pointless).

In order for the filter to be available in the plugin manager, FilterPluginManager must be updated with entries under factories and aliases

The problem is that at this point, PHPUnit will fail CI on PHP 8.0 (Along with Psalm)

I don't see an easy way around this at the moment unless dropping support for PHP 8.0 is an option.

Thoughts @Ocramius ?

[froschdesign]

The FilterPluginManager will just new the filter without arguments unless a factory is created…

Correct! 👍🏻

[Ocramius]

I think this should be made more generic:

/**
 * @template TEnum of UnitEnum
 */

Then in the constructor you can:

/**
 * @param class-string<TEnum> $enum
 */
public function __construct(string $enum)
{
    // ...
}

This way, filter() becomes generic, and you can infer the correct ENUM type too:

/**
 * @return TEnum|null
 */
public function filter(mixed $value): ?UnitEnum
{
    // ...
}

[reinfi]

I tried it but psalm will not understand my type
psalm: UndefinedDocblockClass: Docblock-defined class, interface or enum named Laminas\Filter\TEnum does not exist
when I use class-string<TEnum>|Traversable|Options. If I remove the Traversable|Options psalm understands it.

[gsteel]

👍 Nice addition :)

I'm wondering whether we can add phpVersion=8.1 to psalm.xml to silence most of the psalm issues here: https://psalm.dev/docs/running_psalm/configuration/#phpversion

[reinfi]

When psalm is running on php8.1 everything is now working.
But still no idea how to handle that in the ci pipeline.