class EntityRow in Zircon Profile 8
Same name and namespace in other branches
- 8.0 core/modules/views/src/Plugin/views/row/EntityRow.php \Drupal\views\Plugin\views\row\EntityRow
Generic entity row plugin to provide a common base for all entity types.
Plugin annotation
@ViewsRow(
id = "entity",
deriver = "Drupal\views\Plugin\Derivative\ViewsEntityRow"
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, StringTranslationTrait
- class \Drupal\views\Plugin\views\PluginBase implements DependentPluginInterface, ContainerFactoryPluginInterface, ViewsPluginInterface
- class \Drupal\views\Plugin\views\row\RowPluginBase
- class \Drupal\views\Plugin\views\row\EntityRow uses EntityTranslationRenderTrait
- class \Drupal\views\Plugin\views\row\RowPluginBase
- class \Drupal\views\Plugin\views\PluginBase implements DependentPluginInterface, ContainerFactoryPluginInterface, ViewsPluginInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, StringTranslationTrait
Expanded class hierarchy of EntityRow
2 files declare their use of EntityRow
- NodeRow.php in core/
modules/ node/ src/ Plugin/ views/ row/ NodeRow.php - Contains \Drupal\node\Plugin\views\row\NodeRow.
- UserRow.php in core/
modules/ user/ src/ Plugin/ views/ row/ UserRow.php - Contains \Drupal\user\Plugin\views\row\UserRow.
File
- core/
modules/ views/ src/ Plugin/ views/ row/ EntityRow.php, line 26 - Contains \Drupal\views\Plugin\views\row\EntityRow.
Namespace
Drupal\views\Plugin\views\rowView source
class EntityRow extends RowPluginBase {
use EntityTranslationRenderTrait;
/**
* The table the entity is using for storage.
*
* @var string
*/
public $base_table;
/**
* The actual field which is used for the entity id.
*
* @var string
*/
public $base_field;
/**
* Stores the entity type ID of the result entities.
*
* @var string
*/
protected $entityTypeId;
/**
* Contains the entity type of this row plugin instance.
*
* @var \Drupal\Core\Entity\EntityTypeInterface
*/
protected $entityType;
/**
* The entity manager.
*
* @var \Drupal\Core\Entity\EntityManagerInterface
*/
public $entityManager;
/**
* The language manager.
*
* @var \Drupal\Core\Language\LanguageManagerInterface
*/
protected $languageManager;
/**
* {@inheritdoc}
*
* @param \Drupal\Core\Entity\EntityManagerInterface $entity_manager
* The entity manager.
* @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
* The language manager.
*/
public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityManagerInterface $entity_manager, LanguageManagerInterface $language_manager) {
parent::__construct($configuration, $plugin_id, $plugin_definition);
$this->entityManager = $entity_manager;
$this->languageManager = $language_manager;
}
/**
* {@inheritdoc}
*/
public function init(ViewExecutable $view, DisplayPluginBase $display, array &$options = NULL) {
parent::init($view, $display, $options);
$this->entityTypeId = $this->definition['entity_type'];
$this->entityType = $this->entityManager
->getDefinition($this->entityTypeId);
$this->base_table = $this->entityType
->getDataTable() ?: $this->entityType
->getBaseTable();
$this->base_field = $this->entityType
->getKey('id');
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
return new static($configuration, $plugin_id, $plugin_definition, $container
->get('entity.manager'), $container
->get('language_manager'));
}
/**
* {@inheritdoc}
*/
public function getEntityTypeId() {
return $this->entityType
->id();
}
/**
* {@inheritdoc}
*/
protected function getEntityManager() {
return $this->entityManager;
}
/**
* {@inheritdoc}
*/
protected function getLanguageManager() {
return $this->languageManager;
}
/**
* {@inheritdoc}
*/
protected function getView() {
return $this->view;
}
/**
* {@inheritdoc}
*/
protected function defineOptions() {
$options = parent::defineOptions();
$options['view_mode'] = array(
'default' => 'default',
);
return $options;
}
/**
* {@inheritdoc}
*/
public function buildOptionsForm(&$form, FormStateInterface $form_state) {
parent::buildOptionsForm($form, $form_state);
$form['view_mode'] = array(
'#type' => 'select',
'#options' => \Drupal::entityManager()
->getViewModeOptions($this->entityTypeId),
'#title' => $this
->t('View mode'),
'#default_value' => $this->options['view_mode'],
);
}
/**
* {@inheritdoc}
*/
public function summaryTitle() {
$options = \Drupal::entityManager()
->getViewModeOptions($this->entityTypeId);
if (isset($options[$this->options['view_mode']])) {
return $options[$this->options['view_mode']];
}
else {
return $this
->t('No view mode selected');
}
}
/**
* {@inheritdoc}
*/
public function query() {
parent::query();
$this
->getEntityTranslationRenderer()
->query($this->view
->getQuery());
}
/**
* {@inheritdoc}
*/
public function preRender($result) {
parent::preRender($result);
if ($result) {
$this
->getEntityTranslationRenderer()
->preRender($result);
}
}
/**
* {@inheritdoc}
*/
public function render($row) {
return $this
->getEntityTranslationRenderer()
->render($row);
}
/**
* {@inheritdoc}
*/
public function calculateDependencies() {
$dependencies = parent::calculateDependencies();
$view_mode = $this->entityManager
->getStorage('entity_view_mode')
->load($this->entityTypeId . '.' . $this->options['view_mode']);
if ($view_mode) {
$dependencies[$view_mode
->getConfigDependencyKey()][] = $view_mode
->getConfigDependencyName();
}
return $dependencies;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
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:: |
public | property | The entity manager. | |
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 language manager. | |
EntityRow:: |
public | function |
Provide a form for setting options. Overrides RowPluginBase:: |
|
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 RowPluginBase:: |
2 |
EntityRow:: |
protected | function |
Returns the entity manager. Overrides EntityTranslationRenderTrait:: |
|
EntityRow:: |
public | function |
Returns the entity type identifier. 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 |
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. | |
EntityTranslationRenderTrait:: |
protected | function | Returns the current renderer. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 2 |
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. | |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
protected | property | Stores the render API renderer. | 2 |
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:: |
|
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:: |
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 | 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:: |
5 |
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 it's 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:: |
function | Returns the usesFields property. | 4 | |
RowPluginBase:: |
public | function |
Validate the options form. Overrides PluginBase:: |
1 |
StringTranslationTrait:: |
protected | property | The string translation service. | |
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. |