README

这是一个用于在PHP中创建命令行脚本的简单库。

特性

创建外观出色的PHP命令行脚本。
内置命令使网页开发变得更加容易。
易于与任何PHP框架集成。

安装

您可以通过Composer进行安装。

composer require jameslevi/atmos

将vendor/jameslevi/atmos中的atmos文件复制到根目录。
在您的根目录中创建一个名为commands的新文件夹。

入门指南

生成新的命令文件。

php atmos --make Test

打开生成的PHP命令文件，并在main方法内编写您的代码。

/**
 * Method to be executed in the command line.
 *
 * @param  array $arguments
 * @return void
 */
protected function main(array $arguments)
{
    Console::log("Hello World!");  
}

测试命令。

php atmos test

调用特定方法

在您的命令文件中添加新的受保护方法。例如，让我们假设是"generate"。

/**
 * This method will generate new file.
 *
 * @param  array $arguments
 * @return void
 */
protected function generate(array $arguments)
{
    Console::success("File is generated.");  
}

使用此命令调用此方法。

php atmos test:generate

参数

您可以使用命令行提供的参数。

/**
 * This method will generate new file.
 *
 * @param  array $arguments
 * @return void
 */
protected function generate(array $arguments)
{
    Console::success($arguments[0] . " file is generated.");  
}

您可以使用此命令调用此方法。

php atmos test:generate newfile.php

别名

您可以通过在命令类中设置名为"alias"的受保护变量来为您的命令设置别名。

protected $alias = "alternative";

以下命令将执行generate方法。

php atmos --alternative:generate

控制台消息

日志 - 打印简单消息。

Console::log("Hello World!");

成功 - 打印成功消息。

Console::success("Congratulations! you made it!");

错误 - 打印错误消息。

Console::error("Something went wrong!");

信息 - 打印信息消息。

Console::info("You scored 30 points!");

警告 - 打印警告消息。

Console::warn("I told you not to go here!");

调用多个命令

如果您想在一个命令中调用多个命令，这非常有用。每个命令的执行顺序取决于数组中的值顺序。

Console::call(array(
    'composer -h',
    'php atmos -h'
));

启动内置PHP服务器

现在您可以使用atmos命令启动PHP服务器。此命令将在8080端口启动服务器。

php atmos --serve 8080

贡献

对于问题、关注和建议，您可以发送电子邮件至James Crisostomo，邮箱地址为nerdlabenterprise@gmail.com。

许可证

本软件包是开源软件，受MIT许可证许可。

詹姆斯·莱维 / 大气层

维护者

详细信息