Request: Ability to ignore models when generating php docs for models

[abishekrsrikaanth]

Can a configuration be provided using which some models can be ignored when generating php docs for the models.

My use case is the following:
My application has few models communicating to MongoDB and some to MySQL.
When ide-helper generates the phpdocs, it throws and error

Exception: call_user_func_array() expects parameter 1 to be a valid callback, class 'MongoDB' does not have a method 'getDoctrineDriver'
Could not analyze class Action.

So this just errors out and does not generate the PHP docs.

So if there was a configuration, something like

php artisan ide-helper:models ignore-models:Model1,Model2

we could ignore the required models.

[barryvdh]

You can do the opposite, set which models you do want to get checked.
But I'll see if i can add this feature, or at least some better erorr checking so it continues.

[abishekrsrikaanth]

I understand @barryvdh, but it becomes very difficult if there are a lot of models. I actually wanted to generate for all the models but as I said, it errors out for the MongoDB models and doesn;t generate the docs...

[abishekrsrikaanth]

Can you also provide as a configuration for the console read that you ask when generating models

Do you want to overwrite the existing model files for '*'? 
Choose no to write to _ide_helper_models.php instead? (Yes/No):

like

php artisan ide-helper:models overwrite:no

both these configurations help when you want to automate using the composer scripts.
i have an .sh script that pull all the git files of other users and then executes the ide-helper. But haven't been able to use the models functionality as of now.

[barryvdh]

Well, I actually wanted to make 'yes' the default option, but to not break for existing people, I added a suggestion.
The No option didn't really seem useful for me, so there is only a -W (force yes) option. Perhaps I can add a no shortcut also.

[abishekrsrikaanth]

I was actually scared to use the -W option, because if I had any custom functions or relationships, was worried if they get overwritten as well, haven't tried this option at all.

cool, will look forward to this. Thanks for considering this..

[barryvdh]

Okay, added a --nowrite (-N) and --ignore (-I) option.
I looked at catching, but it looks like is actually is catching the Exception, so it should just continue. Strange it doesn't.

The -W option should just overwrite the phpdocs, but it is good to make a backup before trying ;)
It works fine in my projects and makes it a lot easier to update phpdocs.

[abishekrsrikaanth]

cool stuff, let me try it now.

[vaishnavmhetre]

Unfortunately, this getDoctrineDriver issue has raised over User model and seems like it is also related to MongoDB package, as I'm using jenssegers/mongodb

[RiccardoManzan]

Is it possible to get this working setting a mode that ignores database entity schematics but keeps generating phpdocs for scope methods and things like that?
It would be reeeeeally useful.

[amirhs712]

Is it possible to get this working setting a mode that ignores database entity schematics but keeps generating phpdocs for scope methods and things like that?
It would be reeeeeally useful.

Agreed, It would be nice to have basic phpdocs for mongodb models.
Also, some relationships are supported by jenssegers/mongodb.

[MrHaroldA]

Is it possible to get this working setting a mode that ignores database entity schematics but keeps generating phpdocs for scope methods and things like that?
It would be reeeeeally useful.

Agreed, It would be nice to have basic phpdocs for mongodb models.
Also, some relationships are supported by jenssegers/mongodb.

I'm pretty late to the party, but connectionless Eloquent-like models like Jenssegers\Model would fit the Mongo case as well.