Level 39
I will often use Tinker to look at the first record...
php artisan tinker
>>> User::first();
Sep 28, 2021
12
Level 14
How can I know what fields I have on my Model without looking at my database?
Having worked with Symfony, I have a question about Eloquent Models. In Symfony all the attributes are right there in the Model/Entity class so you get auto-completion and you know what fields your Model has without having to open your database and look at the columns.
Symfony:
class User extends ...
{
private $username;
private $password;
private $street_address;
private $phone_number;
private $created_at;
private $updated_at;
}
But in Laravel you do not see these fields on Model itself.
class User extends Model
{
}
Which means you get no auto-completion and you do not know what fields you have unless you open your database, go to the table and look at the columns. Or you have to trace it through all the different migrations for that table.
Or am I missing something here?
Level 14
@lbecket But that doesn't give you auto-completion in the IDE
Level 39
@martinszeltins Indeed... I was just saying that I often find Tinker to be the fastest reference. Maybe copying them from your migration as comments into your model would cause your IDE to pick them up. Just spit-balling here...
Level 75
From API you can use getColumnListing.
Reference:
https://laravel.com/api/8.x/Illuminate/Database/Schema/MySqlBuilder.html#method_getColumnListing
Also there's
https://laravel.com/api/8.x/Illuminate/Database/Schema/Builder.html#method_getColumnListing
Level 14
@jlrdw Isn't that a lot of work just to see the columns?
Level 75
@martinszeltins I didn't think it was:
DB::getSchemaBuilder()->getColumnListing('table_name_here');
Edit: Okay you want them somehow auto completed. I thought you meant listing of columns..
1 like
Level 4
@jlrdw the best answer, thanks!
1 like
Level 27
@martinszeltins I think you can rephrase your title to get better answers:
One I can think of is Auto-complete for Model attributes
Level 27
I did a quick google and found this https://stackoverflow.com/questions/48211622/intellisense-autocompletion-for-model-in-laravel-for-visual-studio-code-or-ano
Hope it helps. I going to try out in a bit too!
Level 102
I believe you should be able to add this above your class. But I think most people use Laravel Idea https://plugins.jetbrains.com/plugin/13441-laravel-idea
/**
* @property string $username
* @property string $password
*/
3 likes
Level 14
@Sinnbeck I see. I wonder why Laravel makes it a bit difficult here to have auto-completion.
Level 102
@martinszeltins Honestly I havent tried just adding private properties.. So you can give that a try. Just tested it quickly and it worked fine. So maybe you can do it just the same if you prefer (you just cannot use the property names that are already in use)
Please or to participate in this conversation.