mikedeveloper/october-ide-helper

October IDE Helper, generates correct PHPDocs for all Facade classes, to improve auto-completion.

v1.0.3 2021-04-07 13:00 UTC

Requires

• php: ^7.2 || ^8.0
• ext-json: *
• barryvdh/reflection-docblock: ^2.0.6
• composer/composer: ^1.6 || ^2
• doctrine/dbal: ^2.6 || ^3
• illuminate/console: ^6
• illuminate/filesystem: ^6
• illuminate/support: ^6
• nikic/php-parser: ^4.7
• phpdocumentor/type-resolver: ^1.1.0

Requires (Dev)

• ext-pdo_sqlite: *
• friendsofphp/php-cs-fixer: ^2
• illuminate/config: ^6
• illuminate/view: ^6
• phpunit/phpunit: ^8.5 || ^9

MIT

• Michelangelo Lacatena

• phpdoc
• autocomplete
• helper
• laravel
• ide
• phpstorm
• netbeans
• sublime
• codeintel

README

Complete PHPDocs, directly from the source

This package generates helper files that enable your IDE to provide accurate autocompletion. Generation is done based on the files in your project, so they are always up-to-date.

Installation

Require this package with composer using the following command:

composer require --dev mikedevs/october-ide-helper

Add the following class to the providers array in config/app.php:

  Mikedevs\OctoberIdeHelper\IdeHelperServiceProvider::class,

Note: Avoid caching the configuration in your development environment, it may cause issues after installing this package; respectively clear the cache beforehand via php artisan cache:clear if you encounter problems when running the commands

Usage

You can re-generate the docs yourself (for future updates)

php artisan mikedevs:october-ide-helper:models --dir="path/to/plugin/models"

/**

• @property integer $id
• @property integer $author_id
• @property string $title
• @property string $text
• @property \Illuminate\Support\Carbon $created_at
• @property \Illuminate\Support\Carbon $updated_at
• @property-read \User $author
• @property-read \Illuminate\Database\Eloquent\Collection|\Comment[] $comments
• @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Post newModelQuery()
• @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Post newQuery()
• @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Post query()
• @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Post whereTitle($value)
• … */