library yii2-ide-helper {🖫 1,570, ⚐ 4, ★ 8}

mis/yii2-ide-helper

Yii2 IDE Helper, generates correct PHPDocs for all components, to improve auto-completion.

Monday, December 18, 2017
by takashiki
Repository
5 Watchers
8 Stars
1,570 Installations

PHP
1 Dependents
0 Suggesters
1 Forks
0 Open issues
4 Versions
108 % Grown

The README.md

Yii2 IDE Helper Generator

Install

Require this package with composer using the following command:, _(*1)

composer require mis/yii2-ide-helper --dev

or add, _(*2)

"mis/yii2-ide-helper": "*"

to the require-dev section of your composer.json file., _(*3)

Usage

After updating composer, add the component to the components array and bootstrap array in config file of console application:, _(*4)

'bootstrap' => ['log', 'ideHelper'],
...
'components' => [
    'ideHelper' => [
        'class' => 'Mis\IdeHelper\IdeHelper',
    ],
  ...
],

Now you can generate ide helper file by command:, _(*5)

php yii ide-helper/generate

Options

'ideHelper' => [
    'class' => 'Mis\IdeHelper\IdeHelper',
    'filename' => '_ide_helper',
    'format' => 'php',
    'rootDir' => dirname(__DIR__),
    'configFiles' => [
        'console/config/main.php',
        'console/config/main-local.php',
    ],
],

Default config files:, _(*6)

protected $defaultConfigFiles = [
    'config/web.php',
    'config/main.php',
    'config/main-local.php',
    'common/config/main.php',
    'common/config/main-local.php',
    'frontend/config/main.php',
    'frontend/config/main-local.php',
    'backend/config/main.php',
    'backend/config/main-local.php',
];