class EntityReference

Same name in this branch
  1. 9 core/modules/field/src/Plugin/migrate/field/d7/EntityReference.php \Drupal\field\Plugin\migrate\field\d7\EntityReference
  2. 9 core/modules/views/src/Plugin/views/display/EntityReference.php \Drupal\views\Plugin\views\display\EntityReference
  3. 9 core/modules/views/src/Plugin/views/style/EntityReference.php \Drupal\views\Plugin\views\style\EntityReference
  4. 9 core/lib/Drupal/Core/Entity/Plugin/DataType/EntityReference.php \Drupal\Core\Entity\Plugin\DataType\EntityReference
Same name and namespace in other branches
  1. 8.9.x core/modules/entity_reference/src/Plugin/views/row/EntityReference.php \Drupal\entity_reference\Plugin\views\row\EntityReference
  2. 8.9.x core/modules/entity_reference/src/Plugin/views/display/EntityReference.php \Drupal\entity_reference\Plugin\views\display\EntityReference
  3. 8.9.x core/modules/entity_reference/src/Plugin/views/style/EntityReference.php \Drupal\entity_reference\Plugin\views\style\EntityReference
  4. 8.9.x core/lib/Drupal/Core/Field/Plugin/migrate/field/d7/EntityReference.php \Drupal\Core\Field\Plugin\migrate\field\d7\EntityReference
  5. 11.x core/modules/field/src/Plugin/migrate/field/d7/EntityReference.php \Drupal\field\Plugin\migrate\field\d7\EntityReference
  6. 11.x core/modules/views/src/Plugin/views/row/EntityReference.php \Drupal\views\Plugin\views\row\EntityReference
  7. 11.x core/modules/views/src/Plugin/views/display/EntityReference.php \Drupal\views\Plugin\views\display\EntityReference
  8. 11.x core/modules/views/src/Plugin/views/filter/EntityReference.php \Drupal\views\Plugin\views\filter\EntityReference
  9. 11.x core/modules/views/src/Plugin/views/style/EntityReference.php \Drupal\views\Plugin\views\style\EntityReference
  10. 11.x core/lib/Drupal/Core/Entity/Plugin/DataType/EntityReference.php \Drupal\Core\Entity\Plugin\DataType\EntityReference
  11. 10 core/modules/field/src/Plugin/migrate/field/d7/EntityReference.php \Drupal\field\Plugin\migrate\field\d7\EntityReference
  12. 10 core/modules/views/src/Plugin/views/row/EntityReference.php \Drupal\views\Plugin\views\row\EntityReference
  13. 10 core/modules/views/src/Plugin/views/display/EntityReference.php \Drupal\views\Plugin\views\display\EntityReference
  14. 10 core/modules/views/src/Plugin/views/style/EntityReference.php \Drupal\views\Plugin\views\style\EntityReference
  15. 10 core/lib/Drupal/Core/Entity/Plugin/DataType/EntityReference.php \Drupal\Core\Entity\Plugin\DataType\EntityReference
  16. 8.9.x core/modules/field/src/Plugin/migrate/field/d7/EntityReference.php \Drupal\field\Plugin\migrate\field\d7\EntityReference
  17. 8.9.x core/modules/views/src/Plugin/views/row/EntityReference.php \Drupal\views\Plugin\views\row\EntityReference
  18. 8.9.x core/modules/views/src/Plugin/views/display/EntityReference.php \Drupal\views\Plugin\views\display\EntityReference
  19. 8.9.x core/modules/views/src/Plugin/views/style/EntityReference.php \Drupal\views\Plugin\views\style\EntityReference
  20. 8.9.x core/lib/Drupal/Core/Entity/Plugin/DataType/EntityReference.php \Drupal\Core\Entity\Plugin\DataType\EntityReference

EntityReference row plugin.

Plugin annotation


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

Hierarchy

Expanded class hierarchy of EntityReference

Related topics

4 string references to 'EntityReference'
FieldInstanceSettings::transform in core/modules/field/src/Plugin/migrate/process/d7/FieldInstanceSettings.php
MigrationProvidersExistTest::testFieldProvidersExist in core/modules/migrate/tests/src/Kernel/Plugin/MigrationProvidersExistTest.php
Tests that modules exist for all field plugins.
views.view.test_entity_reference.yml in core/modules/system/tests/modules/entity_reference_test/config/install/views.view.test_entity_reference.yml
core/modules/system/tests/modules/entity_reference_test/config/install/views.view.test_entity_reference.yml
views.view.test_entity_reference_entity_test.yml in core/modules/system/tests/modules/entity_reference_test/config/install/views.view.test_entity_reference_entity_test.yml
core/modules/system/tests/modules/entity_reference_test/config/install/views.view.test_entity_reference_entity_test.yml

File

core/modules/views/src/Plugin/views/row/EntityReference.php, line 21

Namespace

Drupal\views\Plugin\views\row
View source
class EntityReference extends Fields {
  
  /**
   * {@inheritdoc}
   */
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['separator'] = [
      'default' => '-',
    ];
    return $options;
  }
  
  /**
   * {@inheritdoc}
   */
  public function buildOptionsForm(&$form, FormStateInterface $form_state) {
    parent::buildOptionsForm($form, $form_state);
    // Expand the description of the 'Inline field' checkboxes.
    $form['inline']['#description'] .= '<br />' . $this->t("<strong>Note:</strong> In 'Entity Reference' displays, all fields will be displayed inline unless an explicit selection of inline fields is made here.");
  }
  
  /**
   * {@inheritdoc}
   */
  public function preRender($row) {
    // Force all fields to be inline by default.
    if (empty($this->options['inline'])) {
      $fields = $this->view
        ->getHandlers('field', $this->displayHandler->display['id']);
      $names = array_keys($fields);
      $this->options['inline'] = array_combine($names, $names);
    }
    return parent::preRender($row);
  }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function
DependencySerializationTrait::__wakeup public function #[\ReturnTypeWillChange]
EntityReference::buildOptionsForm public function Provide a form for setting options. Overrides Fields::buildOptionsForm
EntityReference::defineOptions protected function Information about options for all kinds of purposes will be held here. Overrides Fields::defineOptions
EntityReference::preRender public function Allow the style to do stuff before each row is rendered. Overrides RowPluginBase::preRender
Fields::$usesFields protected property Does the row plugin support to add fields to its output.
Fields::submitOptionsForm public function Perform any necessary changes to the form values prior to storage.
MessengerTrait::$messenger protected property The messenger.
MessengerTrait::messenger public function Gets the messenger.
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$definition public property Plugins&#039; 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::$renderer protected property Stores the render API renderer.
PluginBase::$view public property The top object of a view.
PluginBase::calculateDependencies public function 2
PluginBase::calculateDependencies public function 2
PluginBase::calculateDependencies public function 2
PluginBase::create public static function 4
PluginBase::create public static function 4
PluginBase::create public static function 4
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::destroy public function
PluginBase::doFilterByDefinedOptions protected function Do the work to filter out stored options depending on the defined options.
PluginBase::filterByDefinedOptions public function
PluginBase::getAvailableGlobalTokens public function
PluginBase::getBaseId public function
PluginBase::getDerivativeId public function
PluginBase::getPluginDefinition public function
PluginBase::getPluginId public function
PluginBase::getProvider public function
PluginBase::getRenderer protected function Returns the render API renderer.
PluginBase::globalTokenForm public function
PluginBase::globalTokenReplace public function
PluginBase::INCLUDE_ENTITY constant Include entity row languages when listing languages.
PluginBase::INCLUDE_NEGOTIATED constant Include negotiated languages when listing languages.
PluginBase::init public function
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginBase::listLanguages protected function Makes an array of languages, optionally including special languages.
PluginBase::pluginTitle public function
PluginBase::preRenderAddFieldsetMarkup public static function
PluginBase::preRenderFlattenData public static function
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::summaryTitle public function
PluginBase::themeFunctions public function
PluginBase::trustedCallbacks public static function
PluginBase::unpackOptions public function
PluginBase::usesOptions public function 1
PluginBase::usesOptions public function 1
PluginBase::usesOptions public function 1
PluginBase::validate public function
PluginBase::viewsTokenReplace protected function Replaces Views&#039; tokens in a given string.
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT constant Query string to indicate the site default language.
PluginBase::__construct public function Constructs a PluginBase object. 1
PluginBase::__construct public function Constructs a PluginBase object. 1
PluginBase::__construct public function Constructs a PluginBase object. 1
RowPluginBase::$usesOptions protected property
RowPluginBase::query public function
RowPluginBase::render public function Renders a row object. 1
RowPluginBase::render public function Renders a row object. 1
RowPluginBase::render public function Renders a row object. 1
RowPluginBase::usesFields public function Returns the usesFields property.
RowPluginBase::validateOptionsForm public function Validate the options form.
StringTranslationTrait::$stringTranslation protected property The string translation service.
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use.
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
TrustedCallbackInterface::THROW_EXCEPTION constant Untrusted callbacks throw exceptions.
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION constant Untrusted callbacks trigger silenced E_USER_DEPRECATION errors.
TrustedCallbackInterface::TRIGGER_WARNING 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.