class EntityReference

Same name in this branch
  1. 8.x drupal/core/modules/entity_reference/lib/Drupal/entity_reference/Plugin/views/row/EntityReference.php \Drupal\entity_reference\Plugin\views\row\EntityReference
  2. 8.x drupal/core/modules/entity_reference/lib/Drupal/entity_reference/Plugin/views/display/EntityReference.php \Drupal\entity_reference\Plugin\views\display\EntityReference
  3. 8.x drupal/core/modules/entity_reference/lib/Drupal/entity_reference/Plugin/views/style/EntityReference.php \Drupal\entity_reference\Plugin\views\style\EntityReference

EntityReference row plugin.

Plugin annotation


@Plugin(
  id = "entity_reference",
  title = @Translation("Entity Reference inline fields"),
  help = @Translation("Displays the fields with an optional template."),
  theme = "views_view_fields",
  display_types = {"entity_reference"}
)

Hierarchy

Expanded class hierarchy of EntityReference

Related topics

Views row plugins
Row plugins control how Views outputs an individual record.
1 string reference to 'EntityReference'
views.view.test_entity_reference.yml in drupal/core/modules/entity_reference/tests/modules/entity_reference_test/config/views.view.test_entity_reference.yml
drupal/core/modules/entity_reference/tests/modules/entity_reference_test/config/views.view.test_entity_reference.yml

File

drupal/core/modules/entity_reference/lib/Drupal/entity_reference/Plugin/views/row/EntityReference.php, line 27
Contains \Drupal\entity_reference\Plugin\views\row\EntityReference.

Namespace

Drupal\entity_reference\Plugin\views\row
View source
class EntityReference extends Fields {

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

  /**
   * Overrides \Drupal\views\Plugin\views\row\Fields::buildOptionsForm().
   */
  public function buildOptionsForm(&$form, &$form_state) {
    parent::buildOptionsForm($form, $form_state);

    // Expand the description of the 'Inline field' checkboxes.
    $form['inline']['#description'] .= '<br />' . t("<strong>Note:</strong> In 'Entity Reference' displays, all fields will be displayed inline unless an explicit selection of inline fields is made here.");
  }

  /**
   * Overrides \Drupal\views\Plugin\views\row\Fields::pre_render().
   */
  public function pre_render($row) {

    // Force all fields to be inline by default.
    if (empty($this->options['inline'])) {
      $fields = $this->view
        ->getItems('field', $this->displayHandler->display['id']);
      $this->options['inline'] = drupal_map_assoc(array_keys($fields));
    }
    return parent::pre_render($row);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ContainerFactoryPluginBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 11
EntityReference::buildOptionsForm public function Overrides \Drupal\views\Plugin\views\row\Fields::buildOptionsForm(). Overrides Fields::buildOptionsForm
EntityReference::defineOptions protected function Overrides \Drupal\views\Plugin\views\row\Fields::defineOptions(). Overrides Fields::defineOptions
EntityReference::pre_render public function Overrides \Drupal\views\Plugin\views\row\Fields::pre_render(). Overrides RowPluginBase::pre_render
Fields::$usesFields protected property Does the row plugin support to add fields to it's output. Overrides RowPluginBase::$usesFields
Fields::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 RowPluginBase::submitOptionsForm
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::init public function Initialize the plugin. 8
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::summaryTitle public function Returns the summary of the settings in the display. 6
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
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::render function Render a row object. This usually passes through to a theme template of some form, but not always. 8
RowPluginBase::usesFields function Returns the usesFields property. 3
RowPluginBase::validateOptionsForm public function Validate the options form. Overrides PluginBase::validateOptionsForm 1