How to enable autocomplete for Laravel Resources in PhpStorm?

Question

Laravel 5.5 has a new API Resources feature, and it nicely redirects calls to model attributes (like $this->id). I use ide-helper:models to generate phpdocs for models that type-hints all model attributes. However, this does not apply to a resource and I get "Field accessed via magic method" squigglies. Is there a way to point it to model's phpdoc without copying it?

Why would you ever have to get the properties of a resource in your PHP code? I think you are misunderstanding what API resources are meant for. An API ressource is meant to convert a model into a easy object to return to the HTTP response. — techbech
– techbech, Commented Oct 2, 2017 at 14:07
How am I supposed to convert properties without getting them? My toArray method looks like return ['id' => $this->id, 'name' => $this->name]; and I have no autocompletion on $this properties — Poma
– Poma, Commented Oct 2, 2017 at 14:41
Ooh sorry. I misunderstood your question then. I added an answer. — techbech
– techbech, Commented Oct 2, 2017 at 20:48

techbech · Accepted Answer · 2017-10-02 20:47:52Z

47

You can use the @mixin

Here is an example, If you want the properties/phpdocs from the User model in your User Resource, then do like this

namespace App\Http\Resources;

use Illuminate\Http\Resources\Json\Resource;

/**
 * Class User
 *
 * @mixin \User
 * */
class User extends Resource
{
    public function toArray($request)
    {
        return [
            'id' => $this->id,
            'name' => $this->name,
            'email' => $this->email,
            'created_at' => $this->created_at,
            'updated_at' => $this->updated_at,
        ];
    }
}

answered Oct 2, 2017 at 20:47

techbech

3,9145 gold badges25 silver badges28 bronze badges

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

1 Comment

Roman Lopez Over a year ago

Oh man! Just came across this today and wow! What a savior!

Collectives™ on Stack Overflow

How to enable autocomplete for Laravel Resources in PhpStorm?

1 Answer 1

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related