class EntityRow

Same name in other branches
  1. 9 core/modules/views/src/Plugin/views/row/EntityRow.php \Drupal\views\Plugin\views\row\EntityRow
  2. 8.9.x core/modules/views/src/Plugin/views/row/EntityRow.php \Drupal\views\Plugin\views\row\EntityRow
  3. 11.x core/modules/views/src/Plugin/views/row/EntityRow.php \Drupal\views\Plugin\views\row\EntityRow

Generic entity row plugin to provide a common base for all entity types.

Hierarchy

Expanded class hierarchy of EntityRow

2 files declare their use of EntityRow
NodeRow.php in core/modules/node/src/Plugin/views/row/NodeRow.php
UserRow.php in core/modules/user/src/Plugin/views/row/UserRow.php

File

core/modules/views/src/Plugin/views/row/EntityRow.php, line 20

Namespace

Drupal\views\Plugin\views\row
View source
class EntityRow extends RowPluginBase {
    use EntityTranslationRenderTrait;
    
    /**
     * The table the entity is using for storage.
     *
     * @var string
     */
    // phpcs:ignore Drupal.NamingConventions.ValidVariableName.LowerCamelName
    public $base_table;
    
    /**
     * 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 type manager.
     *
     * @var \Drupal\Core\Entity\EntityTypeManagerInterface
     */
    protected $entityTypeManager;
    
    /**
     * The entity repository service.
     *
     * @var \Drupal\Core\Entity\EntityRepositoryInterface
     */
    protected $entityRepository;
    
    /**
     * The entity display repository.
     *
     * @var \Drupal\Core\Entity\EntityDisplayRepositoryInterface
     */
    protected $entityDisplayRepository;
    
    /**
     * The language manager.
     *
     * @var \Drupal\Core\Language\LanguageManagerInterface
     */
    protected $languageManager;
    
    /**
     * Constructs a new EntityRow 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 array $plugin_definition
     *   The plugin implementation definition.
     * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
     *   The entity type manager.
     * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
     *   The language manager.
     * @param \Drupal\Core\Entity\EntityRepositoryInterface $entity_repository
     *   The entity repository.
     * @param \Drupal\Core\Entity\EntityDisplayRepositoryInterface $entity_display_repository
     *   The entity display repository.
     */
    public function __construct(array $configuration, $plugin_id, array $plugin_definition, EntityTypeManagerInterface $entity_type_manager, LanguageManagerInterface $language_manager, ?EntityRepositoryInterface $entity_repository = NULL, ?EntityDisplayRepositoryInterface $entity_display_repository = NULL) {
        parent::__construct($configuration, $plugin_id, $plugin_definition);
        $this->entityTypeManager = $entity_type_manager;
        $this->languageManager = $language_manager;
        $this->entityRepository = $entity_repository;
        $this->entityDisplayRepository = $entity_display_repository;
    }
    
    /**
     * {@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->entityTypeManager
            ->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_type.manager'), $container->get('language_manager'), $container->get('entity.repository'), $container->get('entity_display.repository'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function getEntityTypeId() {
        return $this->entityType
            ->id();
    }
    
    /**
     * {@inheritdoc}
     */
    protected function getEntityTypeManager() {
        return $this->entityTypeManager;
    }
    
    /**
     * {@inheritdoc}
     */
    protected function getEntityRepository() {
        return $this->entityRepository;
    }
    
    /**
     * {@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' => $this->entityDisplayRepository
                ->getViewModeOptions($this->entityTypeId),
            '#title' => $this->t('View mode'),
            '#default_value' => $this->options['view_mode'],
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public function summaryTitle() {
        $options = $this->entityDisplayRepository
            ->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();
        $relationship_table = NULL;
        if (isset($this->options['relationship'], $this->view->relationship[$this->options['relationship']])) {
            $relationship_table = $this->view->relationship[$this->options['relationship']]->alias;
        }
        $this->getEntityTranslationRenderer()
            ->query($this->view
            ->getQuery(), $relationship_table);
    }
    
    /**
     * {@inheritdoc}
     */
    public function preRender($result) {
        parent::preRender($result);
        if ($result) {
            $this->getEntityTranslationRenderer()
                ->preRenderByRelationship($result, $this->options['relationship'] ?? 'none');
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function render($row) {
        return $this->getEntityTranslationRenderer()
            ->renderByRelationship($row, $this->options['relationship'] ?? 'none');
    }
    
    /**
     * {@inheritdoc}
     */
    public function calculateDependencies() {
        $dependencies = parent::calculateDependencies();
        $view_mode = $this->entityTypeManager
            ->getStorage('entity_view_mode')
            ->load($this->entityTypeId . '.' . $this->options['view_mode']);
        if ($view_mode) {
            $dependencies[$view_mode->getConfigDependencyKey()][] = $view_mode->getConfigDependencyName();
        }
        return $dependencies;
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
DerivativeInspectionInterface::getBaseId public function Gets the base_plugin_id of the plugin instance. 1
DerivativeInspectionInterface::getDerivativeId public function Gets the derivative_id of the plugin instance. 1
EntityRow::$base_table public property
EntityRow::$entityDisplayRepository protected property The entity display repository.
EntityRow::$entityRepository protected property The entity repository service.
EntityRow::$entityType protected property Contains the entity type of this row plugin instance.
EntityRow::$entityTypeId protected property Stores the entity type ID of the result entities.
EntityRow::$entityTypeManager protected property The entity type manager.
EntityRow::$languageManager protected property The language manager.
EntityRow::buildOptionsForm public function Provide a form for setting options. Overrides RowPluginBase::buildOptionsForm
EntityRow::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides PluginBase::calculateDependencies
EntityRow::create public static function Creates an instance of the plugin. Overrides PluginBase::create
EntityRow::defineOptions protected function Information about options for all kinds of purposes will be held here. Overrides RowPluginBase::defineOptions 2
EntityRow::getEntityRepository protected function
EntityRow::getEntityTypeId public function Returns the entity type identifier. Overrides EntityTranslationRenderTrait::getEntityTypeId
EntityRow::getEntityTypeManager protected function
EntityRow::getLanguageManager protected function Returns the language manager. Overrides EntityTranslationRenderTrait::getLanguageManager
EntityRow::getView protected function Returns the top object of a view. Overrides EntityTranslationRenderTrait::getView
EntityRow::init public function Initialize the plugin. Overrides PluginBase::init
EntityRow::preRender public function Allow the style to do stuff before each row is rendered. Overrides RowPluginBase::preRender
EntityRow::query public function Add anything to the query that we might need to. Overrides RowPluginBase::query
EntityRow::render public function Renders a row object. Overrides RowPluginBase::render
EntityRow::summaryTitle public function Returns the summary of the settings in the display. Overrides PluginBase::summaryTitle
EntityRow::__construct public function Constructs a new EntityRow object. Overrides PluginBase::__construct
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.
PluginBase::$definition public property Plugins' definition.
PluginBase::$displayHandler public property The display object this plugin is for.
PluginBase::$options public property Options for this plugin will be held here.
PluginBase::$position public property The handler position.
PluginBase::$renderer protected property Stores the render API renderer. 3
PluginBase::$view public property The top object of a view. 1
PluginBase::destroy public function Clears a plugin. Overrides ViewsPluginInterface::destroy 2
PluginBase::doFilterByDefinedOptions protected function Do the work to filter out stored options depending on the defined options.
PluginBase::filterByDefinedOptions public function Filter out stored options depending on the defined options. Overrides ViewsPluginInterface::filterByDefinedOptions
PluginBase::getAvailableGlobalTokens public function Returns an array of available token replacements. Overrides ViewsPluginInterface::getAvailableGlobalTokens
PluginBase::getProvider public function Returns the plugin provider. Overrides ViewsPluginInterface::getProvider
PluginBase::getRenderer protected function Returns the render API renderer. 1
PluginBase::globalTokenForm public function Adds elements for available core tokens to a form. Overrides ViewsPluginInterface::globalTokenForm
PluginBase::globalTokenReplace public function Returns a string with any core tokens replaced. Overrides ViewsPluginInterface::globalTokenReplace
PluginBase::INCLUDE_ENTITY constant Include entity row languages when listing languages.
PluginBase::INCLUDE_NEGOTIATED constant Include negotiated languages when listing languages.
PluginBase::listLanguages protected function Makes an array of languages, optionally including special languages.
PluginBase::pluginTitle public function Return the human readable name of the display. Overrides ViewsPluginInterface::pluginTitle
PluginBase::preRenderAddFieldsetMarkup public static function Moves form elements into fieldsets for presentation purposes. Overrides ViewsPluginInterface::preRenderAddFieldsetMarkup
PluginBase::preRenderFlattenData public static function Flattens the structure of form elements. Overrides ViewsPluginInterface::preRenderFlattenData
PluginBase::queryLanguageSubstitutions public static function Returns substitutions for Views queries for languages.
PluginBase::setOptionDefaults protected function Fills up the options of the plugin with defaults.
PluginBase::themeFunctions public function Provide a full list of possible theme templates used by this style. Overrides ViewsPluginInterface::themeFunctions 1
PluginBase::trustedCallbacks public static function Lists the trusted callbacks provided by the implementing class. Overrides TrustedCallbackInterface::trustedCallbacks 6
PluginBase::unpackOptions public function Unpacks options over our existing defaults. Overrides ViewsPluginInterface::unpackOptions
PluginBase::usesOptions public function Returns the usesOptions property. Overrides ViewsPluginInterface::usesOptions 8
PluginBase::validate public function Validate that the plugin is correct and can be saved. Overrides ViewsPluginInterface::validate 6
PluginBase::viewsTokenReplace protected function Replaces Views' tokens in a given string. 1
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT constant Query string to indicate the site default language.
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin ID of the plugin instance. 2
RowPluginBase::$base_field public property 2
RowPluginBase::$field_alias public property 1
RowPluginBase::$usesFields protected property Does the row plugin support to add fields to its output. 4
RowPluginBase::$usesOptions protected property Denotes whether the plugin has an additional options form. Overrides PluginBase::$usesOptions 1
RowPluginBase::submitOptionsForm public function Perform any necessary changes to the form values prior to storage. Overrides PluginBase::submitOptionsForm 1
RowPluginBase::usesFields public function Returns the usesFields property. 4
RowPluginBase::validateOptionsForm public function Validate the options form. Overrides PluginBase::validateOptionsForm 1
TrustedCallbackInterface::THROW_EXCEPTION constant Untrusted callbacks throw exceptions.
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION constant Untrusted callbacks trigger silenced E_USER_DEPRECATION errors.
TrustedCallbackInterface::TRIGGER_WARNING Deprecated constant Untrusted callbacks trigger E_USER_WARNING errors.

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