You are here

Home » API reference » Apigee Edge 8 » EdgeEntityListBuilder.php

class EdgeEntityListBuilder in Apigee Edge 8

Default entity list builder for Apigee Edge entities.

Hierarchy

Expanded class hierarchy of EdgeEntityListBuilder

3 files declare their use of EdgeEntityListBuilder
EdgeEntityDisplaySettingsForm.php in src/Form/EdgeEntityDisplaySettingsForm.php
EdgeEntityType.php in src/Entity/EdgeEntityType.php
TeamListBuilder.php in modules/apigee_edge_teams/src/Entity/ListBuilder/TeamListBuilder.php

File

src/Entity/ListBuilder/EdgeEntityListBuilder.php, line 33

Namespace

Drupal\apigee_edge\Entity\ListBuilder
View source 
class EdgeEntityListBuilder extends EntityListBuilder {

  /**
   * The default display type.
   */
  const DEFAULT_DISPLAY_TYPE = 'default';

  /**
   * The view mode display type.
   */
  const VIEW_MODE_DISPLAY_TYPE = 'view_mode';

  /**
   * The entity type manager service.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The config factory.
   *
   * @var \Drupal\Core\Config\ConfigFactoryInterface
   */
  protected $configFactory;

  /**
   * EdgeEntityListBuilder constructor.
   *
   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
   *   The entity type definition.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The config factory.
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   */
  public function __construct(EntityTypeInterface $entity_type, EntityTypeManagerInterface $entity_type_manager, ConfigFactoryInterface $config_factory = NULL) {
    parent::__construct($entity_type, $entity_type_manager
      ->getStorage($entity_type
      ->id()));
    $this->entityTypeManager = $entity_type_manager;
    if (!$config_factory) {
      $config_factory = \Drupal::service('config.factory');
    }
    $this->configFactory = $config_factory;

    // Disable pager for now for all Apigee Edge entities.
    $this->limit = 0;
  }

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

  /**
   * {@inheritdoc}
   */
  protected final function getEntityIds() {
    $query = $this
      ->buildEntityIdQuery();
    return $query
      ->execute();
  }

  /**
   * Builds an entity query used by entity listing.
   *
   * @return \Drupal\Core\Entity\Query\QueryInterface
   *   The entity query.
   */
  protected function buildEntityIdQuery() : QueryInterface {
    $headers = $this
      ->buildHeader();
    $query = $this
      ->getStorage()
      ->getQuery()
      ->tableSort($headers);

    // Only add the pager if a limit is specified.
    if ($this->limit) {
      $query
        ->pager($this->limit);
    }
    return $query;
  }

  /**
   * {@inheritdoc}
   */
  public function render() {
    $settings = $this
      ->getDisplaySettings();
    if ($this
      ->usingDisplayType(static::VIEW_MODE_DISPLAY_TYPE)) {
      $build = $this
        ->renderUsingViewMode($settings['view_mode']);
    }
    else {
      $build = parent::render();
    }

    // Add cache contexts.
    $build['#cache'] = [
      'contexts' => $this->entityType
        ->getListCacheContexts(),
      'tags' => $this->entityType
        ->getListCacheTags(),
      'max-age' => $this
        ->getCacheMaxAge(),
    ];
    return $build;
  }

  /**
   * Renders a list of entities using the provided view mode.
   *
   * @param string $view_mode
   *   The view mode.
   *
   * @return array
   *   A renderable array.
   */
  protected function renderUsingViewMode($view_mode) : array {
    return [
      '#type' => 'apigee_entity_list',
      '#entities' => $this
        ->load(),
      '#entity_type' => $this->entityType,
      '#view_mode' => $view_mode,
    ];
  }

  /**
   * Returns TRUE if entity type is configure to use provided display type.
   *
   * @param string $display_type
   *   The display type.
   *
   * @return bool
   *   TRUE if using provided display type. FALSE otherwise.
   */
  protected function usingDisplayType($display_type) : bool {
    $settings = $this
      ->getDisplaySettings();
    if (empty($settings['display_type'])) {
      return FALSE;
    }
    return $settings['display_type'] === $display_type;
  }

  /**
   * Returns the display settings.
   *
   * @return array
   *   An array of display settings.
   */
  protected function getDisplaySettings() : array {
    return $this->configFactory
      ->get("apigee_edge.display_settings.{$this->entityTypeId}")
      ->getRawData();
  }

  /**
   * Returns the cache max age.
   *
   * @return int
   *   The cache max age.
   */
  protected function getCacheMaxAge() {
    return 0;
  }

}

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
EdgeEntityListBuilder::$configFactory protected property The config factory. 1
EdgeEntityListBuilder::$entityTypeManager protected property The entity type manager service.
EdgeEntityListBuilder::buildEntityIdQuery protected function Builds an entity query used by entity listing. 2
EdgeEntityListBuilder::createInstance public static function Instantiates a new instance of this entity handler. Overrides EntityListBuilder::createInstance 1
EdgeEntityListBuilder::DEFAULT_DISPLAY_TYPE constant The default display type.
EdgeEntityListBuilder::getCacheMaxAge protected function Returns the cache max age. 2
EdgeEntityListBuilder::getDisplaySettings protected function Returns the display settings.
EdgeEntityListBuilder::getEntityIds final protected function Loads entity IDs using a pager sorted by the entity id. Overrides EntityListBuilder::getEntityIds
EdgeEntityListBuilder::render public function Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilder::render 2
EdgeEntityListBuilder::renderUsingViewMode protected function Renders a list of entities using the provided view mode.
EdgeEntityListBuilder::usingDisplayType protected function Returns TRUE if entity type is configure to use provided display type.
EdgeEntityListBuilder::VIEW_MODE_DISPLAY_TYPE constant The view mode display type.
EdgeEntityListBuilder::__construct public function EdgeEntityListBuilder constructor. Overrides EntityListBuilder::__construct 1
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::buildHeader public function Builds the header row for the entity listing. 26
EntityListBuilder::buildOperations public function Builds a renderable list of operation links for the entity. 2
EntityListBuilder::buildRow public function Builds a row for an entity in the entity listing. 26
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::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.