Providing completion in a php file that returns a array

[RobinRadic]

I would like to provide completion in a .php file (for example like the one below (settings.php)) I do not want to add the definition inside the file itself. I simply want to add a reference towards it. Here's what i mean:

settings.php

/** @return array = \App\Example::example() */
return [
    '<caret>' // CODE COMPLETION HERE
];

App/Example.php

<?php
namespace App;
class Example {
    public static function example(){
        return  [
            'env'         => 'APP_NAME',
            'bind'        => 'app.name',
            'type'        => 'anomaly.field_type.text',
            'placeholder' => config('streams::distribution.name'),
            'config'      => [
                'default_value' => config('streams::distribution.name'),
            ],
        ];
    }
}

Is something like this possible?

[klesun]

Hi. Maybe you would consider defining the return value in a variable? Then you will be able to reference it in phpdoc:

[RobinRadic]

I want to use this on the config files in laravel/pyrocms The way you showed is not used in any of the config files and require my package (a code completion provider) to modify all those files in such a way. The package is open-source/public so i'd like it to change as little as possible. It would break consistency as well.

[klesun]

Hm, ok, seems reasonable enough. Released in 2019.11.18.002

[RobinRadic]

That's just awesome. Thanks a lot!