You are here

Home » API reference » Maestro 3.x » MaestroProcessStatusBlock.php

class MaestroProcessStatusBlock in Maestro 3.x

Same name and namespace in other branches
  1. 8.2 src/Plugin/Block/MaestroProcessStatusBlock.php \Drupal\maestro\Plugin\Block\MaestroProcessStatusBlock

Provides a Maestro block that shows the linear status output for processes this user belongs to or in general.

Plugin annotation


@Block(
  id = "maestro_process_status_block",
  admin_label = @Translation("Maestro Process Status Block"),
  category = @Translation("Maestro"),
)

Hierarchy

Expanded class hierarchy of MaestroProcessStatusBlock

File

src/Plugin/Block/MaestroProcessStatusBlock.php, line 19

Namespace

Drupal\maestro\Plugin\Block
View source 
class MaestroProcessStatusBlock extends BlockBase {

  /**
   * {@inheritdoc}
   */
  public function blockForm($form, FormStateInterface $form_state) {
    $config = $this
      ->getConfiguration();
    $form['maestro_skip_execute_check'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Skip checking if the user is part of the process status bars shown.'),
      '#description' => $this
        ->t('When checked, any open process can show its status. Unchecked means only those processes the user is a part of will be shown.'),
      '#default_value' => isset($this->configuration['maestro_skip_execute_check']) ? $this->configuration['maestro_skip_execute_check'] : 0,
      '#required' => FALSE,
    ];
    $form['maestro_filter_process_names'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Simple filter to filter on process name.'),
      '#description' => $this
        ->t('Specify the filter you wish to limit on. Filter uses %{your-filter}% database filtering. Available current user tokens are [uid] and [username].'),
      '#default_value' => isset($this->configuration['maestro_filter_process_names']) ? $this->configuration['maestro_filter_process_names'] : '',
      '#required' => FALSE,
    ];
    $form['maestro_provide_link'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Make the Process Name a link to the following URL.'),
      '#description' => $this
        ->t('No link when left blank. Available current user tokens are [uid] and [username].'),
      '#default_value' => isset($this->configuration['maestro_provide_link']) ? $this->configuration['maestro_provide_link'] : '',
      '#required' => FALSE,
    ];
    $form['maestro_link_tooltip'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('The hover-over tooltip for the link.'),
      '#description' => $this
        ->t('If you enter a link above, the tooltip entered here will be shown. Defaults to nothing.'),
      '#default_value' => isset($this->configuration['maestro_link_tooltip']) ? $this->configuration['maestro_link_tooltip'] : '',
      '#required' => FALSE,
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function blockSubmit($form, FormStateInterface $form_state) {
    $this->configuration['maestro_skip_execute_check'] = $form_state
      ->getValue('maestro_skip_execute_check');
    $this->configuration['maestro_filter_process_names'] = $form_state
      ->getValue('maestro_filter_process_names');
    $this->configuration['maestro_provide_link'] = $form_state
      ->getValue('maestro_provide_link');
    $this->configuration['maestro_link_tooltip'] = $form_state
      ->getValue('maestro_link_tooltip');
  }

  /**
   * {@inheritdoc}
   */
  public function build() {
    $conf = $this
      ->getConfiguration();
    $processID = intval(\Drupal::request()->query
      ->get('process_id', 0));
    $usr = \Drupal::currentUser();
    if ($usr
      ->id()) {
      if ($conf['maestro_skip_execute_check'] == 0) {
        $query = \Drupal::database()
          ->select('maestro_production_assignments', 'a');
        $query
          ->join('maestro_queue', 'b', 'a.queue_id = b.id');
        $query
          ->join('maestro_process', 'c', 'b.process_id = c.process_id');
        $query
          ->leftJoin('maestro_process_variables', 'd', 'c.process_id = d.process_id');
        $andConditionGroup1 = $query
          ->andConditionGroup();
        $andConditionGroup1
          ->condition('a.assign_id', $usr
          ->getAccountName());
        $andConditionGroup1
          ->condition('b.status', '0');
        if (isset($conf['maestro_filter_process_names']) && $conf['maestro_filter_process_names'] != '') {
          $filter = str_replace('[uid]', $usr
            ->id(), $conf['maestro_filter_process_names']);
          $filter = str_replace('[username]', $usr
            ->getAccountName(), $filter);
          $andConditionGroup1
            ->condition('c.process_name', '%' . $query
            ->escapeLike($filter) . '%', 'LIKE');
        }
        if ($processID > 0) {
          $andConditionGroup1
            ->condition('c.process_id', intval($processID));
        }
        $andConditionGroup2 = $query
          ->andConditionGroup();
        $andConditionGroup2
          ->condition('d.variable_name', 'initiator');
        $andConditionGroup2
          ->condition('d.variable_value', $usr
          ->getAccountName());
        $orConditionGroup = $query
          ->orConditionGroup();
        $orConditionGroup
          ->condition($andConditionGroup1);
        $orConditionGroup
          ->condition($andConditionGroup2);
        $query
          ->condition($orConditionGroup);
        $query
          ->addField('b', 'process_id');
        $query
          ->addField('c', 'process_name');
        $query
          ->groupBy('b.process_id');
        $query
          ->groupBy('c.process_name');
      }
      else {
        $query = \Drupal::database()
          ->select('maestro_queue', 'b');
        $query
          ->join('maestro_process', 'c', 'b.process_id = c.process_id');
        $query
          ->leftJoin('maestro_process_variables', 'd', 'c.process_id = d.process_id');
        $andConditionGroup1 = $query
          ->andConditionGroup();
        $andConditionGroup1
          ->condition('b.status', '0');
        if (isset($conf['maestro_filter_process_names']) && $conf['maestro_filter_process_names'] != '') {
          $filter = str_replace('[uid]', $usr
            ->id(), $conf['maestro_filter_process_names']);
          $filter = str_replace('[username]', $usr
            ->getAccountName(), $filter);
          $andConditionGroup1
            ->condition('c.process_name', '%' . $query
            ->escapeLike($filter) . '%', 'LIKE');
        }
        if ($processID > 0) {
          $andConditionGroup1
            ->condition('c.process_id', intval($processID));
        }
        $andConditionGroup2 = $query
          ->andConditionGroup();
        $andConditionGroup2
          ->condition('d.variable_name', 'initiator');
        $andConditionGroup2
          ->condition('d.variable_value', $usr
          ->getAccountName());
        $orConditionGroup = $query
          ->orConditionGroup();
        $orConditionGroup
          ->condition($andConditionGroup1);
        $orConditionGroup
          ->condition($andConditionGroup2);
        $query
          ->condition($orConditionGroup);
        $query
          ->addField('b', 'process_id');
        $query
          ->addField('c', 'process_name');
        $query
          ->groupBy('b.process_id');
        $query
          ->groupBy('c.process_name');
      }
      $result = $query
        ->execute();
      $output = [];
      foreach ($result as $row) {
        $status_bar = MaestroStatus::getMaestroStatusBar($row->process_id, 0, TRUE);
        $templateName = MaestroEngine::getTemplateIdFromProcessId($row->process_id);
        $process_name = $row->process_name;
        $link_start = '';
        $link_end = '';
        if (isset($conf['maestro_provide_link']) && $conf['maestro_provide_link'] != '') {
          $interim_link = str_replace('[uid]', $usr
            ->id(), $conf['maestro_provide_link']);
          $interim_link = str_replace('[username]', $usr
            ->getAccountName(), $interim_link);
          $link_start = '<a href="' . $interim_link . '" title="' . $this
            ->t($this->configuration['maestro_link_tooltip']) . '">';
          $link_end = '</a>';
        }
        $output['status'][] = [
          '#prefix' => $link_start . '<div id="processid-' . $row->process_id . '" class="maestro-block-process ' . $templateName . '">
            <div class="maestro-block-process-title">' . $process_name . '</div>',
          '#suffix' => '</div>' . $link_end,
          '#markup' => $status_bar['status_bar']['#children'],
        ];
      }
      $output['#attached']['library'][] = 'maestro/maestro-engine-css';

      // Keeping the cache lines commented for now to ensure caching for this block is indeed disabled
      // $output['#cache'] = ['contexts' => ['url.query_args:process_id']];  //don't cache the process_id url parameter
      // $output['#cache']['max-age'] = 0;  //just disable the cache completely for this module.
      return $output;
    }
  }

  /**
   * {@inheritDoc}
   *
   * @see \Drupal\Core\Plugin\ContextAwarePluginBase::getCacheMaxAge()
   */
  public function getCacheMaxAge() {

    // Caching turned off for this block.
    return 0;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BlockBase::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm 2
BlockPluginInterface::BLOCK_LABEL_VISIBLE constant Indicates the block label (title) should be displayed to end users.
BlockPluginTrait::$transliteration protected property The transliteration service.
BlockPluginTrait::access public function
BlockPluginTrait::baseConfigurationDefaults protected function Returns generic default configuration for block plugins.
BlockPluginTrait::blockAccess protected function Indicates whether the block should be shown. 16
BlockPluginTrait::blockValidate public function 3
BlockPluginTrait::buildConfigurationForm public function Creates a generic configuration form for all block types. Individual block plugins can add elements to this form by overriding BlockBase::blockForm(). Most block plugins should not override this method unless they need to alter the generic form elements. Aliased as: traitBuildConfigurationForm
BlockPluginTrait::calculateDependencies public function
BlockPluginTrait::defaultConfiguration public function 19
BlockPluginTrait::getConfiguration public function 1
BlockPluginTrait::getMachineNameSuggestion public function 1
BlockPluginTrait::getPreviewFallbackString public function 3
BlockPluginTrait::label public function
BlockPluginTrait::setConfiguration public function
BlockPluginTrait::setConfigurationValue public function
BlockPluginTrait::setTransliteration public function Sets the transliteration service.
BlockPluginTrait::submitConfigurationForm public function Most block plugins should not override this method. To add submission handling for a specific block type, override BlockBase::blockSubmit().
BlockPluginTrait::transliteration protected function Wraps the transliteration service.
BlockPluginTrait::validateConfigurationForm public function Most block plugins should not override this method. To add validation for a specific block type, override BlockBase::blockValidate(). 1
BlockPluginTrait::__construct public function 24
ContextAwarePluginAssignmentTrait::addContextAssignmentElement protected function Builds a form element for assigning a context to a given slot.
ContextAwarePluginAssignmentTrait::contextHandler protected function Wraps the context handler.
ContextAwarePluginTrait::$context protected property The data objects representing the context of this plugin.
ContextAwarePluginTrait::$initializedContextConfig protected property Tracks whether the context has been initialized from configuration.
ContextAwarePluginTrait::getCacheContexts public function 9
ContextAwarePluginTrait::getCacheTags public function 4
ContextAwarePluginTrait::getContext public function
ContextAwarePluginTrait::getContextDefinition public function
ContextAwarePluginTrait::getContextDefinitions public function
ContextAwarePluginTrait::getContextMapping public function
ContextAwarePluginTrait::getContexts public function
ContextAwarePluginTrait::getContextValue public function
ContextAwarePluginTrait::getContextValues public function
ContextAwarePluginTrait::getPluginDefinition abstract protected function 1
ContextAwarePluginTrait::setContext public function 1
ContextAwarePluginTrait::setContextMapping public function
ContextAwarePluginTrait::setContextValue public function
ContextAwarePluginTrait::validateContexts public function
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
MaestroProcessStatusBlock::blockForm public function Overrides BlockPluginTrait::blockForm
MaestroProcessStatusBlock::blockSubmit public function Overrides BlockPluginTrait::blockSubmit
MaestroProcessStatusBlock::build public function Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
MaestroProcessStatusBlock::getCacheMaxAge public function Overrides ContextAwarePluginTrait::getCacheMaxAge
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginWithFormsTrait::getFormClass public function Implements \Drupal\Core\Plugin\PluginWithFormsInterface::getFormClass().
PluginWithFormsTrait::hasFormClass public function Implements \Drupal\Core\Plugin\PluginWithFormsInterface::hasFormClass().
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.