本文介绍php开发中必备的一个工具ide-helper,github主页为:https://github.com/barryvdh/laravel-ide-helper。本工具主要用于eloquent作为orm框架时的开发。
由于php是弱类型语言,导致很多开发者养成了使用数组索引访问变量值的不良习惯,比如,User['name']。这种访问方式有以下缺点:
为什么要使用ide-helper
php提供了phpDoc实现代码提示的功能。某些编辑器已经实现了此功能。
比如下图中的model中实现了下面几个phpDoc。其中包括一个名为id的属性。一个名为createUser的类型为UserModel的只读属性,一个名为newModelQueury的静态方法,一个名为WhereAccountLimit的实例方法。有了这些注释,则可以使用箭头符号来访问此字段,并且开发环境会提供代码补全功能。更厉害的是这些成员都是可以重构的。phpstorm中shift+f6可以直接重构此属性的访问。非常安全和便捷。
ide-helper可以根据model类对应的数据表自动生成此model的所有字段和工具方法的phpDoc。
ide-helper还可以生成magic where方法,比如在eloquent中我们查询一个where条件写作:where('id',1);而ide-helper将会为你生成一个whereId的方法phpDoc。你可以直接调用此方法,比如:whereId(1),此方法避免输入更多的字符串。
如何使用ide-helper请参考github主页即可。大概过程为composer安装ide-herlp然后执行命令php artisan ide-helper:models即可。
获取IDEA激活码
热门评论