koahana/minion

官方koahana模块,用于通过CLI运行任务

安装量: 113,805

依赖者: 16

建议者: 0

安全性: 0

星标: 113

关注者: 19

分支: 76

类型:koahana模块

v3.3.6 2016-03-23 17:13 UTC

README

Minion是一个通过CLI运行任务的框架。

该系统灵感来源于ruckusing,它有一个很好的任务定义系统,但缺乏koahana集成的灵活性。

入门指南

首先,下载并启用该模块到您的bootstrap中

然后,将bash脚本minion复制到与index.php(通常是webroot)相同的位置。如果您希望可执行文件位于index.php以外的位置,只需修改bash脚本以指向index.php。

然后您可以像这样运行minion

./minion {task}

要查看minion任务列表,运行minion不带任何参数,或使用--help选项

./minion
./minion --help

要查看特定minion任务的帮助,请运行

./minion {task} --help

出于安全原因,Minion只从CLI运行。尝试通过http访问它将抛出Kohana_Exception异常。

如果您由于任何原因无法使用二进制文件,则只需在上面的示例中将./minion {task}替换为

php index.php --uri=minion --task={task}

编写您自己的任务

所有minion任务必须位于classes/task/目录中。它们可以位于任何模块中,因此您可以将自定义minion任务与自己的模块/产品一起分发。

每个任务都必须扩展抽象类Minion_Task并实现Minion_Task::_execute()

有关详细信息,请参阅Minion_Task

文档

代码应该注释良好,无需文档,minion可以提取类的doccomment作为CLI上的文档。

测试

此模块使用unittest模块进行单元测试。您可以使用minion组仅运行minion测试。

例如:

phpunit --group minion

请随意贡献测试(!),它们可以在tests/minion目录中找到。 :)

许可证

此许可证与Kohana相同