README

这是一个用于自动生成模型类和apidoc文档的Yii 2扩展（命令）。此命令中的操作通常不应在生产服务器上运行。这里提到的操作将生成开发或测试中可能用到的文件和数据。在执行这些操作时，控制器将生成一个警告提示，您可以覆盖。

功能

基于给定的数据库连接生成模型类。
生成扩展（自定义）基类的模型类。
基于自定义文件夹中的apidoc注释块生成apidoc文档。

要求

PHP >= 5.6.0
Composer >= 1.1.2 (https://getcomposer.org.cn/)
Node.js >= 8.1.0 (https://node.org.cn/en/)
apidoc >= 0.17.6 (npm install -g apidoc)

安装

composer require blurrywindows/yii2-auto-command

配置

将以下行添加到您的 console.php 配置文件中

'controllerMap' => [
        'auto' => [
            'class' => 'blurrywindows\AutoCommand\AutoCommand',
            'baseClass' => 'app\models\BaseActiveRecord', // or 'yii\db\ActiveRecord' if you want to use the Yii 2 ActiveRecord as base
            'modelsFolder' => 'models', //Relative to app directory
            'modelsNamespace' => 'app\models',
            'apidocInputFolder' => 'controllers', //Relative to app directory
            'apidocOutputFolder' => 'web/apidoc', //Relative to app directory
            'skipTables' => ['migration'],
        ],
    ],

控制台命令

./yii auto/all

执行AutoController中的所有操作。

./yii auto/gii-models

在您选择的输出文件夹中为数据库中的所有表生成ActiveRecords。如果存在，它将自动覆盖ActiveRecords。ActiveRecords命名为Base[Tablename]并扩展您选择的基类。它还创建一个名为[Tablename]的类，该类扩展Base[Tablename]用于自定义代码、额外验证规则等。当再次执行操作时，不会覆盖[Tablename]类。

./yii auto/apidoc

根据apidoc从您选择的输入文件夹中的注释生成API文档。它将文档输出到您选择的输出文件夹。如果您想将文档导出到生产服务器，可以将此文件夹包含在Git中。请注意，apidoc是Node.js的dev-dependency。它仅在执行npm install命令时安装。

如何贡献？

您可以以任何您喜欢的方式做出贡献，但请先联系我，以通过创建问题来避免合并冲突。

问题

如果您对此命令有任何疑问或遇到任何问题，请提交一个问题。

blurrywindows / yii2-auto-command

维护者

详细信息