Enum support #6425

weirdan · 2021-09-05T13:25:34Z

psalm-github-bot · 2021-09-05T13:25:35Z

I found these snippets:

https://psalm.dev/r/d153c9d4f0

<?php

enum Status: int
{
    case FOO = 1;
    case BAR = 2;
}

$statusA = Status::FOO;
$statusB = Status::FOO;
$statusC = Status::BAR;

$statusA === $statusB; // true
$statusA === $statusC; // false
$statusC instanceof Status; // true

Psalm output (using commit 916b098):

ERROR: ParseError - 3:6 - Syntax error, unexpected T_STRING on line 3

ERROR: ParseError - 5:5 - Syntax error, unexpected T_CASE on line 5

weirdan · 2021-09-05T13:39:18Z

@niconoe- mind elaborating on those two non-linked points?

niconoe- · 2021-09-05T15:10:54Z

About Enum are objects I was thinking about the good behavior of using instanceof like described in the RFC. I didn't know this was already developped as I tested in the default PHP version, not forcing it to PHP 8.1.
You can remove this point, or check it to say it's already done.

About Attributes are allowed on Enums and TARGET_CLASS also references Enums I was thinking about something like https://psalm.dev/r/c31b9b8e81?php=8.1 or like this: https://psalm.dev/r/36779dc1b9?php=8.1

In the first case, the attribute usage is triggered by Psalm because Status is not a class (while enums are actually a subset of classes, if I understand correctly the concept in the RFC).

In the 2nd case, the attribute usage should be triggered by Psalm but not for the given reason, as currently it's the fact that Status is not a class, but it should trigger the fact that the target is not respected.

Maybe there are still other cases to discover when mixing attributes with enums, but I'm not familiar enough with both of them to go deeper.

psalm-github-bot · 2021-09-05T15:10:57Z

I found these snippets:

https://psalm.dev/r/c31b9b8e81

<?php

#[Attribute]
enum Status: int
{
    case FOO = 1;
    case BAR = 2;
}

#[Status]
class HelloWorld
{}

Psalm output (using commit 916b098):

INFO: UndefinedAttributeClass - 10:3 - Attribute class Status does not exist

INFO: UnusedClass - 11:7 - Class HelloWorld is never used

https://psalm.dev/r/36779dc1b9

<?php

#[Attribute(Attribute::TARGET_CLASS)]
enum Status: int
{
    case FOO = 1;
    case BAR = 2;
}

class HelloWorld
{
    #[Status]
	public function _() {}
}

Psalm output (using commit 916b098):

INFO: UndefinedAttributeClass - 12:7 - Attribute class Status does not exist

INFO: MissingReturnType - 13:18 - Method HelloWorld::_ does not have a return type, expecting void

INFO: UnusedClass - 10:7 - Class HelloWorld is never used

orklah · 2021-11-06T19:42:15Z

Enums can't be instantiated: https://3v4l.org/vB468#v8.1rc3

jpresutti · 2021-11-23T22:28:41Z

Enums in attributes are not properly detected for their types
https://psalm.dev/r/aa57812a88?php=8.1

psalm-github-bot · 2021-11-23T22:28:45Z

I found these snippets:

https://psalm.dev/r/aa57812a88

<?php
class CreateController 
{

    #[Action(usage: '--type={(get-post-put-delete-patch)} --module={module} --noview={true|false} {controller} {action}', description: 'Create a new controller action from the template file.')]
    #[Param(type: 'string', name: 'controller', description: 'Name of controller to create action in.' . "\n" . '  Controller file is created if it does not exist.')]
    #[Param(type: 'string', name: 'action', description: 'Name of action to create.' . "\n" . '  Creates associated view file unless noview is true')]
    #[Param(type: 'string', name: 'type', description: 'HTTP Methods for Controller Action, dash separated. Defaults to get', paramType: ParamType::FLAG)]
    #[Param(type: 'string', name: 'module', description: 'Optional - Module to create controller in (CLI for command line)', paramType: ParamType::FLAG)]
    #[Param(type: 'bool', name: 'noview', description: 'True to skip creating view file', paramType: ParamType::FLAG)]
    public function actionGet(
        ?string $controller = null,
        ?string $action = null,
        string $type = 'get',
        ?string $module = null,
        bool $noview = false
    ): void {
    }
}

use Attribute;

#[Attribute(Attribute::TARGET_METHOD)]
class Action
{
    public function __construct(public string $usage = '', public string $description = '')
    {
    }

    /**
     * Get pretty format usage text
     *
     * @param string $usage
     * @param string $name
     * @return string
     */
    public function getHelpText(string $usage, string $name): string
    {
        return trim(implode(' ', ['Usage:', $usage, $name, $this->usage]));
    }
}

#[Attribute(Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)]
class Param
{
    public function __construct(
        public string $type = '',
        public string $name = '',
        public string $description = '',
        public ParamType $paramType = ParamType::PARAM
    ) {
    }

   
}


enum ParamType
{
    case FLAG;
    case PARAM;
}

Psalm output (using commit fdf3a8d):

ERROR: InvalidArgument - 8:138 - Argument 4 of Param::__construct expects ParamType, "Psalm could not infer this type" provided

ERROR: InvalidArgument - 9:137 - Argument 4 of Param::__construct expects ParamType, "Psalm could not infer this type" provided

ERROR: InvalidArgument - 10:102 - Argument 4 of Param::__construct expects ParamType, "Psalm could not infer this type" provided

simPod · 2022-01-10T13:02:56Z

~~Enums have properties~~ probably only internally, not on interface?
~~Interface StringBackedEnum exists~~
~~Interface IntBackedEnum exists~~
~~type of IntBackedEnum->value is int (same for StringBackedEnum)~~

~~https://psalm.dev/r/9df7604507~~
https://psalm.dev/r/461a456ffb

psalm-github-bot · 2022-01-10T13:02:59Z

I found these snippets:

https://psalm.dev/r/9df7604507

<?php

function value(BackedEnum $e): int|string {
    return $e->value;
}

function name(BackedEnum $e): string {
    return $e->name;
}


function intValue(IntBackedEnum $e): int {
    return $e->value;
}

function stringValue(StringBackedEnum $e): string {
    return $e->value;
}

Psalm output (using commit 206332b):

ERROR: UndefinedClass - 3:16 - Class, interface or enum named BackedEnum does not exist

INFO: MixedInferredReturnType - 3:32 - Could not verify return type 'int|string' for value

ERROR: UndefinedClass - 7:15 - Class, interface or enum named BackedEnum does not exist

INFO: MixedInferredReturnType - 7:31 - Could not verify return type 'string' for name

ERROR: UndefinedClass - 12:19 - Class, interface or enum named IntBackedEnum does not exist

INFO: MixedInferredReturnType - 12:38 - Could not verify return type 'int' for intValue

ERROR: UndefinedClass - 16:22 - Class, interface or enum named StringBackedEnum does not exist

INFO: MixedInferredReturnType - 16:44 - Could not verify return type 'string' for stringValue

https://psalm.dev/r/461a456ffb

<?php

function value(BackedEnum $e): int|string {
    return $e->value;
}

function name(BackedEnum $e): string {
    return $e->name;
}

Psalm output (using commit 206332b):

ERROR: UndefinedClass - 3:16 - Class, interface or enum named BackedEnum does not exist

INFO: MixedInferredReturnType - 3:32 - Could not verify return type 'int|string' for value

ERROR: UndefinedClass - 7:15 - Class, interface or enum named BackedEnum does not exist

INFO: MixedInferredReturnType - 7:31 - Could not verify return type 'string' for name

weirdan · 2022-01-10T13:10:48Z

Interface StringBackedEnum exists
Interface IntBackedEnum exists

Do they? https://3v4l.org/3piBE#v8.1.1

simPod · 2022-01-10T13:17:05Z

Hm, my bad, looked into wrong stubs. So only this one should not give any error https://psalm.dev/r/461a456ffb.

psalm-github-bot · 2022-01-10T13:17:08Z

I found these snippets:

https://psalm.dev/r/461a456ffb

<?php

function value(BackedEnum $e): int|string {
    return $e->value;
}

function name(BackedEnum $e): string {
    return $e->name;
}

Psalm output (using commit 206332b):

ERROR: UndefinedClass - 3:16 - Class, interface or enum named BackedEnum does not exist

INFO: MixedInferredReturnType - 3:32 - Could not verify return type 'int|string' for value

ERROR: UndefinedClass - 7:15 - Class, interface or enum named BackedEnum does not exist

INFO: MixedInferredReturnType - 7:31 - Could not verify return type 'string' for name

orklah · 2022-01-24T06:33:19Z

As far as I can tell, Enum are now fully supported. Please open new issues if bugs are found

weirdan mentioned this issue Sep 5, 2021

[Help wanted] Listing PHP 8.1 features #6395

Closed

25 tasks

weirdan added the enhancement label Sep 5, 2021

weirdan added this to the PHP 8.1 milestone Sep 5, 2021

orklah added the enum label Nov 6, 2021

weirdan mentioned this issue Nov 23, 2021

Enums cases as attribute params #6982

Closed

weirdan mentioned this issue Jan 10, 2022

Known properties on implicit enum interfaces #7364

Closed

orklah closed this as completed Jan 24, 2022

orklah mentioned this issue Dec 7, 2022

StringBackedEnum is not known. #8855

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enum support #6425

Enum support #6425

weirdan commented Sep 5, 2021 •

edited

psalm-github-bot bot commented Sep 5, 2021 •

edited

weirdan commented Sep 5, 2021

niconoe- commented Sep 5, 2021 •

edited

psalm-github-bot bot commented Sep 5, 2021

orklah commented Nov 6, 2021

jpresutti commented Nov 23, 2021 •

edited by weirdan

psalm-github-bot bot commented Nov 23, 2021 •

edited

simPod commented Jan 10, 2022 •

edited

psalm-github-bot bot commented Jan 10, 2022 •

edited

weirdan commented Jan 10, 2022

simPod commented Jan 10, 2022

psalm-github-bot bot commented Jan 10, 2022

orklah commented Jan 24, 2022

Enum support #6425

Enum support #6425

Comments

weirdan commented Sep 5, 2021 • edited

psalm-github-bot bot commented Sep 5, 2021 • edited

weirdan commented Sep 5, 2021

niconoe- commented Sep 5, 2021 • edited

psalm-github-bot bot commented Sep 5, 2021

orklah commented Nov 6, 2021

jpresutti commented Nov 23, 2021 • edited by weirdan

psalm-github-bot bot commented Nov 23, 2021 • edited

simPod commented Jan 10, 2022 • edited

psalm-github-bot bot commented Jan 10, 2022 • edited

weirdan commented Jan 10, 2022

simPod commented Jan 10, 2022

psalm-github-bot bot commented Jan 10, 2022

orklah commented Jan 24, 2022

weirdan commented Sep 5, 2021 •

edited

psalm-github-bot bot commented Sep 5, 2021 •

edited

niconoe- commented Sep 5, 2021 •

edited

jpresutti commented Nov 23, 2021 •

edited by weirdan

psalm-github-bot bot commented Nov 23, 2021 •

edited

simPod commented Jan 10, 2022 •

edited

psalm-github-bot bot commented Jan 10, 2022 •

edited