[Feature]: Model, CTRL click should lead to model, not _laravel_ide/_model_helpers.php

[dac514]

Feature Description

Given:

$this->someModel->foo

When hovering my mouse over someModel I am shown the correct class information.

But, when I ctrl+click someModel, it leads to the definition in vendor/_laravel_ide/_model_helpers.php

Instead, it should lead to the actual model file.

Thank you for your consideration.

[N1ebieski]

I don’t think this is an issue with the Laravel VS Code Extension, but rather with Intelephense. You can exclude scanning of vendor/_laravel_ide/_model_helpers.php using the intelephense.files.exclude config, but you’ll probably lose autocompletion.

[dac514]

Ok thanks, i'll report it over there.

[bmewburn]

I haven't looked at how _model_helpers.php works but I'm presuming it adds a model stub and then adds @property annotations for the laravel relationships?

For synergy with other static analysis tools, it would be nice if there is an option to generate the annotations on the real model instead like how barryvdh/laravel-ide-helper does it. Or perhaps an inline {@see } to the relationship method (does it provide that already?). The problem in intelephense is that there is no property to jump to in the real model unless a laravel specific implementation is added that links magic properties to relationship methods.

[N1ebieski]

Oh, I see. Thanks @bmewburn for the explanation.

Solution is:

/**
 * @mixin IdeHelperExample
 */
final class Example extends Model

in the Model file, and:

namespace App\Models{
/**
 * @property int $id
 * @mixin \Eloquent
 */
	#[\AllowDynamicProperties]
	final class IdeHelperExample {}
}

in the .stub file.

But this would require the VS Code extension to modify the project files. I don't think this would be a good idea... maybe as an additional, not default option in the settings? @joetannenbaum

[bmewburn]

But this would require the VS Code extension to modify the project files

I understand the hesitation, but I don't think it's unusual for an extension to do this, as an option of course. For database properties, a static analyser tool can't really jump anywhere but the annotations (or __get but I don't think that is useful in this case), which is why it would be nice to have on the real model.

Relationship properties/scopes are slightly different as they have distinct methods associated with them. Even if they stayed in separate models, it would be nice if there was an inline @see added. I'd like to put an option in intelephense that includes the @see definition in the go to definition results or maybe even inherits the relationship method description for hover results.

For example:

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\HasOne;

/**
 * @property-read Phone|null $phone See {@see User::phone()}
 */
class User extends Model
{
    /**
     * Get the phone associated with the user.
     */
    public function phone(): HasOne
    {
        return $this->hasOne(Phone::class);
    }
}

(new User())->phone; // <- Could jump to or include phone() as a go to location or show phone() description