yngc0der / bitrix-cli

Bitrix 命令行界面

安装: 36

依赖: 0

建议: 0

安全: 0

星标: 6

关注者: 2

分支: 0

开放问题: 0

类型:bitrix-d7-module

v1.2.0 2022-07-18 07:49 UTC

This package is auto-updated.

Last update: 2024-09-18 12:54:56 UTC


README

安装

如果您在项目根目录之外使用Composer,则需要配置模块安装目录。

例如,如果文件 composer.json 位于 /local/ 目录中

...
"extra": {
    "bitrix-dir": "../bitrix"
},
...

之后,需要执行命令 composer require yngc0der/bitrix-cli,并通过Bitrix管理后台注册模块。

安装完成后,将创建用于控制台命令的入口点 - bitrix/tools/cli

使用

此包允许在Bitrix框架中使用 symfony/console。命令的详细说明请参阅文档(https://symfony.com.cn/doc/current/console.html

在控制台中执行 php bitrix/tools/cli 以获取简短的帮助和可用命令列表。

通过执行 php bitrix/tools/cli command args 来运行所需的命令。例如,php bitrix/tools/cli orm:annotate -c -m main

通过事件订阅注册命令

要注册自己的命令,需要订阅 yngc0der.cli 模块的 OnCommandsLoad 事件。

\Bitrix\Main\EventManager::getInstance()->addEventHandler(
    'yngc0der.cli',
    'OnCommandsLoad',
    function (\Bitrix\Main\Event $event) {
        $result = new \Bitrix\Main\EventResult(
            \Bitrix\Main\EventResult::SUCCESS,
            [
                new \Bitrix\Main\Cli\OrmAnnotateCommand(),  // instance of Symfony\Component\Console\Command\Command
            ]
        );
        
        return $result;
    }
);