PCC-59: Views integration with pcc site entity.

pcx_connect.views.inc

@@ -0,0 +1,130 @@
+<?php
+
+/**
+ * @file
+ * Views hook implementations for the PCX Connect module.
+ */
+
+use Drupal\pcx_connect\Entity\PccSite;
+use Drupal\pcx_connect\PccSiteViewHelper;
+
+/**
+ * Implements hook_views_data().
+ */
+function pcx_connect_views_data() {
+  $data = [];
+
+  $pcc_sites = PccSite::loadMultiple();
+  if ($pcc_sites) {
+    foreach ($pcc_sites as $pcc_site) {
+      $id = $pcc_site->getEntityTypeId();
+      $name = $pcc_site->label();
+      $table = &$data[$pcc_site->id()];
+      // Base data.
+      $table['table']['group'] = t('PCC Site - @name', ['@name' => $name]);
+      $table['table']['provider'] = $id;
+
+      // Locate the config entity type's ID.
+      $entityType = \Drupal::entityTypeManager()
+        ->getStorage($id)
+        ->getEntityType();
+      $id_key = $entityType->getKey('id');
+
+      // Get entity fields.
+      $fields = PccSiteViewHelper::getMapping($id);
+      if (empty($fields[$id_key])) {
+        continue;
+      }
+      if (empty($fields[$id_key]['label'])) {
+        continue;
+      }
+
+      $table['table']['base'] = [
+        'field' => strtolower($fields[$id_key]['label']),
+        'index' => strtolower($fields[$id_key]['label']),
+        'title' => t('PCC Site - @name', ['@name' => $name]),
+        'help' => t('Use the ConfigEntity @name to view the data.', ['@name' => $name]),
+        'query_id' => 'pcc_site_view_query',
+      ];
+
+      $table['title'] = [
+        'title' => t('Title'),
+        'help' => t('Article title'),
+        'field' => [
+          'id' => 'standard',
+          'click sortable' => TRUE,
+        ],
+        'sort' => [
+          'id' => 'standard',
+        ],
+        'filter' => [
+          'id' => 'string',
+        ],
+        'argument' => [
+          'id' => 'string',
+        ],
+      ];
+
+      $table['content'] = [
+        'title' => t('Content'),
+        'help' => t('Article Content'),
+        'field' => [
+          'id' => 'standard',
+          'click sortable' => FALSE,
+        ],
+        'filter' => [
+          'id' => 'string',
+        ],
+      ];
+
+      $table['snippet'] = [
+        'title' => t('Snippet'),
+        'help' => t('Article Snippet'),
+        'field' => [
+          'id' => 'standard',
+          'click sortable' => FALSE,
+        ],
+        'filter' => [
+          'id' => 'string',
+        ],
+      ];
+
+      $table['publishedAt'] = [
+        'title' => t('Published At'),
+        'help' => t('Article publish time'),
+        'field' => [
+          'id' => 'date',
+          'click sortable' => TRUE,
+        ],
+        'filter' => [
+          'id' => 'date',
+        ],
+        'sort' => [
+          'id' => 'date',
+        ],
+        'argument' => [
+          'id' => 'date',
+        ],
+      ];
+
+      $table['updatedAt'] = [
+        'title' => t('Updated At'),
+        'help' => t('Article update time'),
+        'field' => [
+          'id' => 'date',
+          'click sortable' => TRUE,
+        ],
+        'filter' => [
+          'id' => 'date',
+        ],
+        'sort' => [
+          'id' => 'date',
+        ],
+        'argument' => [
+          'id' => 'date',
+        ],
+      ];
+    }
+  }
+  return array_filter($data);
+}

src/Controller/ApiStatusController.php

@@ -6,17 +6,18 @@
 use Symfony\Component\HttpFoundation\JsonResponse;
 
 /**
- * Api Status Controller responsible for returning response for pcc site status endpoint.
+ * Api Status Controller for returning response for pcc site status endpoint.
  */
 class ApiStatusController extends ControllerBase {
 
   /**
    * Returns empty response.
    *
-   * @return JsonResponse
+   * @return \Symfony\Component\HttpFoundation\JsonResponse
    *   Empty JSON response.
    */
   public function emptyResponse() {
     return new JsonResponse();
   }
+
 }

src/Entity/PccSite.php

@@ -3,7 +3,9 @@
 namespace Drupal\pcx_connect\Entity;
 
 use Drupal\Core\Config\Entity\ConfigEntityBase;
+use Drupal\Core\Entity\EntityStorageInterface;
 use Drupal\pcx_connect\PccSiteInterface;
+use Drupal\views\Views;
 
 /**
  * Defines the PCC Site entity.
@@ -54,4 +56,17 @@ class PccSite extends ConfigEntityBase implements PccSiteInterface {
    */
   protected $label;
 
+  /**
+   * {@inheritdoc}
+   */
+  public function postSave(EntityStorageInterface $storage, $update = TRUE) {
+    parent::postSave($storage, $update);
+
+    // Clear cache to populate the PCC site in views.
+    if (\Drupal::moduleHandler()->moduleExists('views')) {
+      Views::viewsData()->clear();
+      \Drupal::cache('discovery')->delete('views:wizard');
+    }
+  }
+
 }

src/PccSiteViewHelper.php

@@ -0,0 +1,81 @@
+<?php
+
+namespace Drupal\pcx_connect;
+
+/**
+ * Helper methods for adding custom behavior to the view.
+ */
+class PccSiteViewHelper {
+
+  /**
+   * Retrieves mapping for Config Entity.
+   *
+   * @param string $id
+   *   Config Entity id.
+   *
+   * @return array|null
+   *   Returns array of Entity attributes.
+   *
+   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
+   */
+  public static function getMapping(string $id): ?array {
+    $config_type_all = self::getConfigTypedDefinitions();
+    $config_prefix = self::getConfigPrefix($id);
+
+    foreach ($config_type_all as $key => $value) {
+      if (isset($value['type']) && $value['type'] == 'config_entity') {
+        if (strpos($key, $config_prefix) === 0) {
+          return ($value['mapping'] ?? NULL);
+        }
+      }
+    }
+
+    // Return an empty array to avoid PHP errors when field definitions.
+    // That haven't been loaded yet or there is no mapping for the config
+    // entity.
+    return [];
+  }
+
+  /**
+   * Gets provider and config prefix for Config Entity.
+   *
+   * @param string $id
+   *   Config Entity id.
+   *
+   * @return string
+   *   Returns config prefix.
+   *
+   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
+   */
+  protected static function getConfigPrefix(string $id): string {
+    return \Drupal::entityTypeManager()->getDefinition($id)->getConfigPrefix();
+  }
+
+  /**
+   * Gets the config.typed service.
+   *
+   * @return mixed
+   *   Definitions of config.typed service.
+   */
+  protected static function getConfigTypedDefinitions() {
+    return \Drupal::service('config.typed')->getDefinitions();
+  }
+
+  /**
+   * Gets the Config Entity Label.
+   *
+   * @param string $id
+   *   Config Entity iD.
+   *
+   * @return string
+   *   Config Entity label used in the group list.
+   *
+   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
+   */
+  public static function getConfigLabel(string $id): string {
+    return (string) \Drupal::entityTypeManager()
+      ->getDefinition($id)
+      ->getLabel();
+  }
+
+}

src/Plugin/views/query/PccSiteViewQuery.php

@@ -0,0 +1,93 @@
+<?php
+
+namespace Drupal\pcx_connect\Plugin\views\query;
+
+use Drupal\views\Plugin\views\query\QueryPluginBase;
+use Drupal\views\ResultRow;
+use Drupal\views\ViewExecutable;
+use GuzzleHttp\ClientInterface;
+use Symfony\Component\DependencyInjection\ContainerInterface;
+
+/**
+ * Defines a Views query class for Config Entities.
+ *
+ * @ViewsQuery(
+ *   id = "pcc_site_view_query",
+ *   title = @Translation("Configuration Entity"),
+ *   help = @Translation("Configuration Entity Query")
+ * )
+ */
+class PccSiteViewQuery extends QueryPluginBase {
+
+  /**
+   * Constructs a PccSiteViewQuery object.
+   *
+   * @param array $configuration
+   *   A configuration array containing information about the plugin instance.
+   * @param string $plugin_id
+   *   The plugin_id for the plugin instance.
+   * @param mixed $plugin_definition
+   *   The database-specific date handler.
+   * @param \GuzzleHttp\ClientInterface $httpClient
+   *   The HTTP client.
+   */
+  public function __construct(array $configuration, $plugin_id, $plugin_definition, public ClientInterface $httpClient) {
+    parent::__construct($configuration, $plugin_id, $plugin_definition);
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
+    return new static(
+      $configuration,
+      $plugin_id,
+      $plugin_definition,
+      $container->get('http_client')
+    );
+  }
+
+  /**
+   * Ensures a table exists in the query.
+   *
+   * @return string
+   *   An empty string.
+   */
+  public function ensureTable(): string {
+    return '';
+  }
+
+  /**
+   * Adds a field to the table.
+   *
+   * @param string|null $table
+   *   Ignored.
+   * @param string $field
+   *   The combined property path of the property that should be retrieved.
+   * @param string $alias
+   *   (optional) Ignored.
+   * @param array $params
+   *   (optional) Ignored.
+   *
+   * @return string
+   *   The name that this field can be referred to as (always $field).
+   *
+   * @see \Drupal\views\Plugin\views\query\Sql::addField()
+   */
+  public function addField($table, $field, $alias = '', $params = []): string {
+    return $field;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function execute(ViewExecutable $view): void {
+    // @todo This will need in coming tickets, so keep it now.
+    // $base_table = $view->storage->get('base_table');
+    // Load current pcc site.
+    // $pcc_site = PccSite::load($base_table);
+    $row = [];
+    $view->result[] = new ResultRow($row);
+  }
+
+}