From ff7d2a33b0567900a105e6be70cef6383ae10602 Mon Sep 17 00:00:00 2001 From: "Barry vd. Heuvel" Date: Fri, 18 Oct 2013 10:29:48 +0200 Subject: [PATCH] Update readme --- readme.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/readme.md b/readme.md index c042bb1..97c2e0b 100644 --- a/readme.md +++ b/readme.md @@ -53,7 +53,8 @@ The Illuminate/Support/helpers.php is already set-up, but you can add/remove you If you don't want to write your properties yourself, you can use the command `ide-helper:models` to generate phpDocs, based on table columns, relations and getters/setters. Still in beta, so please provide feedback if you want. You can now also write the comments directly to your Model file, using the `--write (-W)` option. By default, you are asked to overwrite or -write to a seperate file (_ide_helper_models.php) Please make sure to backup your models, before writing the info. +write to a seperate file (_ide_helper_models.php) (You can force No with `--nowrite (-N)`). +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. With the `--reset (-R)` option, the existing phpdocs are ignored, only the newly found columns/relations are saved as phpdocs. @@ -80,6 +81,10 @@ You can also scan a different directory, using the --dir option (relative from t php artisan ide-helper:models --dir="app/workbench/name/package/models" +Models can be ignored using the --ignore (-I) option + + php artisan ide-helper:models --ignore="Post,User" + Note: With namespaces, wrap your model name in " signs: `php artisan ide-helper:models "API\User"`, or escape the slashes (`Api\\User`) ### License