yacon/yii2-ide-helper

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

1.0 2023-10-31 04:49 UTC

Requires

• php: >=7.0.0
• yiisoft/yii2: *

MIT

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

README

Install

Require this package with composer using the following command:

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

Usage

After updating composer, add the component to the components array and bootstrap array in config file of console application:

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

Now you can generate ide helper file by command:

./yii ide-helper/generate

Options

'ideHelper' => [
    'class' => 'yacon\IdeHelper\IdeHelper',
    'rootDir' => dirname(dirname(__DIR__)),
],

Default config files:

protected $defaultConfigFiles = [
    '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',
];