You are here

Home » API reference » Consumers 8 » ConsumerListBuilder.php

class ConsumerListBuilder in Consumers 8

Defines a class to build a listing of Access Token entities.

Hierarchy

Expanded class hierarchy of ConsumerListBuilder

File

src/ConsumerListBuilder.php, line 12

Namespace

Drupal\consumers
View source 
class ConsumerListBuilder extends EntityListBuilder {

  /**
   * {@inheritdoc}
   */
  public function buildHeader() {
    $header['uuid'] = $this
      ->t('UUID');
    $header['label'] = $this
      ->t('Label');
    $header['is_default'] = $this
      ->t('Is Default?');
    $context = [
      'type' => 'header',
    ];
    $this
      ->moduleHandler()
      ->alter('consumers_list', $header, $context);
    $header = $header + parent::buildHeader();
    return $header;
  }

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

    /* @var $entity \Drupal\consumers\Entity\Consumer */
    $row['uuid'] = $entity
      ->uuid();
    $row['label'] = $entity
      ->toLink();
    $ops = [
      '#type' => 'operations',
      '#links' => [
        [
          'title' => $this
            ->t('Make Default'),
          'url' => $entity
            ->toUrl('make-default-form', [
            'query' => $this
              ->getDestinationArray(),
          ]),
        ],
      ],
    ];
    $row['is_default'] = $entity
      ->get('is_default')->value ? [
      'data' => $this
        ->t('Default'),
    ] : [
      'data' => $ops,
    ];
    $context = [
      'type' => 'row',
      'entity' => $entity,
    ];
    $this
      ->moduleHandler()
      ->alter('consumers_list', $row, $context);
    $row = $row + parent::buildRow($entity);
    return $row;
  }

  /**
   * {@inheritdoc}
   */
  public function getOperations(EntityInterface $entity) {
    $operations = parent::getOperations($entity);
    if ($entity
      ->access('update') && $entity
      ->hasLinkTemplate('make-default-form') && !$entity
      ->get('is_default')->value) {
      $operations['make-default'] = [
        'title' => $this
          ->t('Make Default'),
        'weight' => 10,
        'url' => $this
          ->ensureDestination($entity
          ->toUrl('make-default-form')),
      ];
    }
    return $operations;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConsumerListBuilder::buildHeader public function Builds the header row for the entity listing. Overrides EntityListBuilder::buildHeader
ConsumerListBuilder::buildRow public function Builds a row for an entity in the entity listing. Overrides EntityListBuilder::buildRow
ConsumerListBuilder::getOperations public function Provides an array of information to build a list of operation links. Overrides EntityListBuilder::getOperations
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::load public function Loads entities of this type from storage for listing. Overrides EntityListBuilderInterface::load 4
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
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.