class EntityReference
Same name in this branch
- 8.9.x core/modules/field/src/Plugin/migrate/field/d7/EntityReference.php \Drupal\field\Plugin\migrate\field\d7\EntityReference
- 8.9.x core/modules/views/src/Plugin/views/row/EntityReference.php \Drupal\views\Plugin\views\row\EntityReference
- 8.9.x core/modules/views/src/Plugin/views/display/EntityReference.php \Drupal\views\Plugin\views\display\EntityReference
- 8.9.x core/modules/entity_reference/src/Plugin/views/row/EntityReference.php \Drupal\entity_reference\Plugin\views\row\EntityReference
- 8.9.x core/modules/entity_reference/src/Plugin/views/display/EntityReference.php \Drupal\entity_reference\Plugin\views\display\EntityReference
- 8.9.x core/modules/entity_reference/src/Plugin/views/style/EntityReference.php \Drupal\entity_reference\Plugin\views\style\EntityReference
- 8.9.x core/lib/Drupal/Core/Field/Plugin/migrate/field/d7/EntityReference.php \Drupal\Core\Field\Plugin\migrate\field\d7\EntityReference
- 8.9.x core/lib/Drupal/Core/Entity/Plugin/DataType/EntityReference.php \Drupal\Core\Entity\Plugin\DataType\EntityReference
Same name in other branches
- 9 core/modules/field/src/Plugin/migrate/field/d7/EntityReference.php \Drupal\field\Plugin\migrate\field\d7\EntityReference
- 9 core/modules/views/src/Plugin/views/row/EntityReference.php \Drupal\views\Plugin\views\row\EntityReference
- 9 core/modules/views/src/Plugin/views/display/EntityReference.php \Drupal\views\Plugin\views\display\EntityReference
- 9 core/modules/views/src/Plugin/views/style/EntityReference.php \Drupal\views\Plugin\views\style\EntityReference
- 9 core/lib/Drupal/Core/Entity/Plugin/DataType/EntityReference.php \Drupal\Core\Entity\Plugin\DataType\EntityReference
- 10 core/modules/field/src/Plugin/migrate/field/d7/EntityReference.php \Drupal\field\Plugin\migrate\field\d7\EntityReference
- 10 core/modules/views/src/Plugin/views/row/EntityReference.php \Drupal\views\Plugin\views\row\EntityReference
- 10 core/modules/views/src/Plugin/views/display/EntityReference.php \Drupal\views\Plugin\views\display\EntityReference
- 10 core/modules/views/src/Plugin/views/style/EntityReference.php \Drupal\views\Plugin\views\style\EntityReference
- 10 core/lib/Drupal/Core/Entity/Plugin/DataType/EntityReference.php \Drupal\Core\Entity\Plugin\DataType\EntityReference
- 11.x core/modules/field/src/Plugin/migrate/field/d7/EntityReference.php \Drupal\field\Plugin\migrate\field\d7\EntityReference
- 11.x core/modules/views/src/Plugin/views/row/EntityReference.php \Drupal\views\Plugin\views\row\EntityReference
- 11.x core/modules/views/src/Plugin/views/display/EntityReference.php \Drupal\views\Plugin\views\display\EntityReference
- 11.x core/modules/views/src/Plugin/views/style/EntityReference.php \Drupal\views\Plugin\views\style\EntityReference
- 11.x core/lib/Drupal/Core/Entity/Plugin/DataType/EntityReference.php \Drupal\Core\Entity\Plugin\DataType\EntityReference
- 11.x core/modules/views/src/Plugin/views/filter/EntityReference.php \Drupal\views\Plugin\views\filter\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
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
- class \Drupal\views\Plugin\views\PluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\views\Plugin\views\ViewsPluginInterface, \Drupal\Component\Plugin\DependentPluginInterface, \Drupal\Core\Security\TrustedCallbackInterface
- class \Drupal\views\Plugin\views\style\StylePluginBase extends \Drupal\views\Plugin\views\PluginBase
- class \Drupal\views\Plugin\views\style\EntityReference extends \Drupal\views\Plugin\views\style\StylePluginBase
- class \Drupal\views\Plugin\views\style\StylePluginBase extends \Drupal\views\Plugin\views\PluginBase
- class \Drupal\views\Plugin\views\PluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\views\Plugin\views\ViewsPluginInterface, \Drupal\Component\Plugin\DependentPluginInterface, \Drupal\Core\Security\TrustedCallbackInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
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
7 string references to 'EntityReference'
- FieldInstanceSettings::transform in core/
modules/ field/ src/ Plugin/ migrate/ process/ d7/ FieldInstanceSettings.php - Performs the associated process.
- MigrateFieldDeprecationTest::testDeprecatedEntityReference in core/
tests/ Drupal/ Tests/ Core/ Field/ MigrateFieldDeprecationTest.php - Tests trigger_error when an EntityReference object is created.
- MigrationProvidersExistTest::testFieldProvidersExist in core/
modules/ migrate/ tests/ src/ Kernel/ Plugin/ MigrationProvidersExistTest.php - Tests that modules exist for all field plugins.
- MultilingualReviewPageTest::getAvailablePaths in core/
modules/ migrate_drupal_ui/ tests/ src/ Functional/ d7/ MultilingualReviewPageTest.php - Gets the available upgrade paths.
- Upgrade7Test::getAvailablePaths in core/
modules/ migrate_drupal_ui/ tests/ src/ Functional/ d7/ Upgrade7Test.php - Gets the available upgrade paths.
File
-
core/
modules/ views/ src/ Plugin/ views/ style/ EntityReference.php, line 22
Namespace
Drupal\views\Plugin\views\styleView 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'] = [
'default' => [],
];
return $options;
}
/**
* {@inheritdoc}
*/
public function buildOptionsForm(&$form, FormStateInterface $form_state) {
parent::buildOptionsForm($form, $form_state);
$options = $this->displayHandler
->getFieldLabels(TRUE);
$form['search_fields'] = [
'#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 = [];
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
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
DerivativeInspectionInterface::getBaseId | public | function | Gets the base_plugin_id of the plugin instance. | 1 | |
DerivativeInspectionInterface::getDerivativeId | public | function | Gets the derivative_id of the plugin instance. | 1 | |
EntityReference::$usesFields | protected | property | Does the style plugin for itself support to add fields to its output. | Overrides StylePluginBase::$usesFields | |
EntityReference::$usesGrouping | protected | property | Does the style plugin support grouping of rows. | Overrides StylePluginBase::$usesGrouping | |
EntityReference::$usesRowPlugin | protected | property | Whether or not this style uses a row plugin. | 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::$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::$renderer | protected | property | Stores the render API renderer. | 3 | |
PluginBase::$view | public | property | The top object of a view. | 1 | |
PluginBase::calculateDependencies | public | function | Calculates dependencies for the configured plugin. | Overrides DependentPluginInterface::calculateDependencies | 14 |
PluginBase::create | public static | function | Creates an instance of the plugin. | Overrides ContainerFactoryPluginInterface::create | 62 |
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::getProvider | public | function | Returns the plugin provider. | Overrides ViewsPluginInterface::getProvider | |
PluginBase::getRenderer | protected | function | Returns the render API renderer. | 1 | |
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 | 16 |
PluginBase::summaryTitle | public | function | Returns the summary of the settings in the display. | Overrides ViewsPluginInterface::summaryTitle | 6 |
PluginBase::themeFunctions | public | function | Provide a full list of possible theme templates used by this style. | Overrides ViewsPluginInterface::themeFunctions | 1 |
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 | 8 |
PluginBase::viewsTokenReplace | protected | function | Replaces Views' tokens in a given string. The resulting string will be sanitized with Xss::filterAdmin. |
1 | |
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT | constant | Query string to indicate the site default language. | |||
PluginBase::__construct | public | function | Constructs a PluginBase object. | 19 | |
PluginInspectionInterface::getPluginDefinition | public | function | Gets the definition of the plugin implementation. | 6 | |
PluginInspectionInterface::getPluginId | public | function | Gets the plugin_id of the plugin instance. | 2 | |
StylePluginBase::$defaultFieldLabels | protected | property | Should field labels be enabled by default. | 1 | |
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. | 3 | |
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. |
1 | |
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. |
1 | |
StylePluginBase::defaultFieldLabels | public | function | Return TRUE if this style enables field labels by default. | 1 | |
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 | 1 |
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::trustedCallbacks | public static | function | Lists the trusted callbacks provided by the implementing class. | Overrides PluginBase::trustedCallbacks | |
StylePluginBase::usesFields | public | function | Return TRUE if this style also uses fields. | 3 | |
StylePluginBase::usesGrouping | public | function | Returns the usesGrouping property. | 3 | |
StylePluginBase::usesRowClass | public | function | Returns the usesRowClass property. | 3 | |
StylePluginBase::usesRowPlugin | public | function | Returns the usesRowPlugin property. | 10 | |
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. | 1 | |
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.