README

要创建项目，请打开您的终端并运行以下命令

composer create-project marcus-campos/simple-php-cli MyCliAppName

构建命令

要构建命令，只需运行 php run make: command <command_name>。

实用工具

当您创建命令时，您将可以访问到 Util 类。它通常位于您的类作用域内，请查看如何使用它

<?php

namespace App\Commands;


use Console\BaseCommand;
use Console\Contracts\ConsoleContract;

class ClassName extends BaseCommand implements ConsoleContract
{
    public function execute()
    {
        //Get the argument in the first position
        $argument = $this->util->args()['arguments'][0];
        //Prints a line in the console
        $this->util->output()->writeLn('Hello world!', 'green');
        //Prints a line in the console containing the value passed in the parameter
        $this->util->output()->writeLn('My param ' . $argument, 'green');
    }
}

Util 类包含了一些方法，可以帮助您创建命令，以下是一些方法的列表（点击了解更多）。

如何注册您的命令？

要注册命令，只需访问位于 ... /console/Command.php 文件中的 Command 类，向 $commands 数组添加另一个项目。例如

    private $commands = [
           ...
            'new:command' => [
                'action' => MyCommand::class.'@execute',
                'params' => [
                               'param1',
                               'param2',
                               'param3',
                               ...
                           ],
                'description' => 'My command description',
            ],
           ...
        ];

示例2

无参数的命令

    private $commands = [
           ...
            'sympla' => [
                'action' => SymplaCommand::class.'@inspire',
                'description' => 'Descrição do meu outro comando',
            ],
           ...
        ];

注意：在此数组中注册的参数仅用于帮助函数的描述。

如何执行命令？

要执行命令，只需键入

    php run <nome_do_comando>

示例

    php run help

如果命令有任何参数，请按如下方式执行

    php run <nome_do_comando> <parametro1> <parametro2>

示例

    php run make:command TestCommand

联系方式

Marcus Campos - campos.v.marcus@gmail.com

marcus-campos / simple-php-cli

维护者

详细信息