vanengers/symfony-console-command-lib

Symfony 控制台命令库

v1.3.1 2024-04-23 11:33 UTC

This package is auto-updated.

Last update: 2024-09-23 12:35:39 UTC


README

Symfony 控制台命令库

安装

composer require vanengers/symfony-console-command-lib

使用

class MyCommand extends AbstractConsoleCommand {}

实现抽象方法,然后您就可以开始使用了。

executeCommand()

实际执行命令的方法,不要使用父类中的 execute() 方法

getCommandName()

这应该返回命令行中的命令名称

getCommandDescription()

这应该返回命令行中的命令描述

getOptions()

这应该返回一个数组,包含命令行中的选项。每个选项都将检查默认值和用户输入的值。查看 示例

只期望简单类型:数组、布尔值、整数、字符串

所有选项都作为选项输入,而不是参数。因此,所有选项都可以有默认值。

您可以通过将默认值设置为 null 并将必需标志设置为 true 来隐式要求输入

验证器

您可以在 getOptions 中向选项添加验证器

new Option('config', 'name param', 'string', null, true, null, [
    new FileExistsValidator(),
])

通过将默认值设置为 null 并将必需设置为 true,您可以要求一个存在的文件。设置验证器很容易,只需创建一个实现 IParamValidate 接口的类并将其添加到选项中。