class KanbanLogListBuilder in Content Planner 8

Defines a class to build a listing of Kanban Log entities.

Hierarchy

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

File

modules/content_kanban/src/KanbanLogListBuilder.php, line 14

Namespace

Drupal\content_kanban

class KanbanLogListBuilder extends EntityListBuilder {

  /**
   * Custom load of entities.
   *
   * @return \Drupal\Core\Entity\EntityInterface[]
   *   Returns an array with the entities.
   */
  public function load() {
    $query = \Drupal::entityQuery('content_kanban_log');
    $query
      ->sort('created', 'DESC');
    $result = $query
      ->execute();
    return $this->storage
      ->loadMultiple($result);
  }

  /**
   * {@inheritdoc}
   */
  public function buildHeader() {
    $header['id'] = $this
      ->t('Kanban Log ID');
    $header['name'] = $this
      ->t('Name');
    $header['workflow'] = $this
      ->t('Workflow');
    $header['entity'] = $this
      ->t('Entity / Entity ID');
    $header['state_from'] = $this
      ->t('State from');
    $header['state_to'] = $this
      ->t('State to');
    return $header + parent::buildHeader();
  }

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

    /* @var $entity \Drupal\content_kanban\Entity\KanbanLog */
    $row['id'] = $entity
      ->id();
    $row['name'] = $entity
      ->label();

    // Workflow.
    if ($workflow = $entity
      ->getWorkflow()) {
      $row['workflow'] = $workflow
        ->label();
    }
    else {
      $row['workflow'] = t('Workflow with ID @id does not exist anymore', [
        '@id' => $entity
          ->getWorkflowId(),
      ]);
    }
    if ($logEntity = $entity
      ->getEntityObject()) {
      $row['entity'] = new Link($logEntity
        ->label(), $logEntity
        ->toUrl());
    }
    else {
      $row['entity'] = t('Entity @entity_type with ID @id does not exist anymore', [
        '@id' => $entity
          ->getEntityId(),
        '@entity_type' => $entity
          ->getType(),
      ]);
    }
    $row['state_from'] = $entity
      ->getStateFrom();
    $row['state_to'] = $entity
      ->getStateTo();
    return $row + parent::buildRow($entity);
  }

}

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::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::render	public	function	Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilderInterface::render	16
EntityListBuilder::__construct	public	function	Constructs a new EntityListBuilder object.	16
KanbanLogListBuilder::buildHeader	public	function	Builds the header row for the entity listing. Overrides EntityListBuilder::buildHeader
KanbanLogListBuilder::buildRow	public	function	Builds a row for an entity in the entity listing. Overrides EntityListBuilder::buildRow
KanbanLogListBuilder::load	public	function	Custom load of entities. Overrides EntityListBuilder::load
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.