You are here

Home » API reference » RNG - Events and Registrations 8 » RuleListBuilder.php

class RuleListBuilder in RNG - Events and Registrations 8

Same name and namespace in other branches
  1. 8.2 src/Lists/RuleListBuilder.php \Drupal\rng\Lists\RuleListBuilder
  2. 3.x src/Lists/RuleListBuilder.php \Drupal\rng\Lists\RuleListBuilder

Builds a list of rng rules.

Hierarchy

Expanded class hierarchy of RuleListBuilder

File

src/Lists/RuleListBuilder.php, line 16

Namespace

Drupal\rng\Lists
View source 
class RuleListBuilder extends EntityListBuilder {

  /**
   * The RNG event manager.
   *
   * @var \Drupal\rng\EventManagerInterface
   */
  protected $eventManager;

  /**
   * The redirect destination service.
   *
   * @var \Drupal\Core\Routing\RedirectDestinationInterface
   */
  protected $redirectDestination;

  /**
   * The event entity.
   *
   * @var \Drupal\Core\Entity\EntityInterface
   */
  protected $event;

  /**
   * Constructs a new RegistrationListBuilder object.
   *
   * {@inheritdoc}
   *
   * @param \Drupal\rng\EventManagerInterface $event_manager
   *   The RNG event manager.
   * @param \Drupal\Core\Routing\RedirectDestinationInterface $redirect_destination
   *   The redirect destination service.
   */
  public function __construct(EntityTypeInterface $entity_type, EntityStorageInterface $storage, EventManagerInterface $event_manager, RedirectDestinationInterface $redirect_destination) {
    parent::__construct($entity_type, $storage);
    $this->eventManager = $event_manager;
    $this->redirectDestination = $redirect_destination;
  }

  /**
   * {@inheritdoc}
   */
  public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) {
    return new static($entity_type, $container
      ->get('entity.manager')
      ->getStorage($entity_type
      ->id()), $container
      ->get('rng.event_manager'), $container
      ->get('redirect.destination'));
  }

  /**
   * {@inheritdoc}
   *
   * @param \Drupal\Core\Entity\EntityInterface $rng_event
   *   The event entity to display registrations.
   */
  public function render(EntityInterface $rng_event = NULL) {
    if (isset($rng_event)) {
      $this->event = $rng_event;
    }
    drupal_set_message($this
      ->t('This rule list is for advanced users. Take care when committing any actions from this page.'), 'warning');
    $render = parent::render();
    $render['table']['#empty'] = t('No rules found for this event.');
    return $render;
  }

  /**
   * {@inheritdoc}
   */
  public function load() {
    if (isset($this->event)) {
      return $this->eventManager
        ->getMeta($this->event)
        ->getRules(NULL, FALSE, NULL);
    }
    return parent::load();
  }

  /**
   * {@inheritdoc}
   */
  public function getOperations(EntityInterface $entity) {
    $operations = parent::getOperations($entity);
    foreach ($operations as &$operation) {
      $operation['query'] = $this->redirectDestination
        ->getAsArray();
    }
    return $operations;
  }

  /**
   * {@inheritdoc}
   */
  public function buildHeader() {
    $header['id'] = t('id');
    $header['trigger'] = t('Trigger ID');
    $header['conditions'] = t('Conditions');
    $header['actions'] = t('Actions');
    $header['status'] = t('Status');
    return $header + parent::buildHeader();
  }

  /**
   * {@inheritdoc}
   *
   * @param \Drupal\rng\RuleInterface $entity
   *   A rule entity.
   */
  public function buildRow(EntityInterface $entity) {
    $row['id'] = $entity
      ->id();
    $row['trigger'] = $entity
      ->getTriggerID();
    $row['conditions']['data'] = array(
      '#theme' => 'links',
      '#links' => [],
      '#attributes' => [
        'class' => [
          'links',
          'inline',
        ],
      ],
    );
    foreach ($entity
      ->getConditions() as $condition) {
      $row['conditions']['data']['#links'][] = array(
        'title' => $this
          ->t('Edit', [
          '@condition_id' => $condition
            ->id(),
          '@condition' => $condition
            ->getPluginId(),
        ]),
        'url' => $condition
          ->urlInfo('edit-form'),
        'query' => $this->redirectDestination
          ->getAsArray(),
      );
    }
    $row['actions']['data'] = array(
      '#theme' => 'links',
      '#links' => [],
      '#attributes' => [
        'class' => [
          'links',
          'inline',
        ],
      ],
    );
    foreach ($entity
      ->getActions() as $action) {
      $row['actions']['data']['#links'][] = array(
        'title' => $this
          ->t('Edit', [
          '@action_id' => $action
            ->id(),
          '@action' => $action
            ->getPluginId(),
        ]),
        'url' => $action
          ->urlInfo('edit-form'),
        'query' => $this->redirectDestination
          ->getAsArray(),
      );
    }
    $row['status'] = $entity
      ->isActive() ? $this
      ->t('Active') : $this
      ->t('Inactive');
    return $row + parent::buildRow($entity);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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::ensureDestination protected function Ensures that a destination is present on the given URL.
EntityListBuilder::getDefaultOperations protected function Gets this list's default operations. 2
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::getStorage public function Gets the entity storage. Overrides EntityListBuilderInterface::getStorage
EntityListBuilder::getTitle protected function Gets the title of the page. 1
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
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.
RuleListBuilder::$event protected property The event entity.
RuleListBuilder::$eventManager protected property The RNG event manager.
RuleListBuilder::$redirectDestination protected property The redirect destination service. Overrides RedirectDestinationTrait::$redirectDestination
RuleListBuilder::buildHeader public function Builds the header row for the entity listing. Overrides EntityListBuilder::buildHeader
RuleListBuilder::buildRow public function Overrides EntityListBuilder::buildRow
RuleListBuilder::createInstance public static function Instantiates a new instance of this entity handler. Overrides EntityListBuilder::createInstance
RuleListBuilder::getOperations public function Provides an array of information to build a list of operation links. Overrides EntityListBuilder::getOperations
RuleListBuilder::load public function Loads entities of this type from storage for listing. Overrides EntityListBuilder::load
RuleListBuilder::render public function Overrides EntityListBuilder::render
RuleListBuilder::__construct public function Constructs a new RegistrationListBuilder object. Overrides EntityListBuilder::__construct
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.