You are here

trait EntityTranslationRenderTrait in Zircon Profile 8

Same name and namespace in other branches
  1. 8.0 core/modules/views/src/Entity/Render/EntityTranslationRenderTrait.php \Drupal\views\Entity\Render\EntityTranslationRenderTrait

Trait used to instantiate the view's entity translation renderer.

Hierarchy

3 files declare their use of EntityTranslationRenderTrait
BulkForm.php in core/modules/system/src/Plugin/views/field/BulkForm.php
Contains \Drupal\system\Plugin\views\field\BulkForm.
EntityOperations.php in core/modules/views/src/Plugin/views/field/EntityOperations.php
Contains \Drupal\views\Plugin\views\field\EntityOperations.
EntityRow.php in core/modules/views/src/Plugin/views/row/EntityRow.php
Contains \Drupal\views\Plugin\views\row\EntityRow.

File

core/modules/views/src/Entity/Render/EntityTranslationRenderTrait.php, line 18
Contains \Drupal\views\Entity\Render\EntityTranslationRenderTrait.

Namespace

Drupal\views\Entity\Render
View source
trait EntityTranslationRenderTrait {

  /**
   * The renderer to be used to render the entity row.
   *
   * @var \Drupal\views\Entity\Render\EntityTranslationRendererBase
   */
  protected $entityTranslationRenderer;

  /**
   * Returns the current renderer.
   *
   * @return \Drupal\views\Entity\Render\EntityTranslationRendererBase
   *   The configured renderer.
   */
  protected function getEntityTranslationRenderer() {
    if (!isset($this->entityTranslationRenderer)) {
      $view = $this
        ->getView();
      $rendering_language = $view->display_handler
        ->getOption('rendering_language');
      $langcode = NULL;
      $dynamic_renderers = array(
        '***LANGUAGE_entity_translation***' => 'TranslationLanguageRenderer',
        '***LANGUAGE_entity_default***' => 'DefaultLanguageRenderer',
      );
      if (isset($dynamic_renderers[$rendering_language])) {

        // Dynamic language set based on result rows or instance defaults.
        $renderer = $dynamic_renderers[$rendering_language];
      }
      else {
        if (strpos($rendering_language, '***LANGUAGE_') !== FALSE) {
          $langcode = PluginBase::queryLanguageSubstitutions()[$rendering_language];
        }
        else {

          // Specific langcode set.
          $langcode = $rendering_language;
        }
        $renderer = 'ConfigurableLanguageRenderer';
      }
      $class = '\\Drupal\\views\\Entity\\Render\\' . $renderer;
      $entity_type = $this
        ->getEntityManager()
        ->getDefinition($this
        ->getEntityTypeId());
      $this->entityTranslationRenderer = new $class($view, $this
        ->getLanguageManager(), $entity_type, $langcode);
    }
    return $this->entityTranslationRenderer;
  }

  /**
   * Returns the entity translation matching the configured row language.
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   The entity object the field value being processed is attached to.
   * @param \Drupal\views\ResultRow $row
   *   The result row the field value being processed belongs to.
   *
   * @return \Drupal\Core\Entity\FieldableEntityInterface
   *   The entity translation object for the specified row.
   */
  public function getEntityTranslation(EntityInterface $entity, ResultRow $row) {

    // We assume the same language should be used for all entity fields
    // belonging to a single row, even if they are attached to different entity
    // types. Below we apply language fallback to ensure a valid value is always
    // picked.
    $translation = $entity;
    if ($entity instanceof TranslatableInterface && count($entity
      ->getTranslationLanguages()) > 1) {
      $langcode = $this
        ->getEntityTranslationRenderer()
        ->getLangcode($row);
      $translation = $this
        ->getEntityManager()
        ->getTranslationFromContext($entity, $langcode);
    }
    return $translation;
  }

  /**
   * Returns the entity type identifier.
   *
   * @return string
   *   The entity type identifier.
   */
  public abstract function getEntityTypeId();

  /**
   * Returns the entity manager.
   *
   * @return \Drupal\Core\Entity\EntityManagerInterface
   *   The entity manager.
   */
  protected abstract function getEntityManager();

  /**
   * Returns the language manager.
   *
   * @return \Drupal\Core\Language\LanguageManagerInterface
   *   The language manager.
   */
  protected abstract function getLanguageManager();

  /**
   * Returns the top object of a view.
   *
   * @return \Drupal\views\ViewExecutable
   *   The view object.
   */
  protected abstract function getView();

}

Members

Namesort descending Modifiers Type Description Overrides
EntityTranslationRenderTrait::$entityTranslationRenderer protected property The renderer to be used to render the entity row.
EntityTranslationRenderTrait::getEntityManager abstract protected function Returns the entity manager. 4
EntityTranslationRenderTrait::getEntityTranslation public function Returns the entity translation matching the configured row language.
EntityTranslationRenderTrait::getEntityTranslationRenderer protected function Returns the current renderer.
EntityTranslationRenderTrait::getEntityTypeId abstract public function Returns the entity type identifier. 4
EntityTranslationRenderTrait::getLanguageManager abstract protected function Returns the language manager. 4
EntityTranslationRenderTrait::getView abstract protected function Returns the top object of a view. 4