trait EntityTranslationRenderTrait

Same name in other branches
  1. 9 core/modules/views/src/Entity/Render/EntityTranslationRenderTrait.php \Drupal\views\Entity\Render\EntityTranslationRenderTrait
  2. 8.9.x core/modules/views/src/Entity/Render/EntityTranslationRenderTrait.php \Drupal\views\Entity\Render\EntityTranslationRenderTrait
  3. 11.x core/modules/views/src/Entity/Render/EntityTranslationRenderTrait.php \Drupal\views\Entity\Render\EntityTranslationRenderTrait

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

Hierarchy

6 files declare their use of EntityTranslationRenderTrait
BulkForm.php in core/modules/views/src/Plugin/views/field/BulkForm.php
DataEntityRow.php in core/modules/rest/src/Plugin/views/row/DataEntityRow.php
EntityOperations.php in core/modules/views/src/Plugin/views/field/EntityOperations.php
EntityRow.php in core/modules/views/src/Plugin/views/row/EntityRow.php
LinkBase.php in core/modules/views/src/Plugin/views/field/LinkBase.php

... See full list

File

core/modules/views/src/Entity/Render/EntityTranslationRenderTrait.php, line 13

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 = [
                '***LANGUAGE_entity_translation***' => 'TranslationLanguageRenderer',
                '***LANGUAGE_entity_default***' => 'DefaultLanguageRenderer',
            ];
            $entity_type = $this->getEntityTypeManager()
                ->getDefinition($this->getEntityTypeId());
            if (isset($dynamic_renderers[$rendering_language])) {
                // Dynamic language set based on result rows or instance defaults.
                $class = '\\Drupal\\views\\Entity\\Render\\' . $dynamic_renderers[$rendering_language];
                $this->entityTranslationRenderer = new $class($view, $this->getLanguageManager(), $entity_type);
            }
            else {
                if (str_contains($rendering_language, '***LANGUAGE_')) {
                    $langcode = PluginBase::queryLanguageSubstitutions()[$rendering_language];
                }
                else {
                    // Specific langcode set.
                    $langcode = $rendering_language;
                }
                $this->entityTranslationRenderer = new ConfigurableLanguageRenderer($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.
     *
     * @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use
     *   \Drupal\views\Entity\Render\EntityTranslationRenderTrait::getEntityTranslationByRelationship
     *   instead.
     *
     * @see https://www.drupal.org/node/3311862
     */
    public function getEntityTranslation(EntityInterface $entity, ResultRow $row) {
        @trigger_error('\\Drupal\\views\\Entity\\Render\\EntityTranslationRenderTrait::getEntityTranslation is deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use \\Drupal\\views\\Entity\\Render\\EntityTranslationRenderTrait::getEntityTranslationByRelationship instead. See https://www.drupal.org/node/3311862', E_USER_DEPRECATED);
        return $this->getEntityTranslationByRelationship($entity, $row);
    }
    
    /**
     * 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.
     * @param string $relationship
     *   The relationship to be used, or 'none' by default.
     *
     * @return \Drupal\Core\Entity\EntityInterface
     *   The entity translation object for the specified row.
     */
    public function getEntityTranslationByRelationship(EntityInterface $entity, ResultRow $row, string $relationship = 'none') : EntityInterface {
        // 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.
        if ($entity instanceof TranslatableInterface && count($entity->getTranslationLanguages()) > 1) {
            $langcode = $this->getEntityTranslationRenderer()
                ->getLangcodeByRelationship($row, $relationship);
            $translation = $this->getEntityRepository()
                ->getTranslationFromContext($entity, $langcode);
        }
        return $translation ?? $entity;
    }
    
    /**
     * Returns the entity type identifier.
     *
     * @return string
     *   The entity type identifier.
     */
    public abstract function getEntityTypeId();
    
    /**
     * 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

Title Sort descending Deprecated Modifiers Object type Summary Overrides
EntityTranslationRenderTrait::$entityTranslationRenderer protected property The renderer to be used to render the entity row.
EntityTranslationRenderTrait::getEntityTranslation Deprecated public function Returns the entity translation matching the configured row language.
EntityTranslationRenderTrait::getEntityTranslationByRelationship 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. 7
EntityTranslationRenderTrait::getLanguageManager abstract protected function Returns the language manager. 7
EntityTranslationRenderTrait::getView abstract protected function Returns the top object of a view. 7

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.