使用enygma/cmd如何简化命令行参数解析

在开发命令行工具时,经常需要处理用户通过命令行传递的各种参数。手动解析 $_SERVER[‘argv’] 数组不仅代码冗长,而且容易出错。例如,需要区分普通参数、带值的参数、以及各种简写形式,处理起来非常麻烦。此外,为了让命令行工具更加友好,还需要提供格式化的输出,例如成功、警告、错误等不同类型的消息。 composer在线学习地址:学习地址enygma/cmd 库正是为了解决这些问题而诞生的。它提供了一个简单易用的 Command 类,可以将 $_SERVER[‘argv’] 解析为键值对,并且支持设置默认值和必需参数。同时,它还提供了一个 Output 类,可以方便地输出格式化的消息。

安装

使用 Composer 安装 enygma/cmd 非常简单:

composer require enygma/cmd

使用示例

以下是一个简单的示例,展示了如何使用 enygma/cmd 解析命令行参数

<?php  require_once 'vendor/autoload.php'; use CmdCommand;  $cmd = new Command(); $args = $cmd->execute($_SERVER['argv']);  echo 'RESULT: '.var_export($args, true)."n";  ?>

假设我们执行以下命令:

php test.php plain-arg --foo --bar=baz

enygma/cmd 会将参数解析为以下数组:

Array (     [0] => plain-arg     [foo] => 1     [bar] => baz )

设置默认值和必需参数

enygma/cmd 还支持设置默认值和必需参数,这使得命令行工具更加健壮。

<?php  require_once 'vendor/autoload.php'; use CmdCommand;  $cmd = new Command(); $config = [   'default' => ['foo' => true],   'required' => ['bar'] ];  $args = $cmd->execute($_SERVER['argv'], $config);  echo 'RESULT: '.var_export($args, true)."n";  ?>

在这个例子中,如果用户没有传递 –foo 参数,那么 $args[‘foo’] 的值将会是 true。如果用户没有传递 –bar 参数,execute() 方法将会抛出一个异常。

格式化输出

enygma/cmd 还提供了一个 Output 类,可以方便地输出格式化的消息。

<?php  require_once 'vendor/autoload.php'; use CmdOutput;  $out = new Output(); $out->success('Success message goes here!');  $out->warning('Warning message goes here!');  $out->Error('Error message goes here!'); ?>

Output 类提供了 success()、warning()、info() 和 error() 等方法,可以输出不同类型的消息。你还可以自定义消息类型:

<?php require_once 'vendor/autoload.php'; use CmdOutput;  $out = new Output(); $out->addType('custom1', 'white', 'blue');  $out->custom1('A custom message'); ?>

总而言之,enygma/cmd 是一个非常实用的命令行工具库,它可以极大地简化命令行参数解析和格式化输出,提高开发效率,使命令行工具更加健壮和友好。

© 版权声明
THE END
喜欢就支持一下吧
点赞13 分享