PHPStorm + PHPDoc — Can I type-hint an individual array element?

Question

I have:

$myarr['DB'] = new DB();
$myarr['config'] = new config();

Can I somehow make PhpStorm to know exactly what is inside those keys? For now I see hinting for variables and class properties only, but not array keys.

In general: confluence.jetbrains.com/display/PhpStorm/… (but it seems a bit broken? right now). — LazyOne
– LazyOne, Commented Sep 16, 2015 at 14:56

SWilk · Accepted Answer · 2022-04-04 02:19:04Z

24

Late answer, but things have changed.

According to 2021.2 changelist it is possible now to define shape of a simple array with one line comment:

/**
 * @return array{id: int, name: string, object: \Of\Some\Class}
 */
function getArray(): array {...}

If there are object-like arrays in your code, you can now define their structure with this PHPDoc annotation: array{key: type, key: type, ...}.

PhpStorm provides code completion for such annotated arrays, reducing the time you spend on routine typing and protecting you from mistakes.

The support is limited to one-line array shape definitions. For larger structures, it is often better to use real objects and classes.

Unfortunatelly I have not found a way to define structure of multi dimensional array, and it would be great to annotate a list of such "shaped" arrays...

edited Apr 4, 2022 at 2:19

answered Aug 24, 2021 at 9:37

SWilk

3,5068 gold badges33 silver badges52 bronze badges

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

Comments

Vlad Moyseenko · Accepted Answer · 2022-12-04 16:02:37Z

4

According to https://youtrack.jetbrains.com/issue/WI-59083/recognize-use-of-list-with-array-shapes it is possible now to describe even item shape in the list:

/**
 * @return array<int, array{id: int, name: string}>
 */
function getShapedArray(): array {...}

Works nice with for loops, but no completion when:

$array = getShapedArray();
$elementId = 2;
// No completion for name property.
$array[$elementId]['name'];

answered Dec 4, 2022 at 16:02

Vlad Moyseenko

2434 silver badges9 bronze badges

Comments

Denis Orlov · Accepted Answer · 2016-10-01 18:39:33Z

3

You can define the array keys in advance, then PHPStorm will suggest them (CTRL+space)

$my = array();
$my['qwe'] = '';
$my['asd'] = '';
$my['zxc'] = '';

$my['']// inside '' will be autosuggest

You can also use phpdoc (CTRL+Q):

/**
 * keys:
 * <pre>
 * some_array   (array)
 * some_bool    (boolean)
 * some_double  (double)
 * some_nice_integer    (integer)
 * </pre>
 * @return array
 */
public function toArray(){
    // return some array
}

edited Oct 1, 2016 at 18:39

answered Oct 1, 2016 at 14:40

Denis Orlov

1476 bronze badges

Comments

artlung · Accepted Answer · 2023-05-10 19:18:20Z

1

This can be done inline. Array shapes were added in phpStorm as of 2021.

/* @var $myarr array{DB: DB, config: config}*/
$myarr['DB'] = new DB();
$myarr['config'] = new config();

answered May 10, 2023 at 19:18

artlung

34k19 gold badges76 silver badges124 bronze badges

Comments

miken32 · Accepted Answer · 2024-04-20 20:53:48Z

This is done with attributes in modern PHPStorm versions.

use JetBrains\PhpStorm\ArrayShape;

#[ArrayShape(["DB" => \DB::class, "config" => \config::class])]
private array $myarr;

As with the PHPDoc comments in other answers, there does not appear to be any enforcement of these types (e.g. IDE notices when assigning an unexpected type of value would be nice) but it does allow auto-complete at least.

Typically I will define all my array shapes in a single constant and then refer to it later:

<?php

namespace App;

use JetBrains\PhpStorm\ArrayShape;

class MyClass {
    private const array ARRAY_SHAPE = [
        "myMethod" => ["foo" => "string", "bar" => "int[]"],
        "otherMethod" => ["prop1" => "self", "prop2" => \PDO::class],
    ];

    #[ArrayShape(self::ARRAY_SHAPE["myMethod"])]
    public function myMethod(): array {
        // ...
    }

    #[ArrayShape(self::ARRAY_SHAPE["otherMethod"])]
    public function otherMethod(): array {
        // ...
    }
}

Onedev_Link · Accepted Answer · 2015-09-16 14:42:29Z

0

This functional is not realized yet in PhpStorm. Vote for support array access feature request.

Also you can try silex idea plugin.

answered Sep 16, 2015 at 14:42

Onedev_Link

2,01215 silver badges27 bronze badges

1 Comment

frenzy Over a year ago

Think it more about when PHP knows structure at first place. I, for example, returning rows with JSON from DB witch decoded then to 4D array, and it good to have hinting for theme. But only way to do it is PHPdocking, and sadly there is no syntax for that=(

Khairul Islam · Accepted Answer · 2024-04-11 14:38:57Z

-1

For an arbitrary array, PHPStorm has no idea of the keys used in it and thus does not provide hints. It is even possible to prove that it is impossible to reliably implement such a feature, so I think you are out of luck here.

Collected From:

Stackoverflow answer to: "How to get intellisense for PHP associative array index? [duplicate]"

edited Apr 11, 2024 at 14:38

user633440

answered Sep 16, 2015 at 14:43

Khairul Islam

1,2151 gold badge9 silver badges20 bronze badges

3 Comments

frenzy Over a year ago

Don't think that DHPdocing class properties is somewhat more reliable. Why not to make feture to PHPdoc array keys? Especially useful when working with service containers.

j.steelman Over a year ago

Not Impossible, just difficult. plugins.jetbrains.com/plugin/9927-deep-assoc-completion works like a champ with no apparent performance reduction (phpStorm is a bit of a beast so another second or so generating an index would go unnoticed). Been using it for a few days in laravel and WP projects - its lovely.

CAAHS Over a year ago

Apart from if using PhpStorm deep-assoc-completion is the companion (and works like a charm), the (needlessly dv'ed) answer about casting of an array already demonstrated the same as the answer without such an object cast demonstrates that there already was support before the PHPDoc Array Shape syntax (which again deep-assoc-completion supported already earlier than PhpStorm itself — and with template types btw.). Mentioning the halting problem is interesting in that regard still.

Bugs · Accepted Answer · 2018-11-05 16:50:37Z

-3

$obj = (object)[]; // Cast empty array to object

add properties:
$obj->x = 'some'
$obj->y = 'hints'

Now, PHPStorm, when typing $obj-> ..... hints x and y

edited Nov 5, 2018 at 16:50

Bugs

4,4799 gold badges34 silver badges41 bronze badges

answered Nov 5, 2018 at 16:33

Ja Loc

631 silver badge4 bronze badges

1 Comment

jurchiks Over a year ago

Avoid type casting by using new stdClass().

Collectives™ on Stack Overflow

PHPStorm + PHPDoc — Can I type-hint an individual array element?

8 Answers 8

Comments

Comments

Comments

Comments

Comments

1 Comment

3 Comments

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

8 Answers 8

Comments

Comments

Comments

Comments

Comments

1 Comment

3 Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related