app-skeleton / minion
官方的 kohana 模块,用于通过 CLI 运行任务
Requires
- php: >=5.3.3
- composer/installers: ~1.0
- kohana/core: >=3.3
This package is not auto-updated.
Last update: 2024-09-24 01:03:06 UTC
README
Minion 是一个通过 CLI 运行任务的框架。
该系统受到 ruckusing 的启发,ruckusing 有一个很好的任务定义系统,但缺乏 kohana 集成的所需灵活性。
入门指南
首先,下载并启用模块到您的 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 的许可证相同。