bazilio/yii2-stubs-generator

Yii2 component stubs generator for Yii::$app

Installs: 123 959

Dependents: 1

Suggesters: 1

Security: 0

Stars: 142

Watchers: 14

Forks: 26

Open Issues: 3

Type:yii2-extension

1.6.2 2020-11-27 06:47 UTC

This package is auto-updated.

Last update: 2021-01-27 07:11:24 UTC


README

Latest Stable Version Total Downloads Latest Unstable Version License

This extension provides no-more-butthurt components & user identity autocomplete generator command for Yii 2.

in action

Installation

The preferred way to install this extension is through composer.

Either run

php composer.phar require --dev --prefer-dist bazilio/yii2-stubs-generator

or add

"bazilio/yii2-stubs-generator": "~1"

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

Usage

To use this extension, simply add the following code in your application configuration (console.php):

'controllerMap' => [
    'stubs' => [
        'class' => 'bazilio\stubsgenerator\StubsController',
    ],
],
# generate stubs for console application
php yii stubs console/config/main.php

# to generate stubs for several apps
php yii stubs console/config/main.php common/config/main.php frontend/config/main.php

File with stubs by default located in vendor directory.

Usage with PhpStorm

  1. Install File Watchers JetBrains plugin
  2. Open File Watchers plugin config and import watcher.xml
  3. Edit imported watcher for your needs
  4. Add scope to limit trigger to config files:

PhpStorm "multiple definitions exist for class"

To hide this message:

  1. Find a duplicate class file (not created by this generator), for example: vendor/yiisoft/yii/YiiBase.php
  2. Mark it as a plain text in file context menu.