class MaestroBatchFunctionTask in Maestro 3.x
Same name and namespace in other branches
- 8.2 src/Plugin/EngineTasks/MaestroBatchFunctionTask.php \Drupal\maestro\Plugin\EngineTasks\MaestroBatchFunctionTask
Maestro Batch Function Task Plugin.
The plugin annotations below should include: id: The task type ID for this task. For Maestro tasks, this is Maestro[TaskType]. So for example, the start task shipped by Maestro is MaestroStart. The Maestro End task has an id of MaestroEnd Those task IDs are what's used in the engine when a task is injected into the queue.
Plugin annotation
@Plugin(
id = "MaestroBatchFunction",
task_description = @Translation("The Maestro Engine's Batch Function task."),
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\maestro\Plugin\EngineTasks\MaestroBatchFunctionTask implements MaestroEngineTaskInterface uses MaestroTaskTrait
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of MaestroBatchFunctionTask
File
- src/
Plugin/ EngineTasks/ MaestroBatchFunctionTask.php, line 26
Namespace
Drupal\maestro\Plugin\EngineTasksView source
class MaestroBatchFunctionTask extends PluginBase implements MaestroEngineTaskInterface {
use MaestroTaskTrait;
/**
* Constructor.
*/
public function __construct($configuration = NULL) {
if (is_array($configuration)) {
$this->processID = $configuration[0];
$this->queueID = $configuration[1];
}
}
/**
* {@inheritDoc}
*/
public function isInteractive() {
return FALSE;
}
/**
* {@inheritDoc}
*/
public function shortDescription() {
return t('Batch Function');
}
/**
* {@inheritDoc}
*/
public function description() {
return $this
->t('Batch Function.');
}
/**
* {@inheritDoc}
*
* @see \Drupal\Component\Plugin\PluginBase::getPluginId()
*/
public function getPluginId() {
return 'MaestroBatchFunction';
}
/**
* {@inheritDoc}
*/
public function getTaskColours() {
return '#707070';
}
/**
* Part of the ExecutableInterface
* Execution of the Batch Function task will use the handler for this task as the executable function.
* The handler must return TRUE in order for this function to be completed by the engine.
* We simply pass the return boolean value back from the called handler to the engine for processing.
* {@inheritdoc}.
*/
public function execute() {
$returnValue = FALSE;
$returnStatus = FALSE;
$queueRecord = MaestroEngine::getQueueEntryById($this->queueID);
if ($queueRecord) {
// Pick off the handler here and call the code via the user func array.
if ($queueRecord->handler != NULL) {
$handler = $queueRecord->handler
->getString();
if (function_exists($handler)) {
$returnStatus = call_user_func_array($handler, [
$this->processID,
$this->queueID,
]);
// Lets see if the return status is an array. if so, we will check if it has any established structure to set status codes.
if (is_array($returnStatus)) {
if (array_key_exists('completion_status', $returnStatus)) {
$this->completionStatus = $returnStatus['completion_status'];
}
if (array_key_exists('execution_status', $returnStatus)) {
$this->executionStatus = $returnStatus['execution_status'];
}
if (array_key_exists('status', $returnStatus)) {
// On false, this holds the engine at this task.
$returnValue = $returnStatus['status'];
}
}
else {
$returnValue = $returnStatus;
}
}
}
else {
// Just do a NOOP here.
$returnValue = TRUE;
}
}
// True or false to complete the task.
return $returnValue;
}
/**
* {@inheritdoc}
*/
public function getExecutableForm($modal, MaestroExecuteInteractive $parent) {
}
/**
* {@inheritdoc}
*/
public function handleExecuteSubmit(array &$form, FormStateInterface $form_state) {
}
/**
* {@inheritdoc}
*/
public function getTaskEditForm(array $task, $templateMachineName) {
$form = [
'#markup' => t('Batch Function Edit'),
];
// Let modules signal the handlers they wish to share.
$handlers = \Drupal::moduleHandler()
->invokeAll('maestro_batch_handlers', []);
$handler_desc = $this
->t('The batch function name you wish to call.');
if (isset($task['handler']) && isset($handlers[$task['handler']])) {
$handler_desc = $handlers[$task['handler']];
}
$form['handler'] = [
'#type' => 'textfield',
'#title' => $this
->t('Handler'),
'#default_value' => isset($task['handler']) ? $task['handler'] : '',
'#required' => TRUE,
'#autocomplete_route_name' => 'maestro.autocomplete.batch_handlers',
'#ajax' => [
'callback' => [
$this,
'batchFunctionHandlerCallback',
],
'event' => 'autocompleteclose',
'wrapper' => 'handler-ajax-refresh-wrapper',
'progress' => [
'type' => 'throbber',
'message' => NULL,
],
],
];
$form['handler_help_text'] = [
'#type' => 'html_tag',
'#tag' => 'div',
'#value' => $handler_desc,
'#readonly' => TRUE,
'#attributes' => [
'class' => [
'handler-help-message',
],
'id' => [
'handler-ajax-refresh-wrapper',
],
],
];
return $form;
}
/**
* Implements callback for Ajax event on objective selection.
*
* @param array $form
* From render array.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* Current state of form.
*
* @return array
* Objective selection section of the form.
*/
public function batchFunctionHandlerCallback(array &$form, FormStateInterface $form_state) {
$selected_handler = $new_objective_id = $form_state
->getValue('handler');
// Let modules signal the handlers they wish to share.
$handlers = \Drupal::moduleHandler()
->invokeAll('maestro_batch_handlers', []);
if ($selected_handler != '' && !function_exists($selected_handler)) {
$handler_desc = \Drupal::translation()
->translate('This handler form function does not exist.');
}
elseif (isset($handlers[$selected_handler])) {
$handler_desc = $handlers[$selected_handler];
}
else {
$handler_desc = \Drupal::translation()
->translate('The batch function name you wish to call.');
}
$form['handler_help_text'] = [
'#type' => 'html_tag',
'#tag' => 'div',
'#value' => $handler_desc,
'#readonly' => TRUE,
'#attributes' => [
'class' => [
'handler-help-message',
],
'id' => [
'handler-ajax-refresh-wrapper',
],
],
];
return $form['handler_help_text'];
}
/**
* {@inheritDoc}
*/
public function validateTaskEditForm(array &$form, FormStateInterface $form_state) {
$handler = $form_state
->getValue('handler');
// Let's validate the handler here to ensure that it actually exists.
if (!function_exists($handler)) {
$form_state
->setErrorByName('handler', $this
->t('This handler batch function does not exist.'));
}
}
/**
* {@inheritDoc}
*/
public function prepareTaskForSave(array &$form, FormStateInterface $form_state, array &$task) {
$task['handler'] = $form_state
->getValue('handler');
}
/**
* {@inheritDoc}
*/
public function performValidityCheck(array &$validation_failure_tasks, array &$validation_information_tasks, array $task) {
// So we know that we need a few keys in this $task array to even have a batch function run properly.
// namely the handler.
if (array_key_exists('handler', $task) && $task['handler'] == '' || !array_key_exists('handler', $task)) {
$validation_failure_tasks[] = [
'taskID' => $task['id'],
'taskLabel' => $task['label'],
'reason' => t('The handler for the task has not been set. This will cause a failure of the engine to execute'),
];
}
}
/**
* {@inheritDoc}
*/
public function getTemplateBuilderCapabilities() {
return [
'edit',
'drawlineto',
'removelines',
'remove',
];
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
MaestroBatchFunctionTask:: |
public | function | Implements callback for Ajax event on objective selection. | |
MaestroBatchFunctionTask:: |
public | function |
Longer description. This generally follows the short Description but can be used to be more descriptive if you
wish to surface this description in a UI element. Overrides MaestroEngineTaskInterface:: |
|
MaestroBatchFunctionTask:: |
public | function |
Part of the ExecutableInterface
Execution of the Batch Function task will use the handler for this task as the executable function.
The handler must return TRUE in order for this function to be completed by the engine.
We simply pass the return… Overrides ExecutableInterface:: |
|
MaestroBatchFunctionTask:: |
public | function |
Gets the Maestro executable form for a task console. Overrides MaestroEngineTaskInterface:: |
|
MaestroBatchFunctionTask:: |
public | function |
Overrides PluginBase:: |
|
MaestroBatchFunctionTask:: |
public | function |
Returns the task's defined colours. This is useful if you want to let the tasks decide on what colours to paint themselves in the UI. Overrides MaestroEngineTaskInterface:: |
|
MaestroBatchFunctionTask:: |
public | function |
Method to allow a task to add their own fields to the task edit form. Overrides MaestroEngineTaskInterface:: |
|
MaestroBatchFunctionTask:: |
public | function |
Returns an array of consistenly keyed array elements that define what this task can do in the template builder.
Elements are:
edit, drawlineto, drawfalselineto, removelines, remove. Overrides MaestroEngineTaskInterface:: |
|
MaestroBatchFunctionTask:: |
public | function |
Interactive tasks, or tasks that signal themselves as requiring human interaction will have the resulting form submissions
sent to their own handler for processing to determine if the task should be completed or not or to carry out any task
processing… Overrides MaestroEngineTaskInterface:: |
|
MaestroBatchFunctionTask:: |
public | function |
Returns TRUE or FALSE to denote if this task has an interactive interface that needs to be shown in the Task Console
and for any other requirements of the task. Overrides MaestroEngineTaskInterface:: |
|
MaestroBatchFunctionTask:: |
public | function |
Lets the task perform validation on itself. If the task is missing any internal requirements, it can flag itself as having an issue.
Return array MUST be in the format of array(
'taskID' => the task machine name,
'taskLabel'… Overrides MaestroEngineTaskInterface:: |
|
MaestroBatchFunctionTask:: |
public | function |
The specific task's manipulation of the values to save for a template save. Overrides MaestroEngineTaskInterface:: |
|
MaestroBatchFunctionTask:: |
public | function |
Get the task's short description. Useful for things like labels. Overrides MaestroEngineTaskInterface:: |
|
MaestroBatchFunctionTask:: |
public | function |
This method must be called by the template builder in order to validate the form entry values before saving. Overrides MaestroEngineTaskInterface:: |
|
MaestroBatchFunctionTask:: |
public | function |
Constructor. Overrides PluginBase:: |
|
MaestroTaskTrait:: |
protected | property | Default will be that the task completed normally. | |
MaestroTaskTrait:: |
protected | property | The default will be success for the execution status. | |
MaestroTaskTrait:: |
protected | property | The Maestro Process ID. | |
MaestroTaskTrait:: |
protected | property | The Maestro queue ID. | |
MaestroTaskTrait:: |
public | function | Retrieve the core Maestro form edit elements for Assignments and Notifications. | |
MaestroTaskTrait:: |
public | function | Retrieve the core Maestro form edit elements that all tasks MUST adhere to. | |
MaestroTaskTrait:: |
public | function | Returns the value of the completion status protected variable denoting any special completion status condition the task wishes to pass along. | |
MaestroTaskTrait:: |
public | function | Returns the value of the execution status protected variable denoting if the execution of this task is complete. | |
MaestroTaskTrait:: |
public | function | Available for all tasks -- this does the general task construction for us, ensuring we have sanity in the saved Config Entity for the task. Assignments and Notifications are the two main elements this method worries about. | |
MessengerTrait:: |
protected | property | The messenger. | 27 |
MessengerTrait:: |
public | function | Gets the messenger. | 27 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
2 |
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 4 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |