nette / php-generator

🐘 Generates neat PHP code for you. Supports new PHP 8.3 features.
https://doc.nette.org/php-generator
Other
2.11k stars 138 forks source link

The parameter and property types are not correctly returned when they are nullable #153

Open jenky opened 9 months ago

jenky commented 9 months ago

Version: 4.1.3

Bug Description

getType does not return correct type

Steps To Reproduce

$class = new ClassType('Hello');

$method = $class->addMethod('greeting');

$param = $method->addParameter('name', null)
    ->setType('string')
    ->setNullable();

echo $param->getType(); // "string"

The class was generated correctly

class Hello
{
        public function greeting(?string $name = null)
        {
        }
}

Expected Behavior

$param->getType() should return ?string or null|string instead of string

kosciuk commented 9 months ago

For me is ok, if you set null with setNullable, you should check with:

echo $param->isNullable(); // true

jenky commented 9 months ago

Why do I need to check isNullable when I already know it by using setNullable? I want to get the correct param type not the nullable state.

kosciuk commented 9 months ago

Why do you ask for the type if you already know that the answer is string? In large programs you won't know where the type is set or what type it is.

Example: I generate code with ->setType[$entity->getPhpType()].

jenky commented 9 months ago

Why do you ask for the type if you already know that the answer is string?

It's just an example to reproduce the bug

In large programs you won't know where the type is set or what type it is.

Example: I generate code with ->setType[$entity->getPhpType()].

So what is your point then?. Your example is clearly the reason getType should return the correct types

kosciuk commented 9 months ago

I am a user, I do not participate in the development, I think it is correct to check with isNullable, otherwise you have to parse the response to know if it is nullable or string

jenky commented 8 months ago

isNullable doesn't return true in the case of ->setType('null|string') but it does return true for ->setType('?string').

If you take a look at this Nette\Utils\Type::fromString

public static function fromString(string $type): self
{
    // ...

    if ($type[0] === '?') {
    return new self([substr($type, 1), 'null']);
    }

    // ...
}

It is clear that the fromString method is capable of parsing and returning the correct types. When using Nette\Utils\Type::fromString('?string'), it correctly returns the expected types. However ->setType('?string')->getType() doesn't (which uses Nette\Utils\Type::fromString behind the scenes). With all the inconsistencies, I believe this is a bug.

Anyway, let the repository owner decide on further actions regarding this report.

dg commented 8 months ago

This behavior is for historical reasons, because functions were created at a time when union types like null|string didn't even exist yet. I would like to change this, but it will break compatibility.

sovetski commented 2 months ago

+1 for this

@dg it can be included in a major version maybe?

dg commented 1 month ago

@sovetski yes