mirrors/barryvdh_laravel-ide-helper
1
0
Fork 0
mirror of https://github.com/barryvdh/laravel-ide-helper.git synced 2026-08-21 11:33:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update readme

Browse Source
This commit is contained in:
Barry vd. Heuvel
2013-06-24 14:51:08 +02:00
parent 0f22941e51
commit 7f17da57b2
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
readme.md
+5 -5
View File
@@ -54,9 +54,9 @@ If you don't want to write your properties yourself, you can use the command `id
phpDocs, based on table columns, relations and getters/setters. Still in beta, so please provide feedback if you want. phpDocs, based on table columns, relations and getters/setters. Still in beta, so please provide feedback if you want.
Docs are written to a phpfile (_ide_helper_models.php) in the root of the project, so you can move the docs to the real model. Docs are written to a phpfile (_ide_helper_models.php) in the root of the project, so you can move the docs to the real model.
You can now also write the comments directly to your Model file, using the --write (-W) option. Please make sure to backup your models, before writing the info. You can now also write the comments directly to your Model file, using the `--write (-W)` option. Please make sure to backup your models, before writing the info.
It should keep the existing comments and only append new properties/methods. The existing phpdoc is replaced, or added if not found. It should keep the existing comments and only append new properties/methods. The existing phpdoc is replaced, or added if not found.
With the --reset (-R) option, the existing phpdocs are ignored, only the newly found columns/relations are saved as phpdocs. With the `--reset (-R)` option, the existing phpdocs are ignored, only the newly found columns/relations are saved as phpdocs.
php artisan ide-helper:models Post php artisan ide-helper:models Post
@@ -74,10 +74,10 @@ With the --reset (-R) option, the existing phpdocs are ignored, only the newly f
*/ */
For now, only models in app/models are scanned. The optional argument tells what models to use (also outside app/models). For now, only models in app/models are scanned. The optional argument tells what models to use (also outside app/models).
`php artisan ide-helper:models Post,User`
Note: With namespaces, uses \\ instead of \ php artisan ide-helper:models Post,User
`php artisan ide-helper:models API\\User`
Note: With namespaces, uses `\\` instead of `\`: `php artisan ide-helper:models API\\User`
### License ### License