Help task to display general instructons and list all tasks
Class declared in MODPATH/minion/classes/Task/Help.php on line 12.
string $task_separatorThe separator used to separate different levels of tasks
string(1) ":"array $_accepted_optionsPopulated with the accepted options for this task. This array is automatically populated based on $_options.
array(0) string|null $_errors_fileThe file that get's passes to Validation::errors() when validation fails
string(10) "validation"string(8) "_execute"array $_optionsThe list of options this task accepts and their default values.
protected $_options = [
'limit' => 4,
'table' => null,
];
array(0) Gets the task name for the task
stringpublic function __toString()
{
static $task_name = null;
if ($task_name === null) {
$task_name = Minion_Task::convert_class_to_task($this);
}
return $task_name;
}Adds any validation rules/labels for validating _options
public function build_validation(Validation $validation)
{
return parent::build_validation($validation)
->rule('paramname', 'not_empty'); // Require this param
}
Validation
$validation
required - The validation object to add rules to
Validationpublic function build_validation(Validation $validation)
{
// Add a rule to each key making sure it's in the task
foreach ($validation->data() as $key => $value) {
$validation->rule($key, [$this, 'valid_option'], [':validation', ':field']);
}
return $validation;
}Gets the task name of a task class / task object
string|Minion_Task
$class
required - The task class / object string - The task namepublic static function convert_class_to_task($class)
{
if (is_object($class)) {
$class = get_class($class);
}
return strtolower(str_replace('_', Minion_Task::$task_separator, substr($class, 5)));
}Converts a task (e.g. db:migrate to a class name)
string
$task
required - Task name string - Class namepublic static function convert_task_to_class_name($task)
{
$task = trim($task);
if (empty($task))
return '';
return 'Task_' . implode('_', array_map('ucfirst', explode(Minion_Task::$task_separator, $task)));
}Execute the task with the specified set of options
nullpublic function execute()
{
$options = $this->get_options();
// Validate $options
$validation = Validation::factory($options);
$validation = $this->build_validation($validation);
if ($this->_method != '_help' AND ! $validation->check()) {
echo View::factory('minion/error/validation')
->set('task', Minion_Task::convert_class_to_task($this))
->set('errors', $validation->errors($this->get_errors_file()));
} else {
// Finally, run the task
$method = $this->_method;
echo $this->{$method}($options);
}
}Factory for loading minion tasks
array
$options
required - An array of command line options. It should contain the 'task' key Minion_Task - The Minion taskpublic static function factory($options)
{
if (($task = Arr::get($options, 'task')) !== null) {
unset($options['task']);
} else if (($task = Arr::get($options, 0)) !== null) {
// The first positional argument (aka 0) may be the task name
unset($options[0]);
} else {
// If we didn't get a valid task, generate the help
$task = 'help';
}
$class = Minion_Task::convert_task_to_class_name($task);
if (!class_exists($class)) {
throw new Minion_Exception_InvalidTask("Task ':task' is not a valid minion task", [':task' => $class]);
}
$class = new $class;
if (!$class instanceof Minion_Task) {
throw new Minion_Exception_InvalidTask("Task ':task' is not a valid minion task", [':task' => $class]);
}
$class->set_options($options);
// Show the help page for this task if requested
if (array_key_exists('help', $options)) {
$class->_method = '_help';
}
return $class;
}Get a set of options that this task can accept
arraypublic function get_accepted_options()
{
return (array) $this->_accepted_options;
}Returns $_errors_file
stringpublic function get_errors_file()
{
return $this->_errors_file;
}Get the options that were passed into this task with their defaults
arraypublic function get_options()
{
return (array) $this->_options;
}Sets options for this task
$param array the array of options to set
thispublic function set_options(array $options)
{
foreach ($options as $key => $value) {
$this->_options[$key] = $value;
}
return $this;
}public function valid_option(Validation $validation, $option)
{
if (!in_array($option, $this->_accepted_options)) {
$validation->error($option, 'minion_option');
}
}Generates a help list for all tasks
nullprotected function _execute(array $params)
{
$tasks = $this->_compile_task_list(Kohana::list_files('classes/Task'));
$view = new View('minion/help/list');
$view->tasks = $tasks;
echo $view;
}protected function __construct()
{
// Populate $_accepted_options based on keys from $_options
$this->_accepted_options = array_keys($this->_options);
}Compiles a list of available tasks from a directory structure
array
$files
required - Directory structure of tasks string
$prefix
= string(0) "" - Prefix array - Compiled tasksprotected function _compile_task_list(array $files, $prefix = '')
{
$output = [];
foreach ($files as $file => $path) {
$file = substr($file, strrpos($file, DIRECTORY_SEPARATOR) + 1);
if (is_array($path) AND count($path)) {
$task = $this->_compile_task_list($path, $prefix . $file . Minion_Task::$task_separator);
if ($task) {
$output = array_merge($output, $task);
}
} else {
$output[] = strtolower($prefix . substr($file, 0, -strlen(EXT)));
}
}
return $output;
}Outputs help for this task
nullprotected function _help(array $params)
{
$tasks = $this->_compile_task_list(Kohana::list_files('classes/task'));
$inspector = new ReflectionClass($this);
list($description, $tags) = $this->_parse_doccomment($inspector->getDocComment());
$view = View::factory('minion/help/task')
->set('description', $description)
->set('tags', (array) $tags)
->set('task', Minion_Task::convert_class_to_task($this));
echo $view;
}Parses a doccomment, extracting both the comment and any tags associated
Based on the code in Kodoc::parse()
string
$comment
required - The comment to parse array - First element is the comment, second is an array of tagsprotected function _parse_doccomment($comment)
{
// Normalize all new lines to \n
$comment = str_replace(["\r\n", "\n"], "\n", $comment);
// Remove the phpdoc open/close tags and split
$comment = array_slice(explode("\n", $comment), 1, -1);
// Tag content
$tags = [];
foreach ($comment as $i => $line) {
// Remove all leading whitespace
$line = preg_replace('/^\s*\* ?/m', '', $line);
// Search this line for a tag
if (preg_match('/^@(\S+)(?:\s*(.+))?$/', $line, $matches)) {
// This is a tag line
unset($comment[$i]);
$name = $matches[1];
$text = isset($matches[2]) ? $matches[2] : '';
$tags[$name] = $text;
} else {
$comment[$i] = (string) $line;
}
}
$comment = trim(implode("\n", $comment));
return [$comment, $tags];
}