You are here

class ClusterListBuilder in Elasticsearch Connector 8.2

Same name and namespace in other branches
  1. 8.7 src/Controller/ClusterListBuilder.php \Drupal\elasticsearch_connector\Controller\ClusterListBuilder
  2. 8 src/Controller/ClusterListBuilder.php \Drupal\elasticsearch_connector\Controller\ClusterListBuilder
  3. 8.5 src/Controller/ClusterListBuilder.php \Drupal\elasticsearch_connector\Controller\ClusterListBuilder
  4. 8.6 src/Controller/ClusterListBuilder.php \Drupal\elasticsearch_connector\Controller\ClusterListBuilder

Provides a listing of Clusters along with their indices.

Hierarchy

Expanded class hierarchy of ClusterListBuilder

File

src/Controller/ClusterListBuilder.php, line 24
Contains \Drupal\elasticsearch_connector\Controller\ClusterListBuilder.

Namespace

Drupal\elasticsearch_connector\Controller
View source
class ClusterListBuilder extends ConfigEntityListBuilder {

  /**
   * EntityStorageInterface.
   */
  protected $indexStorage;

  /**
   * @var ClientManagerInterface
   */
  private $clientManager;

  /**
   * {@inheritdoc}
   */
  public function __construct(EntityTypeInterface $entity_type, EntityStorageInterface $storage, EntityStorageInterface $index_storage, ClientManagerInterface $client_manager) {
    parent::__construct($entity_type, $storage);
    $this->indexStorage = $index_storage;
    $this->clientManager = $client_manager;
  }

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

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

    /** @var Cluster[] $clusters */
    $clusters = $this->storage
      ->loadMultiple();

    /** @var Index[] $indices */
    $indices = $this->indexStorage
      ->loadMultiple();
    $cluster_groups = array();
    $lone_indices = array();
    foreach ($clusters as $cluster) {
      $cluster_group = array(
        'cluster.' . $cluster->cluster_id => $cluster,
      );
      foreach ($indices as $index) {
        if ($index->server == $cluster->cluster_id) {
          $cluster_group['index.' . $index->index_id] = $index;
        }
        elseif ($index->server == NULL) {
          $lone_indices['index.' . $index->index_id] = $index;
        }
      }
      $cluster_groups['cluster.' . $cluster->cluster_id] = $cluster_group;
    }
    return array(
      'clusters' => $cluster_groups,
      'lone_indexes' => $lone_indices,
    );
  }

  /**
   * {@inheritdoc}
   */
  public function buildHeader() {
    return array(
      'type' => $this
        ->t('Type'),
      'title' => $this
        ->t('Name'),
      'machine_name' => $this
        ->t('Machine Name'),
      'status' => $this
        ->t('Status'),
      'cluster_status' => $this
        ->t('Cluster Status'),
    ) + parent::buildHeader();
  }

  /**
   * {@inheritdoc}
   */
  public function buildRow(EntityInterface $entity) {
    if ($entity instanceof Cluster) {
      $client_connector = $this->clientManager
        ->getClientForCluster($entity);
    }
    elseif ($entity instanceof Index) {
      $cluster = Cluster::load($entity->server);
      $client_connector = $this->clientManager
        ->getClientForCluster($cluster);
    }
    else {
      throw new NotFoundHttpException();
    }
    $row = parent::buildRow($entity);
    $result = array();
    $status = NULL;
    if (isset($entity->cluster_id)) {
      $cluster = Cluster::load($entity->cluster_id);
      if ($client_connector
        ->isClusterOk()) {
        $cluster_health = $client_connector
          ->cluster()
          ->health();
        $version_number = $client_connector
          ->getServerVersion();
        $status = $cluster_health['status'];
      }
      else {
        $status = $this
          ->t('Not available');
        $version_number = $this
          ->t('Unknown version');
      }
      $result = array(
        'data' => array(
          'type' => array(
            'data' => $this
              ->t('Cluster'),
          ),
          'title' => array(
            'data' => array(
              '#type' => 'link',
              '#title' => $entity
                ->label() . ' (' . $version_number . ')',
              '#url' => new Url('entity.elasticsearch_cluster.edit_form', array(
                'elasticsearch_cluster' => $entity
                  ->id(),
              )),
            ),
          ),
          'machine_name' => array(
            'data' => $entity
              ->id(),
          ),
          'status' => array(
            'data' => $cluster->status ? 'Active' : 'Inactive',
          ),
          'clusterStatus' => array(
            'data' => $status,
          ),
          'operations' => $row['operations'],
        ),
        'title' => $this
          ->t('Machine name: @name', array(
          '@name' => $entity
            ->id(),
        )),
      );
    }
    elseif (isset($entity->index_id)) {
      $result = array(
        'data' => array(
          'type' => array(
            'data' => $this
              ->t('Index'),
            'class' => array(
              'es-list-index',
            ),
          ),
          'title' => array(
            'data' => $entity
              ->label(),
          ),
          'machine_name' => array(
            'data' => $entity
              ->id(),
          ),
          'status' => array(
            'data' => '',
          ),
          'clusterStatus' => array(
            'data' => '-',
          ),
          'operations' => $row['operations'],
        ),
        'title' => $this
          ->t('Machine name: @name', array(
          '@name' => $entity
            ->id(),
        )),
      );
    }
    return $result;
  }

  /**
   * {@inheritdoc}
   */
  public function getDefaultOperations(EntityInterface $entity) {
    $operations = array();
    if (isset($entity->cluster_id)) {
      $operations['info'] = array(
        'title' => $this
          ->t('Info'),
        'weight' => 19,
        'url' => new Url('entity.elasticsearch_cluster.canonical', array(
          'elasticsearch_cluster' => $entity
            ->id(),
        )),
      );
      $operations['edit'] = array(
        'title' => $this
          ->t('Edit'),
        'weight' => 20,
        'url' => new Url('entity.elasticsearch_cluster.edit_form', array(
          'elasticsearch_cluster' => $entity
            ->id(),
        )),
      );
      $operations['delete'] = array(
        'title' => $this
          ->t('Delete'),
        'weight' => 21,
        'url' => new Url('entity.elasticsearch_cluster.delete_form', array(
          'elasticsearch_cluster' => $entity
            ->id(),
        )),
      );
    }
    elseif (isset($entity->index_id)) {
      $operations['delete'] = array(
        'title' => $this
          ->t('Delete'),
        'weight' => 20,
        'url' => new Url('entity.elasticsearch_index.delete_form', array(
          'elasticsearch_index' => $entity
            ->id(),
        )),
      );
    }
    return $operations;
  }

  /**
   * {@inheritdoc}
   */
  public function render() {
    $entity_groups = $this
      ->group();
    $rows = array();
    foreach ($entity_groups['clusters'] as $cluster_group) {
      foreach ($cluster_group as $entity) {
        $rows[$entity
          ->id()] = $this
          ->buildRow($entity);
      }
    }
    $list['#type'] = 'container';
    $list['#attached']['library'][] = 'elasticsearch_connector/drupal.elasticsearch_connector.ec_index';
    $list['clusters'] = array(
      '#type' => 'table',
      '#header' => $this
        ->buildHeader(),
      '#rows' => $rows,
      '#empty' => $this
        ->t('No clusters available. <a href="@link">Add new cluster</a>.', array(
        '@link' => \Drupal::urlGenerator()
          ->generate('entity.elasticsearch_cluster.add_form'),
      )),
    );
    return $list;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ClusterListBuilder::$clientManager private property
ClusterListBuilder::$indexStorage protected property EntityStorageInterface.
ClusterListBuilder::buildHeader public function Builds the header row for the entity listing. Overrides EntityListBuilder::buildHeader
ClusterListBuilder::buildRow public function Builds a row for an entity in the entity listing. Overrides EntityListBuilder::buildRow
ClusterListBuilder::createInstance public static function Instantiates a new instance of this entity handler. Overrides EntityListBuilder::createInstance
ClusterListBuilder::getDefaultOperations public function Gets this list's default operations. Overrides ConfigEntityListBuilder::getDefaultOperations
ClusterListBuilder::group public function
ClusterListBuilder::render public function Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilder::render
ClusterListBuilder::__construct public function Constructs a new EntityListBuilder object. Overrides EntityListBuilder::__construct
ConfigEntityListBuilder::load public function Loads entities of this type from storage for listing. Overrides EntityListBuilder::load 7
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
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.