Dzisiejszy wpis rozpoczyna serię „Paczka tygodnia”, w której opisywane będą paczki (głównie do Laravela) usprawniające prace nad projektami. Nową serię inauguruje Laravel IDE Helper Generator – narzędzie, dzięki któremu IDE będzie pokazywało podpowiedzi dla kodu frameworka oraz utworzonych przez nas modeli.

Jedną z niewielu rzeczy jakie mi przeszkadzają podczas tworzenia aplikacji opartych o Laravela, to brak podpowiadania składni dla fasad oferowanych przez ten framework. Powoduje to, że za każdym razem muszę sięgać do dokumentacji, aby przypomnieć sobie jakie parametry przyjmowała dana metoda lub jakie w ogóle metody są dostępne. Dzięki Laravel IDE Helper Generator problem ten przestał istnieć.

Paczkę zainstalujemy poleceniem

composer require barryvdh/laravel-ide-helper

Po zainstalowaniu musimy w pliku app/config/app.php dodać ServiceProvidera

'Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider'

Od teraz możemy korzystać z nowego polecenia dostępnego z poziomu php artisan

php artisan ide-helper:generate

Należy pamiętać żeby przed uruchomieniem tego polecenia, wyczyścić plik bootstrap/compiled.php. Zrobimy to poleceniem

php artisan clear-compiled

Ciekawie prezentuje się możliwość wygenerowania dokumentacji phpDoc do utworzonych przez nas modeli, dzięki czemu będziemy mieli dostęp do nazw kolumn znajdujących się w bazie. Jeśli chcemy skorzystać z generowania dokumentacji dla modeli, musimy wpierw zainstalować w projekcie zależność w postaci doctrine/dbal: ~2.3. Po spełnieniu tego warunku możemy przystąpić do generowania dokumentacji naszych modeli.

php artisan ide-helper:models Post

Nie są to jedyne możliwości jakie daje ta paczka. Więcej na jej temat przeczytacie na stronie projektu.