class EntityRow

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

Plugin annotation


@Plugin(
  id = "entity",
  derivative = "Drupal\views\Plugin\Derivative\ViewsEntityRow"
)

Hierarchy

Expanded class hierarchy of EntityRow

3 files declare their use of EntityRow
CommentRow.php in drupal/core/modules/comment/lib/Drupal/comment/Plugin/views/row/CommentRow.php
Contains \Drupal\comment\Plugin\views\row\CommentRow.
NodeRow.php in drupal/core/modules/node/lib/Drupal/node/Plugin/views/row/NodeRow.php
Contains \Drupal\node\Plugin\views\row\NodeRow.
UserRow.php in drupal/core/modules/user/lib/Drupal/user/Plugin/views/row/UserRow.php
Contains \Drupal\user\Plugin\views\row\UserRow.

File

drupal/core/modules/views/lib/Drupal/views/Plugin/views/row/EntityRow.php, line 24
Contains \Drupal\views\Plugin\views\row\EntityRow.

Namespace

Drupal\views\Plugin\views\row
View source
class EntityRow extends RowPluginBase {

  /**
   * 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 of the result entities.
   *
   * @var string
   */
  protected $entityType;

  /**
   * Contains the entity info of the entity type of this row plugin instance.
   *
   * @see entity_get_info
   */
  protected $entityInfo;

  /**
   * Contains an array of render arrays, one for each rendered entity.
   *
   * @var array
   */
  protected $build = array();

  /**
   * {@inheritdoc}
   *
   * @param \Drupal\Core\Entity\EntityManager $entity_manager
   *   The entity manager.
   */
  public function __construct(array $configuration, $plugin_id, array $plugin_definition, EntityManager $entity_manager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->entityManager = $entity_manager;
  }

  /**
   * {@inheritdoc}
   */
  public function init(ViewExecutable $view, DisplayPluginBase $display, array &$options = NULL) {
    parent::init($view, $display, $options);
    $this->entityType = $this->definition['entity_type'];
    $this->entityInfo = $this->entityManager
      ->getDefinition($this->entityType);
    $this->base_table = $this->entityInfo['base_table'];
    $this->base_field = $this->entityInfo['entity_keys']['id'];
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, array $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('plugin.manager.entity'));
  }

  /**
   * Overrides Drupal\views\Plugin\views\row\RowPluginBase::defineOptions().
   */
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['view_mode'] = array(
      'default' => '',
    );
    return $options;
  }

  /**
   * Overrides Drupal\views\Plugin\views\row\RowPluginBase::buildOptionsForm().
   */
  public function buildOptionsForm(&$form, &$form_state) {
    parent::buildOptionsForm($form, $form_state);
    $options = $this
      ->buildViewModeOptions();
    $form['view_mode'] = array(
      '#type' => 'select',
      '#options' => $options,
      '#title' => t('View mode'),
      '#default_value' => $this->options['view_mode'],
    );
  }

  /**
   * Return the main options, which are shown in the summary title.
   */
  protected function buildViewModeOptions() {
    $options = array();
    $view_modes = entity_get_view_modes($this->entityType);
    foreach ($view_modes as $mode => $settings) {
      $options[$mode] = $settings['label'];
    }
    return $options;
  }

  /**
   * Overrides Drupal\views\Plugin\views\PluginBase::summaryTitle().
   */
  public function summaryTitle() {
    $options = $this
      ->buildViewModeOptions();
    if (isset($options[$this->options['view_mode']])) {
      return check_plain($options[$this->options['view_mode']]);
    }
    else {
      return t('No view mode selected');
    }
  }

  /**
   * Overrides Drupal\views\Plugin\views\row\RowPluginBase::pre_render().
   */
  public function pre_render($result) {
    parent::pre_render($result);
    if ($result) {

      // Get all entities which will be used to render in rows.
      $entities = array();
      foreach ($result as $row) {
        $entity = $row->_entity;
        $entity->view = $this->view;
        $entities[$entity
          ->id()] = $entity;
      }

      // Prepare the render arrays for all rows.
      $this->build = entity_view_multiple($entities, $this->options['view_mode']);
    }
  }

  /**
   * Overrides Drupal\views\Plugin\views\row\RowPluginBase::render().
   */
  function render($row) {
    $entity_id = $row->{$this->field_alias};
    return $this->build[$entity_id];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
EntityRow::$base_field public property The actual field which is used for the entity id.
EntityRow::$base_table public property The table the entity is using for storage.
EntityRow::$build protected property Contains an array of render arrays, one for each rendered entity.
EntityRow::$entityInfo protected property Contains the entity info of the entity type of this row plugin instance.
EntityRow::$entityType protected property Stores the entity type of the result entities.
EntityRow::buildOptionsForm public function Overrides Drupal\views\Plugin\views\row\RowPluginBase::buildOptionsForm(). Overrides RowPluginBase::buildOptionsForm 2
EntityRow::buildViewModeOptions protected function Return the main options, which are shown in the summary title.
EntityRow::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginBase::create
EntityRow::defineOptions protected function Overrides Drupal\views\Plugin\views\row\RowPluginBase::defineOptions(). Overrides RowPluginBase::defineOptions 3
EntityRow::init public function Initialize the plugin. Overrides PluginBase::init
EntityRow::pre_render public function Overrides Drupal\views\Plugin\views\row\RowPluginBase::pre_render(). Overrides RowPluginBase::pre_render
EntityRow::render function Overrides Drupal\views\Plugin\views\row\RowPluginBase::render(). Overrides RowPluginBase::render 1
EntityRow::summaryTitle public function Overrides Drupal\views\Plugin\views\PluginBase::summaryTitle(). Overrides PluginBase::summaryTitle
EntityRow::__construct public function Overrides PluginBase::__construct
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$definition public property Plugins's 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::$pluginDefinition protected property The plugin implementation definition.
PluginBase::$pluginId protected property The plugin_id.
PluginBase::$view public property The top object of a view. 1
PluginBase::destroy public function Clears a plugin. 2
PluginBase::getAvailableGlobalTokens public function Returns an array of available token replacements.
PluginBase::getPluginDefinition public function Returns the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition
PluginBase::getPluginId public function Returns the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::globalTokenForm public function Adds elements for available core tokens to a form.
PluginBase::globalTokenReplace public function Returns a string with any core tokens replaced.
PluginBase::pluginTitle public function Return the human readable name of the display.
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. 1
PluginBase::unpackOptions public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
PluginBase::usesOptions public function Returns the usesOptions property. 8
PluginBase::validate public function Validate that the plugin is correct and can be saved. 4
RowPluginBase::$usesFields protected property Does the row plugin support to add fields to it's output. 3
RowPluginBase::$usesOptions protected property Overrides Drupal\views\Plugin\Plugin::$usesOptions. Overrides PluginBase::$usesOptions 1
RowPluginBase::query public function Add anything to the query that we might need to. Overrides PluginBase::query
RowPluginBase::submitOptionsForm public function Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. Overrides PluginBase::submitOptionsForm 1
RowPluginBase::usesFields function Returns the usesFields property. 3
RowPluginBase::validateOptionsForm public function Validate the options form. Overrides PluginBase::validateOptionsForm 1