Version 1
[yaffs-website] / web / core / modules / views / src / Plugin / views / row / EntityRow.php
diff --git a/web/core/modules/views/src/Plugin/views/row/EntityRow.php b/web/core/modules/views/src/Plugin/views/row/EntityRow.php
new file mode 100644 (file)
index 0000000..e98133a
--- /dev/null
@@ -0,0 +1,205 @@
+<?php
+
+namespace Drupal\views\Plugin\views\row;
+
+use Drupal\Core\Entity\EntityManagerInterface;
+use Drupal\Core\Form\FormStateInterface;
+use Drupal\Core\Language\LanguageManagerInterface;
+use Drupal\views\Entity\Render\EntityTranslationRenderTrait;
+use Drupal\views\Plugin\views\display\DisplayPluginBase;
+use Drupal\views\ViewExecutable;
+use Symfony\Component\DependencyInjection\ContainerInterface;
+
+/**
+ * Generic entity row plugin to provide a common base for all entity types.
+ *
+ * @ViewsRow(
+ *   id = "entity",
+ *   deriver = "Drupal\views\Plugin\Derivative\ViewsEntityRow"
+ * )
+ */
+class EntityRow extends RowPluginBase {
+  use EntityTranslationRenderTrait;
+
+  /**
+   * The table the entity is using for storage.
+   *
+   * @var string
+   */
+  public $base_table;
+
+  /**
+   * The actual field which is used for the entity id.
+   *
+   * @var string
+   */
+  public $base_field;
+
+  /**
+   * Stores the entity type ID of the result entities.
+   *
+   * @var string
+   */
+  protected $entityTypeId;
+
+  /**
+   * Contains the entity type of this row plugin instance.
+   *
+   * @var \Drupal\Core\Entity\EntityTypeInterface
+   */
+  protected $entityType;
+
+  /**
+   * The entity manager.
+   *
+   * @var \Drupal\Core\Entity\EntityManagerInterface
+   */
+  public $entityManager;
+
+  /**
+   * The language manager.
+   *
+   * @var \Drupal\Core\Language\LanguageManagerInterface
+   */
+  protected $languageManager;
+
+  /**
+   * {@inheritdoc}
+   *
+   * @param \Drupal\Core\Entity\EntityManagerInterface $entity_manager
+   *   The entity manager.
+   * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
+   *   The language manager.
+   */
+  public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityManagerInterface $entity_manager, LanguageManagerInterface $language_manager) {
+    parent::__construct($configuration, $plugin_id, $plugin_definition);
+
+    $this->entityManager = $entity_manager;
+    $this->languageManager = $language_manager;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function init(ViewExecutable $view, DisplayPluginBase $display, array &$options = NULL) {
+    parent::init($view, $display, $options);
+
+    $this->entityTypeId = $this->definition['entity_type'];
+    $this->entityType = $this->entityManager->getDefinition($this->entityTypeId);
+    $this->base_table = $this->entityType->getDataTable() ?: $this->entityType->getBaseTable();
+    $this->base_field = $this->entityType->getKey('id');
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
+    return new static($configuration, $plugin_id, $plugin_definition, $container->get('entity.manager'), $container->get('language_manager'));
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getEntityTypeId() {
+    return $this->entityType->id();
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  protected function getEntityManager() {
+    return $this->entityManager;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  protected function getLanguageManager() {
+    return $this->languageManager;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  protected function getView() {
+    return $this->view;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  protected function defineOptions() {
+    $options = parent::defineOptions();
+    $options['view_mode'] = ['default' => 'default'];
+    return $options;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function buildOptionsForm(&$form, FormStateInterface $form_state) {
+    parent::buildOptionsForm($form, $form_state);
+
+    $form['view_mode'] = [
+      '#type' => 'select',
+      '#options' => \Drupal::entityManager()->getViewModeOptions($this->entityTypeId),
+      '#title' => $this->t('View mode'),
+      '#default_value' => $this->options['view_mode'],
+    ];
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function summaryTitle() {
+    $options = \Drupal::entityManager()->getViewModeOptions($this->entityTypeId);
+    if (isset($options[$this->options['view_mode']])) {
+      return $options[$this->options['view_mode']];
+    }
+    else {
+      return $this->t('No view mode selected');
+    }
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function query() {
+    parent::query();
+    $this->getEntityTranslationRenderer()->query($this->view->getQuery());
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function preRender($result) {
+    parent::preRender($result);
+    if ($result) {
+      $this->getEntityTranslationRenderer()->preRender($result);
+    }
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function render($row) {
+    return $this->getEntityTranslationRenderer()->render($row);
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function calculateDependencies() {
+    $dependencies = parent::calculateDependencies();
+
+    $view_mode = $this->entityManager
+      ->getStorage('entity_view_mode')
+      ->load($this->entityTypeId . '.' . $this->options['view_mode']);
+    if ($view_mode) {
+      $dependencies[$view_mode->getConfigDependencyKey()][] = $view_mode->getConfigDependencyName();
+    }
+
+    return $dependencies;
+  }
+
+}