class EntityRow in Display Suite 8.4
Same name and namespace in other branches
- 8.2 src/Plugin/views/row/EntityRow.php \Drupal\ds\Plugin\views\row\EntityRow
- 8.3 src/Plugin/views/row/EntityRow.php \Drupal\ds\Plugin\views\row\EntityRow
Generic entity row plugin to provide a common base for all entity types.
Plugin annotation
@ViewsRow(
id = "ds_entity",
deriver = "Drupal\ds\Plugin\Derivative\DsEntityRow"
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\views\Plugin\views\PluginBase implements DependentPluginInterface, ContainerFactoryPluginInterface, TrustedCallbackInterface, ViewsPluginInterface
- class \Drupal\views\Plugin\views\row\RowPluginBase
- class \Drupal\views\Plugin\views\row\EntityRow uses DeprecatedServicePropertyTrait, EntityTranslationRenderTrait
- class \Drupal\ds\Plugin\views\row\EntityRow
- class \Drupal\views\Plugin\views\row\EntityRow uses DeprecatedServicePropertyTrait, EntityTranslationRenderTrait
- class \Drupal\views\Plugin\views\row\RowPluginBase
- class \Drupal\views\Plugin\views\PluginBase implements DependentPluginInterface, ContainerFactoryPluginInterface, TrustedCallbackInterface, ViewsPluginInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of EntityRow
File
- src/
Plugin/ views/ row/ EntityRow.php, line 19
Namespace
Drupal\ds\Plugin\views\rowView source
class EntityRow extends ViewsEntityRow {
/**
* Contains an array of render arrays, one for each rendered entity.
*
* @var array
*/
protected $build = [];
/**
* {@inheritdoc}
*/
protected function defineOptions() {
$options = parent::defineOptions();
$options['alternating_fieldset'] = [
'contains' => [
'alternating' => [
'default' => FALSE,
'bool' => TRUE,
],
'allpages' => [
'default' => FALSE,
'bool' => TRUE,
],
'item' => [
'default' => [],
],
],
];
$options['grouping_fieldset'] = [
'contains' => [
'group' => [
'default' => FALSE,
'bool' => TRUE,
],
'group_field' => [
'default' => '',
],
'group_field_function' => [
'default' => '',
],
],
];
$options['advanced_fieldset'] = [
'contains' => [
'advanced' => [
'default' => FALSE,
'bool' => TRUE,
],
],
];
$options['switch_fieldset'] = [
'contains' => [
'switch' => [
'default' => FALSE,
'bool' => TRUE,
],
],
];
return $options;
}
/**
* {@inheritdoc}
*/
public function buildOptionsForm(&$form, FormStateInterface $form_state) {
parent::buildOptionsForm($form, $form_state);
// Use view mode of display settings.
if ($this->entityType == 'node' && \Drupal::moduleHandler()
->moduleExists('ds_switch_view_mode')) {
$form['switch_fieldset'] = [
'#type' => 'details',
'#title' => $this
->t('Use view mode of display settings'),
'#open' => $this->options['switch_fieldset']['switch'],
];
$form['switch_fieldset']['switch'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Use view mode of display settings'),
'#default_value' => $this->options['switch_fieldset']['switch'],
'#description' => $this
->t('Use the alternative view mode selected in the display settings tab.'),
];
}
// Alternating view modes.
$form['alternating_fieldset'] = [
'#type' => 'details',
'#title' => $this
->t('Alternating view mode'),
'#open' => $this->options['alternating_fieldset']['alternating'],
];
$form['alternating_fieldset']['alternating'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Use the changing view mode selector'),
'#default_value' => $this->options['alternating_fieldset']['alternating'],
];
$form['alternating_fieldset']['allpages'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Use this configuration on every page. Otherwise the default view mode is used as soon as you browse away from the first page of this view.'),
'#default_value' => isset($this->options['alternating_fieldset']['allpages']) ? $this->options['alternating_fieldset']['allpages'] : FALSE,
];
$pager = $this->view->display_handler
->getPlugin('pager');
$limit = $pager
->getItemsPerPage();
if ($limit == 0 || $limit > 20) {
$form['alternating_fieldset']['disabled'] = [
'#markup' => $this
->t('This option is disabled because you have unlimited items or listing more than 20 items.'),
];
$form['alternating_fieldset']['alternating']['#disabled'] = TRUE;
$form['alternating_fieldset']['allpages']['#disabled'] = TRUE;
}
else {
$i = 1;
$a = 0;
while ($limit != 0) {
$form['alternating_fieldset']['item_' . $a] = [
'#title' => $this
->t('Item @nr', [
'@nr' => $i,
]),
'#type' => 'select',
'#default_value' => isset($this->options['alternating_fieldset']['item_' . $a]) ? $this->options['alternating_fieldset']['item_' . $a] : 'teaser',
'#options' => \Drupal::service('entity_display.repository')
->getViewModeOptions($this->entityTypeId),
'#states' => [
'visible' => [
':input[name="row_options[alternating_fieldset][alternating]"]' => [
'checked' => TRUE,
],
],
],
];
$limit--;
$a++;
$i++;
}
}
// Grouping rows.
$sorts = $this->view->display_handler
->getOption('sorts');
$groupable = !empty($sorts) && $this->options['grouping_fieldset']['group'];
$form['grouping_fieldset'] = [
'#type' => 'details',
'#title' => $this
->t('Group data'),
'#open' => $groupable,
];
$form['grouping_fieldset']['group'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Group data on a field. The value of this field will be displayed too.'),
'#default_value' => $groupable,
];
if (!empty($sorts)) {
$sort_options = [];
foreach ($sorts as $sort) {
$sort_name = Unicode::ucfirst($sort['field']);
$sort_options[$sort['table'] . '|' . $sort['field']] = $sort_name;
}
$form['grouping_fieldset']['group_field'] = [
'#type' => 'select',
'#options' => $sort_options,
'#default_value' => isset($this->options['grouping_fieldset']['group_field']) ? $this->options['grouping_fieldset']['group_field'] : '',
];
$form['grouping_fieldset']['group_field_function'] = [
'#type' => 'textfield',
'#title' => 'Heading function',
'#description' => Html::escape(t('The value of the field can be in a very raw format (eg, date created). Enter a custom function which you can use to format that value. The value and the object will be passed into that function eg. custom_function($raw_value, $object);')),
'#default_value' => isset($this->options['grouping_fieldset']['group_field_function']) ? $this->options['grouping_fieldset']['group_field_function'] : '',
];
}
else {
$form['grouping_fieldset']['group']['#disabled'] = TRUE;
$form['grouping_fieldset']['group']['#description'] = $this
->t('Grouping is disabled because you do not have any sort fields.');
}
// Advanced function.
$form['advanced_fieldset'] = [
'#type' => 'details',
'#title' => $this
->t('Advanced view mode'),
'#open' => $this->options['advanced_fieldset']['advanced'],
];
$form['advanced_fieldset']['advanced'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Use the advanced view mode selector'),
'#description' => $this
->t('This gives you the opportunity to have full control of a list for really advanced features.<br /> There is no UI for this, you need to create a hook named like this: hook_ds_views_row_render_entity($entity, $view_mode).', [
'@VIEWSNAME' => $this->view->storage
->id(),
]),
'#default_value' => $this->options['advanced_fieldset']['advanced'],
];
}
/**
* {@inheritdoc}
*/
protected function getEntityTranslationRenderer() {
if (!isset($this->entityLanguageRenderer)) {
$view = $this
->getView();
$rendering_language = $view->display_handler
->getOption('rendering_language');
$langcode = NULL;
$dynamic_renderers = [
'***LANGUAGE_entity_translation***' => 'TranslationLanguageRenderer',
'***LANGUAGE_entity_default***' => 'DefaultLanguageRenderer',
];
if (isset($dynamic_renderers[$rendering_language])) {
// Dynamic language set based on result rows or instance defaults.
$renderer = $dynamic_renderers[$rendering_language];
}
else {
if (strpos($rendering_language, '***LANGUAGE_') !== FALSE) {
$langcode = PluginBase::queryLanguageSubstitutions()[$rendering_language];
}
else {
// Specific langcode set.
$langcode = $rendering_language;
}
$renderer = 'ConfigurableLanguageRenderer';
}
$class = '\\Drupal\\ds\\Plugin\\views\\Entity\\Render\\' . $renderer;
$entity_type = \Drupal::service('entity_type.manager')
->getDefinition($this
->getEntityTypeId());
$this->entityLanguageRenderer = new $class($view, $this
->getLanguageManager(), $entity_type, $langcode);
}
return $this->entityLanguageRenderer;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
DeprecatedServicePropertyTrait:: |
public | function | Allows to access deprecated/removed properties. | |
EntityRow:: |
public | property | The actual field which is used for the entity id. | |
EntityRow:: |
public | property | The table the entity is using for storage. | |
EntityRow:: |
protected | property | Contains an array of render arrays, one for each rendered entity. | |
EntityRow:: |
protected | property | ||
EntityRow:: |
protected | property | The entity display repository. | |
EntityRow:: |
protected | property | The entity repository service. | |
EntityRow:: |
protected | property | Contains the entity type of this row plugin instance. | |
EntityRow:: |
protected | property | Stores the entity type ID of the result entities. | |
EntityRow:: |
protected | property | The entity type manager. | |
EntityRow:: |
protected | property | The language manager. | |
EntityRow:: |
public | function |
Provide a form for setting options. Overrides EntityRow:: |
|
EntityRow:: |
public | function |
Calculates dependencies for the configured plugin. Overrides PluginBase:: |
|
EntityRow:: |
public static | function |
Creates an instance of the plugin. Overrides PluginBase:: |
|
EntityRow:: |
protected | function |
Information about options for all kinds of purposes will be held here. Overrides EntityRow:: |
|
EntityRow:: |
protected | function | ||
EntityRow:: |
protected | function |
Returns the entity repository. Overrides EntityTranslationRenderTrait:: |
|
EntityRow:: |
protected | function |
Returns the current renderer. Overrides EntityTranslationRenderTrait:: |
|
EntityRow:: |
public | function |
Returns the entity type identifier. Overrides EntityTranslationRenderTrait:: |
|
EntityRow:: |
protected | function |
Returns the entity type manager. Overrides EntityTranslationRenderTrait:: |
|
EntityRow:: |
protected | function |
Returns the language manager. Overrides EntityTranslationRenderTrait:: |
|
EntityRow:: |
protected | function |
Returns the top object of a view. Overrides EntityTranslationRenderTrait:: |
|
EntityRow:: |
public | function |
Initialize the plugin. Overrides PluginBase:: |
|
EntityRow:: |
public | function |
Allow the style to do stuff before each row is rendered. Overrides RowPluginBase:: |
|
EntityRow:: |
public | function |
Add anything to the query that we might need to. Overrides RowPluginBase:: |
|
EntityRow:: |
public | function |
Render a row object. This usually passes through to a theme template
of some form, but not always. Overrides RowPluginBase:: |
|
EntityRow:: |
public | function |
Returns the summary of the settings in the display. Overrides PluginBase:: |
|
EntityRow:: |
public | function |
Constructs a new EntityRow object. Overrides PluginBase:: |
|
EntityTranslationRenderTrait:: |
protected | property | The renderer to be used to render the entity row. | |
EntityTranslationRenderTrait:: |
public | function | Returns the entity translation matching the configured row language. | |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
public | property | Plugins's definition | |
PluginBase:: |
public | property | The display object this plugin is for. | |
PluginBase:: |
public | property | Options for this plugin will be held here. | |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
protected | property | Stores the render API renderer. | 3 |
PluginBase:: |
public | property | The top object of a view. | 1 |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Clears a plugin. Overrides ViewsPluginInterface:: |
2 |
PluginBase:: |
protected | function | Do the work to filter out stored options depending on the defined options. | |
PluginBase:: |
public | function |
Filter out stored options depending on the defined options. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public | function |
Returns an array of available token replacements. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function |
Returns the plugin provider. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
protected | function | Returns the render API renderer. | 1 |
PluginBase:: |
public | function |
Adds elements for available core tokens to a form. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public | function |
Returns a string with any core tokens replaced. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
constant | Include entity row languages when listing languages. | ||
PluginBase:: |
constant | Include negotiated languages when listing languages. | ||
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
PluginBase:: |
protected | function | Makes an array of languages, optionally including special languages. | |
PluginBase:: |
public | function |
Return the human readable name of the display. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public static | function |
Moves form elements into fieldsets for presentation purposes. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public static | function |
Flattens the structure of form elements. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public static | function | Returns substitutions for Views queries for languages. | |
PluginBase:: |
protected | function | Fills up the options of the plugin with defaults. | |
PluginBase:: |
public | function |
Provide a full list of possible theme templates used by this style. Overrides ViewsPluginInterface:: |
1 |
PluginBase:: |
public static | function |
Lists the trusted callbacks provided by the implementing class. Overrides TrustedCallbackInterface:: |
6 |
PluginBase:: |
public | function |
Unpack options over our existing defaults, drilling down into arrays
so that defaults don't get totally blown away. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public | function |
Returns the usesOptions property. Overrides ViewsPluginInterface:: |
8 |
PluginBase:: |
public | function |
Validate that the plugin is correct and can be saved. Overrides ViewsPluginInterface:: |
6 |
PluginBase:: |
protected | function | Replaces Views' tokens in a given string. The resulting string will be sanitized with Xss::filterAdmin. | 1 |
PluginBase:: |
constant | Query string to indicate the site default language. | ||
RowPluginBase:: |
protected | property | Does the row plugin support to add fields to its output. | 4 |
RowPluginBase:: |
protected | property |
Denotes whether the plugin has an additional options form. Overrides PluginBase:: |
1 |
RowPluginBase:: |
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:: |
1 |
RowPluginBase:: |
public | function | Returns the usesFields property. | 4 |
RowPluginBase:: |
public | function |
Validate the options form. Overrides PluginBase:: |
1 |
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
TrustedCallbackInterface:: |
constant | Untrusted callbacks throw exceptions. | ||
TrustedCallbackInterface:: |
constant | Untrusted callbacks trigger silenced E_USER_DEPRECATION errors. | ||
TrustedCallbackInterface:: |
constant | Untrusted callbacks trigger E_USER_WARNING errors. |