[feature] Object shape typings definition

[kocoten1992]

Feature request

related to #2173

Do we have object typing, for example:

/**
 * @return array<int, object{first:int, second:string}>
 */
function hello(): array {
    return [];
}

Did PHPStan help you today? Did it make you happy in any way?
Yes, it help me a lot!

[ZebulanStanphill]

I guess it goes without saying that the object shape would exclude private and protected props. But would it only include actual public props, or would it also support any magic props described in @property annotations?

[kocoten1992]

(I think) the most use case is going to be json, programmer usually pass json around (decode into a stdClass object), be able to tell phpstan what will be in that object is very valuable.

/** @var object{field_a: int, field_b: int} $json_decode */
$json_decode = json_decode($some_var_from_third_party_service);

[niconoe-]

I would be in favor of this, especially for stdClass as @kocoten1992 was thinking.

I definitly prefer to write this:

/** @var object{field_a: int, field_b: int} $json_decode */
$json_decode = json_decode($some_var_from_third_party_service);
return $json_decode->field_a + $json_decode->field_b;

rather than this;

/** @var stdClass $json_decode */
$json_decode = json_decode($some_var_from_third_party_service);
/** @var int $field_a */
$field_a = $json_decode->field_a;
/** @var int $field_b */
$field_b = $json_decode->field_b;

return $field_a + $field_b;

which is very verbose and multiply the number of @var and local variables, only for the reason the object-shape syntax is not available yet.

Maybe a first implementation could be to say that object-shape definition is only for public properties and ignore magic properties for now, then a second release could be done to go further.

[staabm]

If you are willing to write your own mapper logic, you could use https://github.com/CuyZ/Valinor I guess

[niconoe-]

Valinor looks like awesome. I'm currently using JMS to deserialize into objects also, and in that case, I don't have the need for object{foo: …, bar: …} syntax. But I also work with stdClass directly not in the context of json_decode and I would really appreciate that object shape type definition to be a thing too.

[EliW]

Just ran into a use case for this. Function that needed to return some structured data. I can define that if it's an array, but if I want to make it a 'pretty' object w/ stdClass() ... I can't define the fields in phpstan.

[julien-fontaine]

An issue already exists for this #2923
Note that PHPStorm does not support this feature yet (https://youtrack.jetbrains.com/issue/WI-66396), hoping that if PHPStan does, it will give this feature some weight.

[niconoe-]

Thanks for finding the original issue @julien-fontaine . Nevertheless, #2923 is closed and PHPStan still does not support this syntax, while it seems this suggest feature is accepted.

At least #2923 or this current issue (#6892) should be re-opened, don't you think?

[ondrejmirtes]

#2923 is not closed.

[niconoe-]

Sorry, I need some sleep 😅

[github-actions]

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.