You are here

Home » API reference » General Data Protection Regulation 8 » TaskListBuilder.php

class TaskListBuilder in General Data Protection Regulation 8

Same name and namespace in other branches
  1. 8.2 modules/gdpr_tasks/src/TaskListBuilder.php \Drupal\gdpr_tasks\TaskListBuilder
  2. 3.0.x modules/gdpr_tasks/src/TaskListBuilder.php \Drupal\gdpr_tasks\TaskListBuilder

Defines a class to build a listing of Task entities.

Hierarchy

Expanded class hierarchy of TaskListBuilder

File

modules/gdpr_tasks/src/TaskListBuilder.php, line 18

Namespace

Drupal\gdpr_tasks
View source 
class TaskListBuilder extends EntityListBuilder {

  /**
   * The entity bundle storage class.
   *
   * @var \Drupal\Core\Entity\EntityStorageInterface
   */
  protected $bundleStorage;

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

  /**
   * Constructs a new EntityListBuilder object.
   *
   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
   *   The entity type definition.
   * @param \Drupal\Core\Entity\EntityStorageInterface $storage
   *   The entity storage class.
   * @param \Drupal\Core\Entity\EntityStorageInterface $bundle_storage
   *   The entity bundle storage class.
   */
  public function __construct(EntityTypeInterface $entity_type, EntityStorageInterface $storage, EntityStorageInterface $bundle_storage) {
    parent::__construct($entity_type, $storage);
    $this->bundleStorage = $bundle_storage;
  }

  /**
   * {@inheritdoc}
   */
  public function buildHeader() {
    $header['id'] = $this
      ->t('Task ID');
    $header['name'] = $this
      ->t('Name');
    $header['user'] = $this
      ->t('User');
    $header['type'] = $this
      ->t('Type');
    $header['created'] = $this
      ->t('Requested');
    $header['requested_by'] = $this
      ->t('Requested by');
    return $header + parent::buildHeader();
  }

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

    /* @var $entity \Drupal\gdpr_tasks\Entity\Task */
    $row['id'] = $entity
      ->id();
    $row['name'] = Link::createFromRoute($entity
      ->label(), 'entity.gdpr_task.canonical', [
      'gdpr_task' => $entity
        ->id(),
    ]);
    $row['user'] = $entity
      ->getOwner()
      ->toLink()
      ->toString();
    $row['type'] = $this->bundleStorage
      ->load($entity
      ->bundle())
      ->label();
    $row['created'] = DateTimePlus::createFromTimestamp($entity
      ->getCreatedTime())
      ->format('j/m/Y - H:m');
    $date_formatter = \Drupal::service('date.formatter');
    $row['created'] .= ' - ' . $date_formatter
      ->formatDiff($entity
      ->getCreatedTime(), \Drupal::time()
      ->getRequestTime(), [
      'granularity' => 1,
    ]) . ' ago';
    $row['requested_by'] = $entity->requested_by->entity
      ->toLink()
      ->toString();
    return $row + parent::buildRow($entity);
  }

  /**
   * {@inheritdoc}
   */
  protected function getDefaultOperations(EntityInterface $entity) {
    $operations = parent::getDefaultOperations($entity);
    if ($entity
      ->access('view') && $entity
      ->hasLinkTemplate('canonical')) {
      $operations['view'] = [
        'title' => $this
          ->t('View'),
        'weight' => 0,
        'url' => $this
          ->ensureDestination($entity
          ->toUrl()),
      ];
    }
    return $operations;
  }

  /**
   * {@inheritdoc}
   */
  public function render() {
    $build['requested']['title'] = [
      '#type' => 'html_tag',
      '#tag' => 'h3',
      '#value' => 'Requested tasks',
    ];
    $build['requested']['table'] = [
      '#type' => 'table',
      '#header' => $this
        ->buildHeader(),
      '#rows' => [],
      '#empty' => $this
        ->t('There is no open @label yet.', [
        '@label' => $this->entityType
          ->getLabel(),
      ]),
      '#cache' => [
        'contexts' => $this->entityType
          ->getListCacheContexts(),
        'tags' => $this->entityType
          ->getListCacheTags(),
      ],
    ];
    $build['reviewing']['title'] = [
      '#type' => 'html_tag',
      '#tag' => 'h3',
      '#value' => 'In-review tasks',
    ];
    $build['reviewing']['table'] = [
      '#type' => 'table',
      '#header' => $this
        ->buildHeader(),
      '#rows' => [],
      '#empty' => $this
        ->t('There are no tasks to be reviewed yet.'),
      '#cache' => [
        'contexts' => $this->entityType
          ->getListCacheContexts(),
        'tags' => $this->entityType
          ->getListCacheTags(),
      ],
    ];
    $build['processed']['title'] = [
      '#type' => 'html_tag',
      '#tag' => 'h3',
      '#value' => 'Processed tasks',
    ];
    $build['processed']['table'] = [
      '#type' => 'table',
      '#header' => $this
        ->buildHeader(),
      '#rows' => [],
      '#empty' => $this
        ->t('There are no processed tasks yet.'),
      '#cache' => [
        'contexts' => $this->entityType
          ->getListCacheContexts(),
        'tags' => $this->entityType
          ->getListCacheTags(),
      ],
    ];
    $build['closed']['title'] = [
      '#type' => 'html_tag',
      '#tag' => 'h3',
      '#value' => 'Closed tasks',
    ];
    $build['closed']['table'] = [
      '#type' => 'table',
      '#header' => $this
        ->buildHeader(),
      '#rows' => [],
      '#empty' => $this
        ->t('There are no closed tasks yet.'),
      '#cache' => [
        'contexts' => $this->entityType
          ->getListCacheContexts(),
        'tags' => $this->entityType
          ->getListCacheTags(),
      ],
    ];

    /* @var $entity \Drupal\gdpr_tasks\Entity\Task */
    foreach ($this
      ->load() as $entity) {
      if ($row = $this
        ->buildRow($entity)) {
        $build[$entity->status->value]['table']['#rows'][$entity
          ->id()] = $row;
      }
    }

    // Only add the pager if a limit is specified.
    if ($this->limit) {
      $build['pager'] = [
        '#type' => 'pager',
      ];
    }
    return $build;
  }

}

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::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::load public function Loads entities of this type from storage for listing. Overrides EntityListBuilderInterface::load 4
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.
TaskListBuilder::$bundleStorage protected property The entity bundle storage class.
TaskListBuilder::buildHeader public function Builds the header row for the entity listing. Overrides EntityListBuilder::buildHeader
TaskListBuilder::buildRow public function Builds a row for an entity in the entity listing. Overrides EntityListBuilder::buildRow
TaskListBuilder::createInstance public static function Instantiates a new instance of this entity handler. Overrides EntityListBuilder::createInstance
TaskListBuilder::getDefaultOperations protected function Gets this list's default operations. Overrides EntityListBuilder::getDefaultOperations
TaskListBuilder::render public function Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilder::render
TaskListBuilder::__construct public function Constructs a new EntityListBuilder object. Overrides EntityListBuilder::__construct