class BusinessRuleListBuilder in Business Rules 8

Same name and namespace in other branches

2.x src/BusinessRuleListBuilder.php \Drupal\business_rules\BusinessRuleListBuilder

Provides a listing of Rule entities.

Hierarchy

class \Drupal\Core\Entity\EntityHandlerBase uses DependencySerializationTrait, StringTranslationTrait
- class \Drupal\Core\Entity\EntityListBuilder implements EntityHandlerInterface, EntityListBuilderInterface uses MessengerTrait, RedirectDestinationTrait
  - class \Drupal\Core\Config\Entity\ConfigEntityListBuilder
    class \Drupal\business_rules\BusinessRuleListBuilder

Expanded class hierarchy of BusinessRuleListBuilder

1 file declares its use of BusinessRuleListBuilder

BusinessRulesUtil.php in src/Util/BusinessRulesUtil.php

File

src/BusinessRuleListBuilder.php, line 12

Namespace

Drupal\business_rules

View source

class BusinessRuleListBuilder extends ConfigEntityListBuilder {

  /**
   * {@inheritdoc}
   */
  public function buildHeader() {
    $header['label'] = $this
      ->t('Rule');
    $header['id'] = $this
      ->t('Machine name');
    $header['event'] = $this
      ->t('Reacts on event');
    $header['enabled'] = $this
      ->t('Enabled');
    $header['entity'] = $this
      ->t('Entity');
    $header['bundle'] = $this
      ->t('Bundle');
    $header['description'] = $this
      ->t('Description');
    $header['tags'] = $this
      ->t('Tags');
    $header['filter'] = [
      'data' => [
        '#markup' => 'filter',
      ],
      'style' => 'display: none',
    ];
    return $header + parent::buildHeader();
  }

  /**
   * {@inheritdoc}
   */
  public function buildRow(EntityInterface $entity) {

    /** @var \Drupal\business_rules\Entity\BusinessRule $entity */
    $status = $entity
      ->isEnabled() ? $this
      ->t('Enabled') : $this
      ->t('Disabled');
    $row['label'] = $entity
      ->label();
    $row['id'] = $entity
      ->id();
    $row['event'] = $entity
      ->getReactsOnLabel();
    $row['enabled'] = $status;
    $row['entity'] = $entity
      ->getTargetEntityTypeLabel();
    $row['bundle'] = $entity
      ->getTargetBundleLabel();
    $row['description'] = $entity
      ->getDescription();
    $row['tags'] = implode(', ', $entity
      ->getTags());
    $search_string = $entity
      ->label() . ' ' . $entity
      ->id() . ' ' . $entity
      ->getReactsOnLabel() . ' ' . $status . ' ' . $entity
      ->getTargetEntityTypeLabel() . ' ' . $entity
      ->getTargetBundleLabel() . ' ' . $entity
      ->getDescription() . ' ' . implode(' ', $entity
      ->getTags());
    $row['filter'] = [
      'data' => [
        [
          '#markup' => '<span class="table-filter-text-source">' . $search_string . '</span>',
        ],
      ],
      'style' => [
        'display: none',
      ],
    ];
    return $row + parent::buildRow($entity);
  }

  /**
   * {@inheritdoc}
   */
  public function render() {
    $view_mode = \Drupal::request()
      ->get('view_mode');
    $output['#attached']['library'][] = 'system/drupal.system.modules';
    $output['filters'] = [
      '#type' => 'container',
      '#attributes' => [
        'class' => [
          'table-filter',
          'js-show',
        ],
      ],
    ];
    $output['filters']['text'] = [
      '#type' => 'search',
      '#title' => $this
        ->t('Search'),
      '#size' => 30,
      '#placeholder' => $this
        ->t('Search for a rule'),
      '#attributes' => [
        'class' => [
          'table-filter-text',
        ],
        'data-table' => '.searchable-list',
        'autocomplete' => 'off',
        'title' => $this
          ->t('Enter a part of the rule to filter by.'),
      ],
    ];
    if ($view_mode == 'tags') {
      $tags = BusinessRule::loadAllTags();
      $table = parent::render();
      foreach ($tags as $tag) {
        $tagged_items = $table;
        $output["tags_table_{$tag}"] = [
          '#type' => 'details',
          '#title' => $tag,
          '#open' => FALSE,
        ];
        foreach ($tagged_items['table']['#rows'] as $key => $tagged_item) {
          $item = BusinessRule::load($key);
          $item_tags = $item
            ->getTags();
          if (!in_array($tag, $item_tags)) {
            unset($tagged_items['table']['#rows'][$key]);
          }
        }
        $output["tags_table_{$tag}"][$tag] = $tagged_items;
        if (!isset($output['table']['#attributes']['class'])) {
          $output["tags_table_{$tag}"][$tag]['table']['#attributes']['class'] = [
            'searchable-list',
          ];
        }
        else {
          $output["tags_table_{$tag}"][$tag]['table']['#attributes']['class'][] = [
            'searchable-list',
          ];
        }
      }
      $untagged_items = $table;
      foreach ($untagged_items['table']['#rows'] as $key => $tagged_item) {
        $item = BusinessRule::load($key);
        $item_tags = $item
          ->getTags();
        if (count($item_tags)) {
          unset($untagged_items['table']['#rows'][$key]);
        }
      }
      $output['tags_table_no_tags'] = [
        '#type' => 'details',
        '#title' => $this
          ->t('Untagged items'),
        '#open' => FALSE,
      ];
      $output['tags_table_no_tags'][''] = $untagged_items;
      if (!isset($output['table']['#attributes']['class'])) {
        $output['tags_table_no_tags']['']['table']['#attributes']['class'] = [
          'searchable-list',
        ];
      }
      else {
        $output['tags_table_no_tags']['']['table']['#attributes']['class'][] = [
          'searchable-list',
        ];
      }
    }
    else {
      $output += parent::render();
      if (!isset($output['table']['#attributes']['class'])) {
        $output['table']['#attributes']['class'] = [
          'searchable-list',
        ];
      }
      else {
        $output['table']['#attributes']['class'][] = [
          'searchable-list',
        ];
      }
    }
    return $output;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BusinessRuleListBuilder::buildHeader	public	function	Builds the header row for the entity listing. Overrides EntityListBuilder::buildHeader
BusinessRuleListBuilder::buildRow	public	function	Builds a row for an entity in the entity listing. Overrides EntityListBuilder::buildRow
BusinessRuleListBuilder::render	public	function	Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilder::render
ConfigEntityListBuilder::getDefaultOperations	public	function	Gets this list's default operations. Overrides EntityListBuilder::getDefaultOperations	15
ConfigEntityListBuilder::load	public	function	Loads entities of this type from storage for listing. Overrides EntityListBuilder::load	7
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
EntityHandlerBase::$moduleHandler	protected	property	The module handler to invoke hooks on.	2
EntityHandlerBase::moduleHandler	protected	function	Gets the module handler.	2
EntityHandlerBase::setModuleHandler	public	function	Sets the module handler for this handler.
EntityListBuilder::$entityType	protected	property	Information about the entity type.
EntityListBuilder::$entityTypeId	protected	property	The entity type ID.
EntityListBuilder::$limit	protected	property	The number of entities to list per page, or FALSE to list all entities.	3
EntityListBuilder::$storage	protected	property	The entity storage class.	1
EntityListBuilder::buildOperations	public	function	Builds a renderable list of operation links for the entity.	2
EntityListBuilder::createInstance	public static	function	Instantiates a new instance of this entity handler. Overrides EntityHandlerInterface::createInstance	20
EntityListBuilder::ensureDestination	protected	function	Ensures that a destination is present on the given URL.
EntityListBuilder::getEntityIds	protected	function	Loads entity IDs using a pager sorted by the entity id.	4
EntityListBuilder::getLabel Deprecated	protected	function	Gets the label of an entity.
EntityListBuilder::getOperations	public	function	Provides an array of information to build a list of operation links. Overrides EntityListBuilderInterface::getOperations	2
EntityListBuilder::getStorage	public	function	Gets the entity storage. Overrides EntityListBuilderInterface::getStorage
EntityListBuilder::getTitle	protected	function	Gets the title of the page.	1
EntityListBuilder::__construct	public	function	Constructs a new EntityListBuilder object.	16
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.
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.

You are here

class BusinessRuleListBuilder in Business Rules 8

Hierarchy

File

Namespace

Members

API Navigation