Set type of constant in stub

[avdv]

Hi.

Is it possible to override the type of a (class) constant in a stub? I.e.

class Gender {
  const MALE = 'm';
  const FEMALE = 'f';
}

class User {
  // this function is from a library, it defines that it expects a Gender, 
  // but it actually wants a string (one of the constants of the Gender class)
  function setGender(Gender $g): void {}
}

I tried to override the type of the constants in a stub file:

class Gender {
  const
    /** @var Gender */
    MALE = new Gender(),
    /** @var Gender */
    FEMALE = new Gender();
}

Seems that it this not supported... phpstan still insists that the argument given to the function ($u->setGender(Gender::MALE);) is a string...

(of course, I can fix the setGender function to accept a string, but the other way around would have more charm...)

TIA

[ondrejmirtes]

Hi, I don't get it, is the typehint declared in a PHPDoc or natively?

class User {
  // this function is from a library, it defines that it expects a Gender, 
  // but it actually wants a string (one of the constants of the Gender class)
  function setGender(Gender $g): void {}
}

[ondrejmirtes]

Yeah, so the correct way for that is to fix the setGender parameter type because it's more correct. Class constants can't even be objects...

of course, I can fix the setGender function to accept a string

You can set it to actually accept only the correct string values, see https://phpstan.org/writing-php-code/phpdoc-types#literals-and-constants

[avdv]

Yeah, so the correct way for that is to fix the setGender parameter type because it's more correct. Class constants can't even be objects...

Ah, OK. I wasn't sure about that. (only two months into PHP, roughly)

You can set it to actually accept only the correct string values, see phpstan.org/writing-php-code/phpdoc-types#literals-and-constants

Oh, that's nice. Thank you!

[avdv]

Follow up question:

If I override the setGender method with @param (Gender::MALE|Gender::FEMALE) $gender it seems I still have to repeat the definition of the constants in the stub file (otherwise I get `PHPDoc tag @param for parameter $gender contains unresolvable type).

That seems a bit error prone, but I guess is because all types are resolved when loading the stub file and not at a later time?

I am using phpstan 0.12.71.

[ondrejmirtes]

See the orange note at the bottom: https://phpstan.org/user-guide/stub-files

[avdv]

Got it. Thank you again!