https://github.com/ferpetrelli/minion_kohana_3.1_3.2

Minion module working on kohana 3.1 and 3.2
https://github.com/ferpetrelli/minion_kohana_3.1_3.2

Last synced: about 1 month ago
JSON representation

Minion module working on kohana 3.1 and 3.2

• Host: GitHub
• URL: https://github.com/ferpetrelli/minion_kohana_3.1_3.2
• Owner: ferpetrelli
• Created: 2013-02-25T03:16:19.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2013-02-25T03:24:41.000Z (almost 12 years ago)
• Last Synced: 2023-03-23T13:14:09.901Z (almost 2 years ago)
• Size: 117 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
**This version is a modified version to work on kohana 3.1, and 3.2**

# Minion

Minion is a framework for running tasks via the CLI.

The system is inspired by ruckusing, which had a nice system for defining tasks but lacked the desired flexibility for kohana integration.

## Getting Started

First off, download and enable the module in your bootstrap

Then copy the bash script `minion` alongside your index.php (most likely the webroot).

If you'd rather the executable be in a different location to index.php then simply modify the bash script to point to index.php.

You can then run minion like so:

	./minion {task}

To view a list of minion tasks, run minion without any parameters, or with the `--help` option

	./minion

	./minion --help

To view help for a specific minion task run

	./minion {task} --help

For security reasons Minion will only run from the cli.  Attempting to access it over http will cause

a `Kohana_Exception` to be thrown.

If you're unable to use the binary file for whatever reason then simply replace `./minion {task}` in the above

examples with

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

## Writing your own tasks

All minion tasks must be located in `classes/task/`.  They can be in any module, thus allowing you to

ship custom minion tasks with your own module / product.

Each task must extend the abstract class `Minion_Task` and implement `Minion_Task::_execute()`.

See `Minion_Task` for more details.

## Documentation

Code should be commented well enough not to need documentation, and minion can extract a class' doccomment to use

as documentation on the cli.

## Testing

This module is unittested using the [unittest module](http://github.com/kohana/unittest).

You can use the `minion` group to only run minion tests.

i.e.

	phpunit --group minion

Feel free to contribute tests(!), they can be found in the `tests/minion` directory. :)

## License

This is licensed under the [same license as Kohana](http://kohanaframework.org/license).