Yii2 IDE Helper
PHP Smarty
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
src
tests
.gitattributes
.gitignore
LICENSE
composer.json
readme.md

readme.md

Yii2 IDE Helper Generator

Install

Require this package with composer using the following command:

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

or add

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

to the require-dev section of your composer.json file.

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' => 'Mis\IdeHelper\IdeHelper',
    ],
  ...
],

Now you can generate ide helper file by command:

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:

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',
];