class ScheduleTaskController in Business Rules 8

Class ScheduleTaskController.

@package Drupal\business_rules\Controller

Hierarchy

• class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
  • class \Drupal\business_rules\Controller\ScheduleTaskController

File

src/Controller/ScheduleTaskController.php, line 25

Namespace

Drupal\business_rules\Controller

class ScheduleTaskController extends ControllerBase {

  /**
   * The EntityTypeManager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The type of item to be configured action|condition.
   *
   * @var string
   */
  protected $item;

  /**
   * The Item config name: condition | action.
   *
   * @var string
   */
  protected $itemType;

  /**
   * All saved items from database.
   *
   * @var \Drupal\Core\Entity\EntityInterface[]|static[]
   */
  protected $items;

  /**
   * The item name for the configuration actions|conditions.
   *
   * @var string
   */
  protected $itemsName;

  /**
   * The item label.
   *
   * @var \Drupal\Core\StringTranslation\TranslatableMarkup
   */
  protected $label;

  /**
   * The item label in plural.
   *
   * @var \Drupal\Core\StringTranslation\TranslatableMarkup
   */
  protected $labelPlural;

  /**
   * The items currently saved on the Action.
   *
   * @var array
   */
  protected $savedItems = [];

  /**
   * Business Rules Util service.
   *
   * @var \Drupal\business_rules\Util\BusinessRulesUtil
   */
  protected $util;

  /**
   * {@inheritdoc}
   */
  public function __construct(ContainerInterface $container) {
    $this->entityTypeManager = $container
      ->get('entity_type.manager');
    $this->util = $container
      ->get('business_rules.util');
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container);
  }

  /**
   * Add item on Action.
   *
   * @param string $action_id
   *   The action id.
   * @param string $item_type
   *   The item type.
   * @param string $item_id
   *   The item id.
   *
   * @return \Symfony\Component\HttpFoundation\RedirectResponse
   *   The RedirectResponse.
   */
  public function addItem($action_id, $item_type, $item_id) {
    $action = Action::load($action_id);
    $weight = $this
      ->getMaxItemWeight($action) + 1;
    $itemObj = new BusinessRulesItemObject($item_id, $item_type, $weight);
    $items = $action
      ->getSettings('items');
    $item_array = $itemObj
      ->toArray();
    $items[$itemObj
      ->getId()] = $item_array[$itemObj
      ->getId()];
    $action
      ->setSetting('items', $items);
    $action
      ->save();
    $url = new Url('entity.business_rules_action.edit_form', [
      'business_rules_action' => $action_id,
    ], [
      'fragment' => $item_id,
    ]);
    return new RedirectResponse($url
      ->toString());
  }

  /**
   * Get the bigger weight for the action items.
   *
   * @param \Drupal\business_rules\ActionInterface $action
   *   The action to get the bigger item weight.
   *
   * @return int
   *   The bigger weight for the action items.
   */
  public function getMaxItemWeight(ActionInterface $action) {
    $items = $action
      ->getSettings('items');
    $max = -100;
    if (is_array($items)) {
      foreach ($items as $item) {
        if ($max < $item['weight']) {
          $max = $item['weight'];
        }
      }
    }
    return $max;
  }

  /**
   * The items table.
   *
   * @param string $action_id
   *   The condition id.
   * @param string $item_type
   *   The item type.
   * @param string $method
   *   The method name: ajax|nojs.
   *
   * @return array|\Drupal\Core\Ajax\AjaxResponse
   *   Render array or AjaxResponse.
   */
  public function itemsTable($action_id, $item_type, $method) {
    $this
      ->init($item_type);
    $action = Action::load($action_id);
    $this
      ->removeCurrentItems($action_id, $this->items);
    $table['#title'] = $this
      ->t('Add @label_plural on %action', [
      '%action' => $action
        ->label(),
      '@label_plural' => $this->labelPlural,
    ]);
    $table['#attached']['library'][] = 'system/drupal.system.modules';
    $table['filters'] = [
      '#type' => 'container',
      '#attributes' => [
        'class' => [
          'table-filter',
          'js-show',
        ],
      ],
    ];
    $table['filters']['text'] = [
      '#type' => 'search',
      '#title' => $this
        ->t('Search'),
      '#size' => 30,
      '#placeholder' => $this
        ->t('Search for a @label key', [
        '@label' => $this->label,
      ]),
      '#attributes' => [
        'class' => [
          'table-filter-text',
        ],
        'data-table' => '.searchable-list',
        'autocomplete' => 'off',
        'title' => $this
          ->t('Enter a part of the @label key to filter by.', [
          '@label' => $this->label,
        ]),
      ],
    ];
    $header = [
      'label' => $this->label,
      'id' => $this
        ->t('Machine Name'),
      'type' => $this
        ->t('Type'),
      'description' => $this
        ->t('Description'),
      'operations' => $this
        ->t('Operations'),
      'filter' => [
        'data' => [
          '#markup' => 'filter',
        ],
        'style' => 'display: none',
      ],
    ];
    $rows = [];

    /** @var \Drupal\business_rules\Entity\Action $item */
    foreach ($this->items as $item) {
      if (!in_array($item
        ->id(), array_keys($this->savedItems)) && $item
        ->id() != $action
        ->id()) {
        $listBuilder = $this->entityTypeManager
          ->getListBuilder($item
          ->getEntityTypeId());
        $operations = $listBuilder
          ->buildOperations($item);
        $search_string = $item
          ->label() . ' ' . $item
          ->id() . ' ' . $item
          ->getTypeLabel() . ' ' . $item
          ->getDescription();
        $link = Link::createFromRoute($item
          ->label(), 'business_rules.schedule_task.items.add', [
          'action_id' => $action_id,
          'item_id' => $item
            ->id(),
          'item_type' => $item_type,
        ]);
        $rows[$item
          ->id()] = [
          'label' => [
            'data' => $link,
          ],
          'id' => [
            'data' => [
              '#markup' => $item
                ->id(),
            ],
          ],
          'type' => [
            'data' => [
              '#markup' => $item
                ->getTypeLabel(),
            ],
          ],
          'description' => [
            'data' => [
              '#markup' => $item
                ->getDescription(),
            ],
          ],
          'operations' => [
            'data' => $operations,
          ],
          'filter' => [
            'data' => [
              [
                '#markup' => '<span class="table-filter-text-source">' . $search_string . '</span>',
              ],
            ],
            'style' => [
              'display: none',
            ],
          ],
        ];
      }
    }
    $table['business_rule_items'] = [
      '#type' => 'table',
      '#header' => $header,
      '#rows' => $rows,
      '#attributes' => [
        'class' => [
          'searchable-list',
        ],
      ],
    ];
    if ($method == 'ajax') {
      $table['#attached']['library'][] = 'core/drupal.dialog.ajax';
      $options = [
        'width' => '75%',
      ];
      $title = $this
        ->t('Add @item', [
        '@item' => $this->label,
      ]);
      $response = new AjaxResponse();
      $response
        ->addCommand(new OpenModalDialogCommand($title, $table, $options));
      return $response;
    }
    else {
      return $table;
    }
  }

  /**
   * Remove the action items.
   *
   * @param string $action_id
   *   The Action id.
   * @param array $items
   *   The items.
   */
  public function removeCurrentItems($action_id, &$items) {
    $action = Action::load($action_id);
    $current = $action
      ->getSettings('items');
    $current_keys = array_keys($current);
    foreach ($items as $key => $value) {
      if (in_array($value
        ->id(), $current_keys)) {
        unset($items[$key]);
      }
    }
  }

  /**
   * Init properties.
   *
   * @param string $item_type
   *   The item type action|condition.
   */
  public function init($item_type) {
    $this->item = $item_type;
    switch ($this->item) {
      case 'condition':
        $this->label = $this
          ->t('Condition');
        $this->labelPlural = $this
          ->t('Conditions');
        $this->items = Condition::loadMultiple();
        $this->itemsName = 'conditions';
        $this->itemType = 'condition';
        break;
      case 'action':
        $this->label = $this
          ->t('Action');
        $this->labelPlural = $this
          ->t('Actions');
        $this->items = Action::loadMultiple();
        $this->itemsName = 'actions';
        $this->itemType = 'action';
        break;
    }
  }

  /**
   * Remove item from condition.
   *
   * @param string $action_id
   *   The action id.
   * @param string $item_id
   *   The item id.
   * @param string $method
   *   The method name: ajax|nojs.
   *
   * @return \Drupal\Core\Ajax\AjaxResponse|\Symfony\Component\HttpFoundation\RedirectResponse
   *   The AjaxResponse or the RedirectResponse.
   */
  public function removeItem($action_id, $item_id, $method) {
    $action = Action::load($action_id);
    $items = $action
      ->getSettings('items');
    unset($items[$item_id]);
    $items = is_null($items) ? [] : $items;
    $action
      ->setSetting('items', $items);
    $action
      ->save();
    if ($method == 'ajax') {
      $chart_definition = $this->util->flowchart
        ->getGraphDefinition($action);
      $textarea = '<textarea id="graph_definition" style="display: none;">' . $chart_definition . '</textarea>';
      $response = new AjaxResponse();
      $response
        ->addCommand(new RemoveCommand('#' . $item_id));
      $response
        ->addCommand(new ReplaceCommand('#graph_definition', $textarea));
      $response
        ->addCommand(new UpdateFlowchartCommand());
      return $response;
    }
    else {
      $url = new Url('entity.business_rules_action.edit_form', [
        'business_rule_action' => $action_id,
      ]);
      $string_url = $url
        ->toString() . '#business_rule-add_buttons';
      return new RedirectResponse($string_url);
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ControllerBase::$configFactory	protected	property	The configuration factory.
ControllerBase::$currentUser	protected	property	The current user service.	1
ControllerBase::$entityFormBuilder	protected	property	The entity form builder.
ControllerBase::$entityManager	protected	property	The entity manager.
ControllerBase::$formBuilder	protected	property	The form builder.	2
ControllerBase::$keyValue	protected	property	The key-value storage.	1
ControllerBase::$languageManager	protected	property	The language manager.	1
ControllerBase::$moduleHandler	protected	property	The module handler.	2
ControllerBase::$stateService	protected	property	The state service.
ControllerBase::cache	protected	function	Returns the requested cache bin.
ControllerBase::config	protected	function	Retrieves a configuration object.
ControllerBase::container	private	function	Returns the service container.
ControllerBase::currentUser	protected	function	Returns the current user.	1
ControllerBase::entityFormBuilder	protected	function	Retrieves the entity form builder.
ControllerBase::entityManager Deprecated	protected	function	Retrieves the entity manager service.
ControllerBase::entityTypeManager	protected	function	Retrieves the entity type manager.
ControllerBase::formBuilder	protected	function	Returns the form builder service.	2
ControllerBase::keyValue	protected	function	Returns a key/value storage collection.	1
ControllerBase::languageManager	protected	function	Returns the language manager service.	1
ControllerBase::moduleHandler	protected	function	Returns the module handler.	2
ControllerBase::redirect	protected	function	Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
ControllerBase::state	protected	function	Returns the state storage service.
LinkGeneratorTrait::$linkGenerator	protected	property	The link generator.	1
LinkGeneratorTrait::getLinkGenerator Deprecated	protected	function	Returns the link generator.
LinkGeneratorTrait::l Deprecated	protected	function	Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated	public	function	Sets the link generator service.
LoggerChannelTrait::$loggerFactory	protected	property	The logger channel factory service.
LoggerChannelTrait::getLogger	protected	function	Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory	public	function	Injects the logger channel factory.
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
RedirectDestinationTrait::$redirectDestination	protected	property	The redirect destination service.	1
RedirectDestinationTrait::getDestinationArray	protected	function	Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination	protected	function	Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination	public	function	Sets the redirect destination service.
ScheduleTaskController::$entityTypeManager	protected	property	The EntityTypeManager. Overrides ControllerBase::$entityTypeManager
ScheduleTaskController::$item	protected	property	The type of item to be configured action|condition.
ScheduleTaskController::$items	protected	property	All saved items from database.
ScheduleTaskController::$itemsName	protected	property	The item name for the configuration actions|conditions.
ScheduleTaskController::$itemType	protected	property	The Item config name: condition | action.
ScheduleTaskController::$label	protected	property	The item label.
ScheduleTaskController::$labelPlural	protected	property	The item label in plural.
ScheduleTaskController::$savedItems	protected	property	The items currently saved on the Action.
ScheduleTaskController::$util	protected	property	Business Rules Util service.
ScheduleTaskController::addItem	public	function	Add item on Action.
ScheduleTaskController::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
ScheduleTaskController::getMaxItemWeight	public	function	Get the bigger weight for the action items.
ScheduleTaskController::init	public	function	Init properties.
ScheduleTaskController::itemsTable	public	function	The items table.
ScheduleTaskController::removeCurrentItems	public	function	Remove the action items.
ScheduleTaskController::removeItem	public	function	Remove item from condition.
ScheduleTaskController::__construct	public	function
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
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.
UrlGeneratorTrait::$urlGenerator	protected	property	The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated	protected	function	Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated	public	function	Sets the URL generator service.
UrlGeneratorTrait::url Deprecated	protected	function	Generates a URL or path for a specific route based on the given parameters.