1. 8.5.x core/modules/views/src/Plugin/views/display/EntityReference.php EntityReference
  2. 8.5.x core/modules/entity_reference/src/Plugin/views/style/EntityReference.php EntityReference
  3. 8.5.x core/modules/views/src/Plugin/views/row/EntityReference.php EntityReference
  4. 8.5.x core/modules/views/src/Plugin/views/style/EntityReference.php EntityReference
  5. 8.5.x core/lib/Drupal/Core/Field/Plugin/migrate/field/d7/EntityReference.php EntityReference
  6. 8.5.x core/lib/Drupal/Core/Entity/Plugin/DataType/EntityReference.php EntityReference
  7. 8.5.x core/modules/entity_reference/src/Plugin/views/display/EntityReference.php EntityReference
  8. 8.5.x core/modules/entity_reference/src/Plugin/views/row/EntityReference.php EntityReference
  9. 8.0.x core/modules/entity_reference/src/Plugin/views/row/EntityReference.php EntityReference
  10. 8.0.x core/modules/entity_reference/src/Plugin/views/display/EntityReference.php EntityReference
  11. 8.0.x core/modules/entity_reference/src/Plugin/views/style/EntityReference.php EntityReference
  12. 8.0.x core/modules/views/src/Plugin/views/display/EntityReference.php EntityReference
  13. 8.0.x core/modules/views/src/Plugin/views/style/EntityReference.php EntityReference
  14. 8.0.x core/lib/Drupal/Core/Entity/Plugin/DataType/EntityReference.php EntityReference
  15. 8.0.x core/modules/views/src/Plugin/views/row/EntityReference.php EntityReference
  16. 8.1.x core/modules/views/src/Plugin/views/style/EntityReference.php EntityReference
  17. 8.1.x core/lib/Drupal/Core/Entity/Plugin/DataType/EntityReference.php EntityReference
  18. 8.1.x core/modules/views/src/Plugin/views/display/EntityReference.php EntityReference
  19. 8.1.x core/modules/entity_reference/src/Plugin/views/row/EntityReference.php EntityReference
  20. 8.1.x core/modules/views/src/Plugin/views/row/EntityReference.php EntityReference
  21. 8.1.x core/modules/entity_reference/src/Plugin/views/display/EntityReference.php EntityReference
  22. 8.1.x core/modules/entity_reference/src/Plugin/views/style/EntityReference.php EntityReference
  23. 8.2.x core/modules/entity_reference/src/Plugin/views/display/EntityReference.php EntityReference
  24. 8.2.x core/modules/entity_reference/src/Plugin/views/row/EntityReference.php EntityReference
  25. 8.2.x core/modules/entity_reference/src/Plugin/views/style/EntityReference.php EntityReference
  26. 8.2.x core/modules/views/src/Plugin/views/style/EntityReference.php EntityReference
  27. 8.2.x core/lib/Drupal/Core/Entity/Plugin/DataType/EntityReference.php EntityReference
  28. 8.2.x core/modules/views/src/Plugin/views/display/EntityReference.php EntityReference
  29. 8.2.x core/modules/views/src/Plugin/views/row/EntityReference.php EntityReference
  30. 8.3.x core/modules/views/src/Plugin/views/display/EntityReference.php EntityReference
  31. 8.3.x core/modules/views/src/Plugin/views/row/EntityReference.php EntityReference
  32. 8.3.x core/modules/entity_reference/src/Plugin/views/row/EntityReference.php EntityReference
  33. 8.3.x core/modules/entity_reference/src/Plugin/views/display/EntityReference.php EntityReference
  34. 8.3.x core/lib/Drupal/Core/Entity/Plugin/DataType/EntityReference.php EntityReference
  35. 8.3.x core/modules/views/src/Plugin/views/style/EntityReference.php EntityReference
  36. 8.3.x core/modules/entity_reference/src/Plugin/views/style/EntityReference.php EntityReference
  37. 8.4.x core/modules/views/src/Plugin/views/row/EntityReference.php EntityReference
  38. 8.4.x core/modules/views/src/Plugin/views/display/EntityReference.php EntityReference
  39. 8.4.x core/modules/entity_reference/src/Plugin/views/display/EntityReference.php EntityReference
  40. 8.4.x core/modules/entity_reference/src/Plugin/views/row/EntityReference.php EntityReference
  41. 8.4.x core/modules/entity_reference/src/Plugin/views/style/EntityReference.php EntityReference
  42. 8.4.x core/lib/Drupal/Core/Entity/Plugin/DataType/EntityReference.php EntityReference
  43. 8.4.x core/lib/Drupal/Core/Field/Plugin/migrate/field/d7/EntityReference.php EntityReference
  44. 8.4.x core/modules/views/src/Plugin/views/style/EntityReference.php EntityReference
  45. 8.6.x core/modules/views/src/Plugin/views/row/EntityReference.php EntityReference
  46. 8.6.x core/lib/Drupal/Core/Field/Plugin/migrate/field/d7/EntityReference.php EntityReference
  47. 8.6.x core/modules/views/src/Plugin/views/display/EntityReference.php EntityReference
  48. 8.6.x core/modules/views/src/Plugin/views/style/EntityReference.php EntityReference
  49. 8.6.x core/modules/entity_reference/src/Plugin/views/row/EntityReference.php EntityReference
  50. 8.6.x core/lib/Drupal/Core/Entity/Plugin/DataType/EntityReference.php EntityReference
  51. 8.6.x core/modules/entity_reference/src/Plugin/views/display/EntityReference.php EntityReference
  52. 8.6.x core/modules/entity_reference/src/Plugin/views/style/EntityReference.php EntityReference

EntityReference style plugin.

Plugin annotation


@ViewsStyle(
  id = "entity_reference",
  title = @Translation("Entity Reference list"),
  help = @Translation("Returns results as a PHP array of labels and rendered rows."),
  theme = "views_view_unformatted",
  register_theme = FALSE,
  display_types = {"entity_reference"}
)

Hierarchy

Expanded class hierarchy of EntityReference

Related topics

1 file declares its use of EntityReference
EntityReference.php in core/modules/entity_reference/src/Plugin/views/style/EntityReference.php
2 string references to 'EntityReference'
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/style/EntityReference.php, line 22

Namespace

Drupal\views\Plugin\views\style
View source
class EntityReference extends StylePluginBase {

  /**
   * {@inheritdoc}
   */
  protected $usesRowPlugin = TRUE;

  /**
   * {@inheritdoc}
   */
  protected $usesFields = TRUE;

  /**
   * {@inheritdoc}
   */
  protected $usesGrouping = FALSE;

  /**
   * {@inheritdoc}
   */
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['search_fields'] = array(
      'default' => array(),
    );
    return $options;
  }

  /**
   * {@inheritdoc}
   */
  public function buildOptionsForm(&$form, FormStateInterface $form_state) {
    parent::buildOptionsForm($form, $form_state);
    $options = $this->displayHandler
      ->getFieldLabels(TRUE);
    $form['search_fields'] = array(
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Search fields'),
      '#options' => $options,
      '#required' => TRUE,
      '#default_value' => $this->options['search_fields'],
      '#description' => $this
        ->t('Select the field(s) that will be searched when using the autocomplete widget.'),
      '#weight' => -3,
    );
  }

  /**
   * {@inheritdoc}
   */
  public function render() {
    if (!empty($this->view->live_preview)) {
      return parent::render();
    }

    // Group the rows according to the grouping field, if specified.
    $sets = $this
      ->renderGrouping($this->view->result, $this->options['grouping']);

    // Grab the alias of the 'id' field added by
    // entity_reference_plugin_display.
    $id_field_alias = $this->view->storage
      ->get('base_field');

    // @todo We don't display grouping info for now. Could be useful for select
    // widget, though.
    $results = array();
    foreach ($sets as $records) {
      foreach ($records as $values) {
        $results[$values->{$id_field_alias}] = $this->view->rowPlugin
          ->render($values);

        // Sanitize HTML, remove line breaks and extra whitespace.
        $results[$values->{$id_field_alias}]['#post_render'][] = function ($html, array $elements) {
          return Xss::filterAdmin(preg_replace('/\\s\\s+/', ' ', str_replace("\n", '', $html)));
        };
      }
    }
    return $results;
  }

  /**
   * {@inheritdoc}
   */
  public function evenEmpty() {
    return TRUE;
  }

}

Members

Contains filters are case sensitive
Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function Prevents serializing any properties.
DependencySerializationTrait::__wakeup public function
EntityReference::$usesFields protected property Does the style plugin for itself support to add fields to it's output. Overrides StylePluginBase::$usesFields
EntityReference::$usesGrouping protected property Does the style plugin support grouping of rows. Overrides StylePluginBase::$usesGrouping
EntityReference::$usesRowPlugin protected property Does the style plugin allows to use style plugins. Overrides StylePluginBase::$usesRowPlugin
EntityReference::buildOptionsForm public function Provide a form to edit options for this plugin. Overrides StylePluginBase::buildOptionsForm
EntityReference::defineOptions protected function Information about options for all kinds of purposes will be held here. Overrides StylePluginBase::defineOptions
EntityReference::evenEmpty public function Should the output of the style plugin be rendered even if it's a empty view. Overrides StylePluginBase::evenEmpty
EntityReference::render public function Render the display in this style. Overrides StylePluginBase::render
PluginBase::$configuration protected property Configuration information passed into the plugin.
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::$renderer protected property Stores the render API renderer.
PluginBase::$view public property The top object of a view.
PluginBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
PluginBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
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::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
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::getProvider public function Returns the plugin provider. Overrides ViewsPluginInterface::getProvider
PluginBase::getRenderer protected function Returns the render API renderer.
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::submitOptionsForm public function Handle any special handling on the validate form. Overrides ViewsPluginInterface::submitOptionsForm
PluginBase::summaryTitle public function Returns the summary of the settings in the display. Overrides ViewsPluginInterface::summaryTitle
PluginBase::themeFunctions public function Provide a full list of possible theme templates used by this style. Overrides ViewsPluginInterface::themeFunctions
PluginBase::unpackOptions public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. Overrides ViewsPluginInterface::unpackOptions
PluginBase::usesOptions public function Returns the usesOptions property. Overrides ViewsPluginInterface::usesOptions
PluginBase::viewsTokenReplace protected function Replaces Views' tokens in a given string. The resulting string will be sanitized with Xss::filterAdmin.
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT constant Query string to indicate the site default language.
PluginBase::__construct public function Constructs a PluginBase object. Overrides PluginBase::__construct
StringTranslationTrait::$stringTranslation protected property The string translation service.
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::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.
StylePluginBase::$defaultFieldLabels protected property Should field labels be enabled by default.
StylePluginBase::$groupingTheme protected property The theme function used to render the grouping set.
StylePluginBase::$rendered_fields protected property Stores the rendered field values, keyed by the row index and field name.
StylePluginBase::$rowTokens protected property Store all available tokens row rows.
StylePluginBase::$usesOptions protected property Denotes whether the plugin has an additional options form. Overrides PluginBase::$usesOptions
StylePluginBase::$usesRowClass protected property Does the style plugin support custom css class for the rows.
StylePluginBase::buildSort public function Called by the view builder to see if this style handler wants to interfere with the sorts. If so it should build; if it returns any non-TRUE value, normal sorting will NOT be added to the query.
StylePluginBase::buildSortPost public function Called by the view builder to let the style build a second set of sorts that will come after any other sorts in the view.
StylePluginBase::defaultFieldLabels public function Return TRUE if this style enables field labels by default.
StylePluginBase::destroy public function Clears a plugin. Overrides PluginBase::destroy
StylePluginBase::elementPreRenderRow public function #pre_render callback for view row field rendering.
StylePluginBase::getField public function Gets a rendered field.
StylePluginBase::getFieldValue public function Get the raw field value.
StylePluginBase::getRowClass public function Return the token replaced row class for the specified row.
StylePluginBase::init public function Overrides \Drupal\views\Plugin\views\PluginBase::init(). Overrides PluginBase::init
StylePluginBase::preRender public function Allow the style to do stuff before each row is rendered.
StylePluginBase::query public function Add anything to the query that we might need to. Overrides PluginBase::query
StylePluginBase::renderFields protected function Renders all of the fields for a given style and store them on the object.
StylePluginBase::renderGrouping public function Group records as needed for rendering.
StylePluginBase::renderGroupingSets public function Render the grouping sets.
StylePluginBase::renderRowGroup protected function Renders a group of rows of the grouped view.
StylePluginBase::tokenizeValue public function Take a value and apply token replacement logic to it.
StylePluginBase::usesFields function Return TRUE if this style also uses fields.
StylePluginBase::usesGrouping function Returns the usesGrouping property.
StylePluginBase::usesRowClass function Returns the usesRowClass property.
StylePluginBase::usesRowPlugin function Returns the usesRowPlugin property.
StylePluginBase::usesTokens public function Return TRUE if this style uses tokens.
StylePluginBase::validate public function Validate that the plugin is correct and can be saved. Overrides PluginBase::validate
StylePluginBase::validateOptionsForm public function Validate the options form. Overrides PluginBase::validateOptionsForm
StylePluginBase::wizardForm public function Provide a form in the views wizard if this style is selected.
StylePluginBase::wizardSubmit public function Alter the options of a display before they are added to the view.