EntityFieldRenderer.php in Search API 8

Namespace

Drupal\search_api\Plugin\views

File

src/Plugin/views/EntityFieldRenderer.php

<?php

namespace Drupal\search_api\Plugin\views;

use Drupal\search_api\Plugin\views\field\SearchApiEntityField;
use Drupal\views\Entity\Render\EntityFieldRenderer as ViewsEntityFieldRenderer;
use Drupal\views\Plugin\views\field\FieldHandlerInterface;

/**
 * Renders entity fields.
 *
 * This is used to build render arrays for all entity field values of a view
 * result set sharing the same relationship. An entity translation renderer is
 * used internally to handle entity language properly.
 *
 * Overridden in the Search API since we also need to take the datasource into
 * account, not only the relationship.
 */
class EntityFieldRenderer extends ViewsEntityFieldRenderer {

  /**
   * The datasource ID of this renderer.
   *
   * @var string|null
   */
  protected $datasourceId;

  /**
   * The property path to the entities rendered by this renderer.
   *
   * @var string|null
   */
  protected $parentPath;

  /**
   * Retrieves the datasource ID.
   *
   * @return string|null
   *   The datasource ID.
   */
  public function getDatasourceId() {
    return $this->datasourceId;
  }

  /**
   * Sets the datasource ID.
   *
   * @param string|null $datasource_id
   *   The new datasource ID.
   *
   * @return $this
   */
  public function setDatasourceId($datasource_id) {
    $this->datasourceId = $datasource_id;
    return $this;
  }

  /**
   * Retrieves the parent path.
   *
   * @return string|null
   *   The property path to the entities rendered by this renderer.
   */
  public function getParentPath() {
    return $this->parentPath;
  }

  /**
   * Sets the parent path.
   *
   * @param string|null $parent_path
   *   The property path to the entities rendered by this renderer.
   *
   * @return $this
   */
  public function setParentPath($parent_path) {
    $this->parentPath = $parent_path;
    return $this;
  }

  /**
   * Determines whether this renderer can handle the given field.
   *
   * @param \Drupal\views\Plugin\views\field\FieldHandlerInterface $field
   *   The field for which to check compatibility.
   *
   * @return bool
   *   TRUE if this renderer can handle the given field, FALSE otherwise.
   *
   * @see EntityFieldRenderer::getRenderableFieldIds()
   */
  public function compatibleWithField(FieldHandlerInterface $field) {
    if ($field instanceof SearchApiEntityField && $field->options['field_rendering'] && $field->relationship === $this->relationship && $field
      ->getDatasourceId() === $this->datasourceId && $field
      ->getParentPath() === $this->parentPath && ($field->definition['entity_type'] ?? '') === $this
      ->getEntityTypeId()) {
      return TRUE;
    }
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  protected function getEntityTranslationRenderer() {
    if (!isset($this->entityTranslationRenderer)) {
      $entity_type = $this
        ->getEntityTypeManager()
        ->getDefinition($this
        ->getEntityTypeId());
      $this->entityTranslationRenderer = new EntityTranslationRenderer($this->view, $this
        ->getLanguageManager(), $entity_type);
    }
    return $this->entityTranslationRenderer;
  }

  /**
   * {@inheritdoc}
   */
  protected function getRenderableFieldIds() {
    $field_ids = [];
    foreach ($this->view->field as $field_id => $field) {
      if ($this
        ->compatibleWithField($field)) {
        $field_ids[] = $field_id;
      }
    }
    return $field_ids;
  }

}

Classes

Name	Description
EntityFieldRenderer	Renders entity fields.