Describe an array containing an object (stdClass) with @phpstan-return in PHP DocBlock? - PHPStan

Question

I have an example function in PHP (8.2) that returns an array. Inside this array there is also an object, more precisely stdClass.

I use PHPStan as a static analyzer tool. How can I specify this (object shapes) structure syntactically correct to use it in @phpstan-return using PHPStan Array shapes ?

The example function getBooks():

function getBook(): array
{
    $author = new stdClass();
    $author->firstName = 'John';
    $author->lastName = 'Doe';

    return [
        'id' => 12345,
        'title' => 'Whoever may help me deserves a big "Thank You!"',
        'authors' => $author,
    ];
}

What I already tried and is an invalid syntax:

/**
 * @phpstan-return array{
 *     id: int,
 *     title: string,
 *     authors: object{
 *         firstName: string,
 *         lastName: string,
 *     },
 * }
 */

What I definitely already know is, that the object { .. } part is the syntactically incorrect one here.

As of PHPStan v1.10 object shapes are not supported currently. Also see github.com/phpstan/phpstan/issues/2923 and github.com/phpstan/phpstan/issues/6892 and the PR github.com/phpstan/phpdoc-parser/pull/141 — WebDevPassion
– WebDevPassion, Commented Mar 3, 2023 at 14:24
I guess the natural question is: if you can describe the shape to a static analyser, why would you not describe that shape to PHP itself, by defining a named class? — IMSoP
– IMSoP, Commented Jun 22, 2023 at 13:36

Sylver · Accepted Answer · 2023-06-22 13:33:15Z

8

As of PHPStan 1.10.12 this is now possible:

https://phpstan.org/writing-php-code/phpdoc-types#object-shapes

So, for your case, that would be written:

/**
 * @return object{
 *     id: int,
 *     title: string,
 *     authors: object{
 *         firstName: string,
 *         lastName: string,
 *     },
 * }
 */

answered Jun 22, 2023 at 13:33

Sylver

2,4833 gold badges33 silver badges44 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

fusion3k · Accepted Answer · 2023-03-03 14:35:00Z

1

You can define the associative array architecture with the array<keyType, valType|valType|...> pattern:

/** @return array<string, int|stdClass|string> */
function getBook(): array
{ ... }

PHPStan demo

or specify that it is a mixed array:

/** @return array<mixed> */
function getBook(): array
{ ... }

answered Mar 3, 2023 at 14:35

fusion3k

11.7k4 gold badges27 silver badges47 bronze badges

Collectives™ on Stack Overflow

Describe an array containing an object (stdClass) with @phpstan-return in PHP DocBlock? - PHPStan

2 Answers 2

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related