class ScheduleListBuilder in Business Rules 8

Defines a class to build a listing of Schedule entities.

Hierarchy

• class \Drupal\Core\Entity\EntityHandlerBase uses DependencySerializationTrait, StringTranslationTrait
  • class \Drupal\Core\Entity\EntityListBuilder implements EntityHandlerInterface, EntityListBuilderInterface uses MessengerTrait, RedirectDestinationTrait
    • class \Drupal\business_rules\ScheduleListBuilder

File

src/ScheduleListBuilder.php, line 15

Namespace

Drupal\business_rules

class ScheduleListBuilder extends EntityListBuilder {

  /**
   * {@inheritdoc}
   */
  public function buildHeader() {

    // TODO: show links for schedules tasks and executed tasks.
    $header['id'] = $this
      ->t('Schedule ID');
    $header['triggered_by'] = $this
      ->t('Triggered by');
    $header['name'] = $this
      ->t('Name');
    $header['scheduled_date'] = $this
      ->t('Scheduled Date');
    $header['executed'] = $this
      ->t('Executed');
    $header['execution_date'] = $this
      ->t('Execution Date');
    $header['filter'] = [
      'data' => [
        '#markup' => 'filter',
      ],
      'style' => 'display: none',
    ];
    return $header + parent::buildHeader();
  }

  /**
   * {@inheritdoc}
   */
  public function buildRow(EntityInterface $entity) {
    if (!$entity
      ->id() || !$entity
      ->getTriggeredBy()) {
      return [];
    }

    /* @var $entity \Drupal\business_rules\Entity\Schedule */
    $row['id'] = $entity
      ->id();
    $row['triggered_by'] = Link::createFromRoute($entity
      ->getTriggeredBy()
      ->id(), 'entity.business_rules_action.edit_form', [
      'business_rules_action' => $entity
        ->getTriggeredBy()
        ->id(),
    ]);
    $row['name'] = Link::createFromRoute($entity
      ->label(), 'entity.business_rules_schedule.edit_form', [
      'business_rules_schedule' => $entity
        ->id(),
    ]);
    $scheduled = $entity
      ->getScheduled() ? \Drupal::service('date.formatter')
      ->format($entity
      ->getScheduled(), 'medium') : '';
    $executed = $entity
      ->getExecutedTime() ? \Drupal::service('date.formatter')
      ->format($entity
      ->getExecutedTime(), 'medium') : '';
    $row['scheduled_date'] = $scheduled;
    $row['executed'] = $entity
      ->isExecuted() ? $this
      ->t('Yes') : $this
      ->t('No');
    $row['execution_date'] = $executed;
    $search_string = $entity
      ->id() . ' ' . $entity
      ->label() . ' ' . $entity
      ->getTriggeredBy()
      ->id() . ' ' . $entity
      ->getName() . ' ' . $scheduled . ' ' . $executed;
    $row['filter'] = [
      'data' => [
        [
          '#markup' => '<span class="table-filter-text-source">' . $search_string . '</span>',
        ],
      ],
      'style' => [
        'display: none',
      ],
    ];
    return $row + parent::buildRow($entity);
  }

  /**
   * {@inheritdoc}
   */
  public function getOperations(EntityInterface $entity) {
    $operations = parent::getOperations($entity);
    $operations['execute'] = [
      'title' => $this
        ->t('Execute'),
      'url' => Url::fromRoute('entity.business_rules_schedule.execute', [
        'business_rules_schedule' => $entity
          ->id(),
      ]),
      'weight' => 20,
    ];
    uasort($operations, '\\Drupal\\Component\\Utility\\SortArray::sortByWeightElement');
    return $operations;
  }

  /**
   * {@inheritdoc}
   */
  public function render() {
    $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 item'),
      '#attributes' => [
        'class' => [
          'table-filter-text',
        ],
        'data-table' => '.searchable-list',
        'autocomplete' => 'off',
        'title' => $this
          ->t('Enter a part of the item to filter by.'),
      ],
    ];
    $output += parent::render();
    if (!isset($output['table']['#attributes']['class'])) {
      $output['table']['#attributes']['class'] = [
        'searchable-list',
      ];
    }
    else {
      $output['table']['#attributes']['class'][] = [
        'searchable-list',
      ];
    }
    return $output;
  }

  /**
   * {@inheritdoc}
   */
  public function load() {
    $view_mode = \Drupal::request()
      ->get('view_mode');
    if ($view_mode == 'not_executed') {
      $entity_ids = \Drupal::entityQuery('business_rules_schedule')
        ->condition('status', 1, '<>')
        ->sort('scheduled', 'ASC')
        ->execute();
    }
    elseif ($view_mode == 'executed') {
      $entity_ids = \Drupal::entityQuery('business_rules_schedule')
        ->condition('status', 1, '=')
        ->sort('executed', 'DESC')
        ->execute();
    }
    else {
      $entity_ids = \Drupal::entityQuery('business_rules_schedule')
        ->sort('id', 'DESC')
        ->execute();
    }
    return $this->storage
      ->loadMultiple($entity_ids);
  }

}

Members

Name	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::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::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
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.
ScheduleListBuilder::buildHeader	public	function	Builds the header row for the entity listing. Overrides EntityListBuilder::buildHeader
ScheduleListBuilder::buildRow	public	function	Builds a row for an entity in the entity listing. Overrides EntityListBuilder::buildRow
ScheduleListBuilder::getOperations	public	function	Provides an array of information to build a list of operation links. Overrides EntityListBuilder::getOperations
ScheduleListBuilder::load	public	function	Loads entities of this type from storage for listing. Overrides EntityListBuilder::load
ScheduleListBuilder::render	public	function	Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilder::render
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.