glowieframework / ide-helper
Glowie plugin for type-hinting models
Requires
This package is auto-updated.
Last update: 2026-06-09 23:44:58 UTC
README
This is a developer-tooling plugin for Glowie Framework that automatically generates and updates PHPDoc @property annotations for your DB models.
By default, magic properties in PHP models are "invisible" to IDEs like VS Code or PhpStorm. This plugin introspects your database schema, model casts, and relationships to inject accurate DocBlocks directly into your model files.
Installation
Install in your Glowie project using Composer:
composer require glowieframework/ide-helper
Then add the IdeHelper class to the plugins array in the app/config/Config.php file:
'plugins' => [ // ... other plugins here \Glowie\Plugins\IdeHelper\IdeHelper::class, ],
Usage
In your Glowie project, run in the terminal:
php firefly ide-helper:run
By default, models are processed from the app/models directory and all its subdirectories. To specify a different path, use the --dir argument.
Credits
IDE Helper and Glowie are actively developed by Gabriel Silva.