Skip to content

Added new type-safe API that allows validating a given value against a given class-string<Enum> #143

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.

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Added new type-safe API that allows validating a given value against a given class-string<Enum> #143

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
96598da
Better type tests around instantiation and validation scenarios
Ocramius Mar 11, 2021
ec76a45
Removed invalid `T` template parameter from methods where it is not b…
Ocramius Mar 11, 2021
6262a50
Marked `Enum::from()` as `@psalm-pure`, since it does not cause any s…
Ocramius Mar 11, 2021
74b9e22
Removed suppressions that no longer apply as per `vimeo/psalm:4.6.2`
Ocramius Mar 11, 2021
be511e4
Added new type-safe API that allows validating a given value against …
Ocramius Mar 11, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Removed invalid T template parameter from methods where it is not b… 
…ound to any template

These functions had a `T` template parameter in them, but this `T` is completely decoupled
from the one defined at class-level (and therefore at `Enum` instance level, rather than
statically):

 * `Enum::from()`
 * `Enum::isValid()`
 * `Enum::assertValidValue()`
 * `Enum::assertValidValueReturningKey()` (internal detail)

In practice, this means that #135 (Added new named constructor to create enum from mixed)
was not a valid approach to infer types for enumerable values, when performed statically.

A new approach will be attempted, but the current one will likely need to be scrapped for
now.

In practice, `@psalm-assert`, `@psalm-assert-if-true` and `@psalm-return static<T>` had no
effect on these methods, due to a design-level issue that wasn't spotted (by myself either)
at review.
  • Loading branch information
@Ocramius
Ocramius committed Mar 11, 2021
commit ec76a45b9581089d63d304a248014f67d609c31d
5 changes: 1 addition & 4 deletions src/Enum.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ public function __wakeup()
/**
* @param mixed $value
* @return static
* @psalm-return static<T>
* @psalm-return static
*/
public static function from($value): self
{
Expand Down Expand Up @@ -212,7 +212,6 @@ public static function toArray()
* @param $value
* @psalm-param mixed $value
* @psalm-pure
* @psalm-assert-if-true T $value
* @return bool
*/
public static function isValid($value)
Expand All @@ -224,7 +223,6 @@ public static function isValid($value)
* Asserts valid enum value
*
* @psalm-pure
* @psalm-assert T $value
* @param mixed $value
*/
public static function assertValidValue($value): void
Expand All @@ -236,7 +234,6 @@ public static function assertValidValue($value): void
* Asserts valid enum value
*
* @psalm-pure
* @psalm-assert T $value
* @param mixed $value
* @return string
*/
Expand Down