class ClusterListBuilder in Elasticsearch Connector 8.6
Same name and namespace in other branches
- 8.7 src/Controller/ClusterListBuilder.php \Drupal\elasticsearch_connector\Controller\ClusterListBuilder
- 8 src/Controller/ClusterListBuilder.php \Drupal\elasticsearch_connector\Controller\ClusterListBuilder
- 8.2 src/Controller/ClusterListBuilder.php \Drupal\elasticsearch_connector\Controller\ClusterListBuilder
- 8.5 src/Controller/ClusterListBuilder.php \Drupal\elasticsearch_connector\Controller\ClusterListBuilder
Provides a listing of Clusters along with their indices.
Hierarchy
- class \Drupal\Core\Entity\EntityHandlerBase uses DependencySerializationTrait, StringTranslationTrait
- class \Drupal\Core\Entity\EntityListBuilder implements EntityHandlerInterface, EntityListBuilderInterface uses MessengerTrait, RedirectDestinationTrait
- class \Drupal\Core\Config\Entity\ConfigEntityListBuilder
- class \Drupal\elasticsearch_connector\Controller\ClusterListBuilder
- class \Drupal\Core\Config\Entity\ConfigEntityListBuilder
- class \Drupal\Core\Entity\EntityListBuilder implements EntityHandlerInterface, EntityListBuilderInterface uses MessengerTrait, RedirectDestinationTrait
Expanded class hierarchy of ClusterListBuilder
File
- src/
Controller/ ClusterListBuilder.php, line 19
Namespace
Drupal\elasticsearch_connector\ControllerView source
class ClusterListBuilder extends ConfigEntityListBuilder {
/**
* Storage interface for the elasticsearch_index entity.
*
* @var \Drupal\Core\Entity\EntityStorageInterface
*/
protected $indexStorage;
/**
* Storage interface for the elasticsearch_cluster entity.
*
* @var \Drupal\Core\Entity\EntityStorageInterface
*/
protected $clusterStorage;
/**
* Elasticsearch client manager service.
*
* @var \Drupal\elasticsearch_connector\ElasticSearch\ClientManagerInterface
*/
private $clientManager;
/**
* {@inheritdoc}
*/
public function __construct(EntityTypeInterface $entity_type, EntityStorageInterface $storage, EntityStorageInterface $index_storage, EntityStorageInterface $cluster_storage, ClientManagerInterface $client_manager) {
parent::__construct($entity_type, $storage);
$this->indexStorage = $index_storage;
$this->clusterStorage = $cluster_storage;
$this->clientManager = $client_manager;
}
/**
* {@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('elasticsearch_index'), $container
->get('entity_type.manager')
->getStorage('elasticsearch_cluster'), $container
->get('elasticsearch_connector.client_manager'));
}
/**
* Group Elasticsearch indices under their respective clusters.
*
* @return array
* Associative array with the following keys:
* - clusters: Array of cluster groups keyed by cluster id. Each item is
* itself an array with the cluster and any indices as values.
* - lone_indexes: Array of indices without a cluster.
*/
public function group() {
/** @var \Drupal\elasticsearch_connector\Entity\Cluster[] $clusters */
$clusters = $this->storage
->loadMultiple();
/** @var \Drupal\elasticsearch_connector\Entity\Index[] $indices */
$indices = $this->indexStorage
->loadMultiple();
$cluster_groups = [];
$lone_indices = [];
foreach ($clusters as $cluster) {
$cluster_group = [
'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 [
'clusters' => $cluster_groups,
'lone_indexes' => $lone_indices,
];
}
/**
* {@inheritdoc}
*/
public function buildHeader() {
return [
'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 = $this->clusterStorage
->load($entity->server);
$client_connector = $this->clientManager
->getClientForCluster($cluster);
}
else {
throw new NotFoundHttpException();
}
$row = parent::buildRow($entity);
$result = [];
$status = NULL;
if (isset($entity->cluster_id)) {
$cluster = $this->clusterStorage
->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 = [
'data' => [
'type' => [
'data' => $this
->t('Cluster'),
],
'title' => [
'data' => [
'#type' => 'link',
'#title' => $entity
->label() . ' (' . $version_number . ')',
'#url' => new Url('entity.elasticsearch_cluster.edit_form', [
'elasticsearch_cluster' => $entity
->id(),
]),
],
],
'machine_name' => [
'data' => $entity
->id(),
],
'status' => [
'data' => $cluster->status ? 'Active' : 'Inactive',
],
'clusterStatus' => [
'data' => $status,
],
'operations' => $row['operations'],
],
'title' => $this
->t('Machine name: @name', [
'@name' => $entity
->id(),
]),
];
}
elseif (isset($entity->index_id)) {
$result = [
'data' => [
'type' => [
'data' => $this
->t('Index'),
'class' => [
'es-list-index',
],
],
'title' => [
'data' => $entity
->label(),
],
'machine_name' => [
'data' => $entity
->id(),
],
'status' => [
'data' => '',
],
'clusterStatus' => [
'data' => '-',
],
'operations' => $row['operations'],
],
'title' => $this
->t('Machine name: @name', [
'@name' => $entity
->id(),
]),
];
}
return $result;
}
/**
* {@inheritdoc}
*/
public function getDefaultOperations(EntityInterface $entity) {
$operations = [];
if (isset($entity->cluster_id)) {
$operations['info'] = [
'title' => $this
->t('Info'),
'weight' => 19,
'url' => new Url('entity.elasticsearch_cluster.canonical', [
'elasticsearch_cluster' => $entity
->id(),
]),
];
$operations['edit'] = [
'title' => $this
->t('Edit'),
'weight' => 20,
'url' => new Url('entity.elasticsearch_cluster.edit_form', [
'elasticsearch_cluster' => $entity
->id(),
]),
];
$operations['delete'] = [
'title' => $this
->t('Delete'),
'weight' => 21,
'url' => new Url('entity.elasticsearch_cluster.delete_form', [
'elasticsearch_cluster' => $entity
->id(),
]),
];
}
elseif (isset($entity->index_id)) {
$operations['delete'] = [
'title' => $this
->t('Delete'),
'weight' => 20,
'url' => new Url('entity.elasticsearch_index.delete_form', [
'elasticsearch_index' => $entity
->id(),
]),
];
}
return $operations;
}
/**
* {@inheritdoc}
*/
public function render() {
$entity_groups = $this
->group();
$rows = [];
foreach ($entity_groups['clusters'] as $cluster_group) {
/** @var \Drupal\elasticsearch_connector\Entity\Cluster|\Drupal\elasticsearch_connector\Entity\Index $entity */
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'] = [
'#type' => 'table',
'#header' => $this
->buildHeader(),
'#rows' => $rows,
'#empty' => $this
->t('No clusters available. <a href="@link">Add new cluster</a>.', [
'@link' => \Drupal::urlGenerator()
->generate('entity.elasticsearch_cluster.add_form'),
]),
];
return $list;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ClusterListBuilder:: |
private | property | Elasticsearch client manager service. | |
ClusterListBuilder:: |
protected | property | Storage interface for the elasticsearch_cluster entity. | |
ClusterListBuilder:: |
protected | property | Storage interface for the elasticsearch_index entity. | |
ClusterListBuilder:: |
public | function |
Builds the header row for the entity listing. Overrides EntityListBuilder:: |
|
ClusterListBuilder:: |
public | function |
Builds a row for an entity in the entity listing. Overrides EntityListBuilder:: |
|
ClusterListBuilder:: |
public static | function |
Instantiates a new instance of this entity handler. Overrides EntityListBuilder:: |
|
ClusterListBuilder:: |
public | function |
Gets this list's default operations. Overrides ConfigEntityListBuilder:: |
|
ClusterListBuilder:: |
public | function | Group Elasticsearch indices under their respective clusters. | |
ClusterListBuilder:: |
public | function |
Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilder:: |
|
ClusterListBuilder:: |
public | function |
Constructs a new EntityListBuilder object. Overrides EntityListBuilder:: |
|
ConfigEntityListBuilder:: |
public | function |
Loads entities of this type from storage for listing. Overrides EntityListBuilder:: |
7 |
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
EntityHandlerBase:: |
protected | property | The module handler to invoke hooks on. | 2 |
EntityHandlerBase:: |
protected | function | Gets the module handler. | 2 |
EntityHandlerBase:: |
public | function | Sets the module handler for this handler. | |
EntityListBuilder:: |
protected | property | Information about the entity type. | |
EntityListBuilder:: |
protected | property | The entity type ID. | |
EntityListBuilder:: |
protected | property | The number of entities to list per page, or FALSE to list all entities. | 3 |
EntityListBuilder:: |
protected | property | The entity storage class. | 1 |
EntityListBuilder:: |
public | function | Builds a renderable list of operation links for the entity. | 2 |
EntityListBuilder:: |
protected | function | Ensures that a destination is present on the given URL. | |
EntityListBuilder:: |
protected | function | Loads entity IDs using a pager sorted by the entity id. | 4 |
EntityListBuilder:: |
protected | function | Gets the label of an entity. | |
EntityListBuilder:: |
public | function |
Provides an array of information to build a list of operation links. Overrides EntityListBuilderInterface:: |
2 |
EntityListBuilder:: |
public | function |
Gets the entity storage. Overrides EntityListBuilderInterface:: |
|
EntityListBuilder:: |
protected | function | Gets the title of the page. | 1 |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
RedirectDestinationTrait:: |
protected | property | The redirect destination service. | 1 |
RedirectDestinationTrait:: |
protected | function | Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url. | |
RedirectDestinationTrait:: |
protected | function | Returns the redirect destination service. | |
RedirectDestinationTrait:: |
public | function | Sets the redirect destination service. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |