Eloquent ORM Code Hinting in PhpStorm

by

For future Googlers, and perhaps OP as well if you are still sticking to Laravel.

The laravel-ide-helper package solves this issue for you quite elegantly, with what I believe is a relatively new feature; generated model PHPDocs.

You can generate a separate file for all PHPDocs with this command:

php artisan ide-helper:models

The generated metadata will look something like this for each class:

namespace App {
/**
 * App\Post
 *
 * @property integer $id
 * @property integer $author_id
 * @property string $title
 * @property string $text
 * @property \Carbon\Carbon $created_at
 * @property \Carbon\Carbon $updated_at
 * @property-read \User $author
 * @property-read \Illuminate\Database\Eloquent\Collection|\Comment[] $comments
 */
class Post {}
}

This caused issues for me in PHPStorm however, where the software was complaining about multiple class definitions. Luckily an option is readily available for writing directly to the model files:

php artisan ide-helper:models -W

There are a few more options and settings available if you need to tweak the behavior, but this is the gist of it.

More Related Contents:

  1. Laravel one to many relation with a one to one relation
  2. How do I get the query builder to output its raw SQL query as a string?
  3. Get the Last Inserted Id Using Laravel Eloquent
  4. Bulk Insertion in Laravel using eloquent ORM
  5. Laravel Check If Related Model Exists
  6. Creating and Update Laravel Eloquent
  7. Laravel, sync() – how to sync an array and also pass additional pivot fields?
  8. How to sort a Laravel query builder result by multiple columns?
  9. How to alias a table in Laravel Eloquent queries (or using Query Builder)?
  10. Laravel Model with Two Primary Keys update [duplicate]
  11. Laravel eager loading with limit
  12. Laravel 5.2 – Use a String as a Custom Primary Key for Eloquent Table becomes 0
  13. Laravel Eloquent: How to order results of related models?
  14. Laravel 4: how to “order by” using Eloquent ORM [duplicate]
  15. How to alias the name of a column in Eloquent
  16. Laravel $q->where() between dates
  17. Laravel – Database, Table and Column Naming Conventions?
  18. How to Make Laravel Eloquent “IN” Query?
  19. How to Merge Two Eloquent Collections?
  20. Update without touching timestamps (Laravel)
  21. laravel collection to array
  22. Laravel Eloquent sort by relation table column
  23. Eloquent Parent-Child relationship on same model
  24. Laravel 4.1: How to paginate eloquent eager relationship?
  25. Natural ORDER in Laravel Eloquent ORM
  26. Laravel Eloquent: How to get only certain columns from joined tables
  27. Find or Create with Eloquent
  28. How to get last insert id in Eloquent ORM laravel
  29. Laravel Many to many self referencing table only works one way
  30. Merge ‘with’ and ‘whereHas’ in Laravel 5

Leave a Comment