You are here

Home » API reference » Views (for Drupal 7) 8.3 » Entity.php

class Entity in Views (for Drupal 7) 8.3

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

Hierarchy

Expanded class hierarchy of Entity

3 files declare their use of Entity
View.php in lib/Views/node/Plugin/views/row/View.php
Definition of Views\node\Plugin\views\row\View.
View.php in lib/Views/user/Plugin/views/row/View.php
Definition of Views\user\Plugin\views\row\View
View.php in lib/Views/comment/Plugin/views/row/View.php
Definition of Views\comment\Plugin\views\row\View.

File

lib/Views/system/Plugin/views/row/Entity.php, line 16
Definition of Views\system\Plugin\views\row\Entity.

Namespace

Views\system\Plugin\views\row
View source 
class Entity extends RowPluginBase {
  protected $entityInfo1;

  /**
   * 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();

  /**
   * Overrides Drupal\views\Plugin\views\row\RowPluginBase::init().
   */
  public function init(ViewExecutable $view, &$display, $options = NULL) {
    parent::init($view, $display, $options);
    $this->entityType = $this->definition['entity_type'];
    $this->entityInfo = entity_get_info($this->entityType);
    $this->base_table = $this->entityInfo['base table'];
    $this->base_field = $this->entityInfo['entity keys']['id'];
  }

  /**
   * 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();
    if (!empty($this->entityInfo['view modes'])) {
      foreach ($this->entityInfo['view modes'] as $mode => $settings) {
        $options[$mode] = $settings['label'];
      }
    }
    return $options;
  }

  /**
   * Overrides Drupal\views\Plugin\views\PluginBase::summaryTitle().
   */
  public function summaryTitle() {
    $options = $this
      ->buildViewModeOptions();
    return check_plain($options[$this->options['view_mode']]);
  }

  /**
   * 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 drupal_render($this->build[$entity_id]);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
Entity::$base_field public property The actual field which is used for the entity id.
Entity::$base_table public property The table the entity is using for storage.
Entity::$build protected property Contains an array of render arrays, one for each rendered entity.
Entity::$entityInfo protected property Contains the entity info of the entity type of this row plugin instance.
Entity::$entityInfo1 protected property
Entity::$entityType protected property Stores the entity type of the result entities.
Entity::buildOptionsForm public function Overrides Drupal\views\Plugin\views\row\RowPluginBase::buildOptionsForm(). Overrides RowPluginBase::buildOptionsForm 2
Entity::buildViewModeOptions protected function Return the main options, which are shown in the summary title.
Entity::defineOptions protected function Overrides Drupal\views\Plugin\views\row\RowPluginBase::defineOptions(). Overrides RowPluginBase::defineOptions 3
Entity::init public function Overrides Drupal\views\Plugin\views\row\RowPluginBase::init(). Overrides RowPluginBase::init
Entity::pre_render public function Overrides Drupal\views\Plugin\views\row\RowPluginBase::pre_render(). Overrides RowPluginBase::pre_render
Entity::render function Overrides Drupal\views\Plugin\views\row\RowPluginBase::render(). Overrides RowPluginBase::render 1
Entity::summaryTitle public function Overrides Drupal\views\Plugin\views\PluginBase::summaryTitle(). Overrides PluginBase::summaryTitle
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. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::$view public property The top object of a view. 1
PluginBase::additionalThemeFunctions public function Provide a list of additional theme functions for the theme information page
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::destroy public function Clears a plugin. 2
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginBase::pluginTitle public function Return the human readable name of the display.
PluginBase::setOptionDefaults protected function
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
PluginBase::__construct public function Constructs a Plugin object. Overrides PluginBase::__construct 2
RowPluginBase::$usesFields protected property Does the row plugin support to add fields to it's output. 2
RowPluginBase::$usesOptions protected property Overrides Drupal\views\Plugin\Plugin::$usesOptions. Overrides PluginBase::$usesOptions
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. 2
RowPluginBase::validateOptionsForm public function Validate the options form. Overrides PluginBase::validateOptionsForm