Same filename in this branch
- 10 core/modules/migrate/src/Plugin/migrate/destination/Entity.php
- 10 core/modules/views/src/Plugin/views/area/Entity.php
- 10 core/modules/views/src/Plugin/views/argument_validator/Entity.php
Same filename and directory in other branches
- 8.9.x core/modules/views/src/Plugin/views/area/Entity.php
- 9 core/modules/views/src/Plugin/views/area/Entity.php
Namespace
Drupal\views\Plugin\views\area
File
core/modules/views/src/Plugin/views/area/Entity.php
View source
<?php
namespace Drupal\views\Plugin\views\area;
use Drupal\Core\Entity\EntityDisplayRepositoryInterface;
use Drupal\Core\Entity\EntityRepositoryInterface;
use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\Form\FormStateInterface;
use Drupal\views\Attribute\ViewsArea;
use Drupal\views\Plugin\views\display\DisplayPluginBase;
use Drupal\views\ViewExecutable;
use Symfony\Component\DependencyInjection\ContainerInterface;
class Entity extends TokenizeAreaPluginBase {
protected $entityType;
protected $entityTypeManager;
protected $entityRepository;
protected $entityDisplayRepository;
public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entity_type_manager, EntityRepositoryInterface $entity_repository, EntityDisplayRepositoryInterface $entity_display_repository) {
parent::__construct($configuration, $plugin_id, $plugin_definition);
$this->entityTypeManager = $entity_type_manager;
$this->entityRepository = $entity_repository;
$this->entityDisplayRepository = $entity_display_repository;
}
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
return new static($configuration, $plugin_id, $plugin_definition, $container
->get('entity_type.manager'), $container
->get('entity.repository'), $container
->get('entity_display.repository'));
}
public function init(ViewExecutable $view, DisplayPluginBase $display, array &$options = NULL) {
parent::init($view, $display, $options);
$this->entityType = $this->definition['entity_type'];
}
protected function defineOptions() {
$options = parent::defineOptions();
$options['tokenize']['default'] = TRUE;
$options['target'] = [
'default' => '',
];
$options['view_mode'] = [
'default' => 'default',
];
$options['bypass_access'] = [
'default' => FALSE,
];
return $options;
}
public function buildOptionsForm(&$form, FormStateInterface $form_state) {
parent::buildOptionsForm($form, $form_state);
$form['view_mode'] = [
'#type' => 'select',
'#options' => $this->entityDisplayRepository
->getViewModeOptions($this->entityType),
'#title' => $this
->t('View mode'),
'#default_value' => $this->options['view_mode'],
];
$label = $this->entityTypeManager
->getDefinition($this->entityType)
->getLabel();
$target = $this->options['target'];
if (!str_contains($this->options['target'], '{{')) {
if ($target_entity = $this->entityRepository
->loadEntityByConfigTarget($this->entityType, $this->options['target'])) {
$target = $target_entity
->id();
}
}
$form['target'] = [
'#title' => $this
->t('@entity_type_label ID', [
'@entity_type_label' => $label,
]),
'#type' => 'textfield',
'#default_value' => $target,
];
$form['bypass_access'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Bypass access checks'),
'#description' => $this
->t('If enabled, access permissions for rendering the entity are not checked.'),
'#default_value' => !empty($this->options['bypass_access']),
];
}
public function submitOptionsForm(&$form, FormStateInterface $form_state) {
parent::submitOptionsForm($form, $form_state);
$options = $form_state
->getValue('options');
if (!str_contains($options['target'], '{{')) {
if ($entity = $this->entityTypeManager
->getStorage($this->entityType)
->load($options['target'])) {
$options['target'] = $entity
->getConfigTarget();
}
$form_state
->setValue('options', $options);
}
}
public function render($empty = FALSE) {
if (!$empty || !empty($this->options['empty'])) {
if (str_contains($this->options['target'], '{{')) {
$target_id = (string) $this
->tokenizeValue($this->options['target']);
if ($entity = $this->entityTypeManager
->getStorage($this->entityType)
->load($target_id)) {
$target_entity = $entity;
}
}
else {
if ($entity = $this->entityRepository
->loadEntityByConfigTarget($this->entityType, $this->options['target'])) {
$target_entity = $entity;
}
}
if (isset($target_entity) && (!empty($this->options['bypass_access']) || $target_entity
->access('view'))) {
$view_builder = $this->entityTypeManager
->getViewBuilder($this->entityType);
return $view_builder
->view($target_entity, $this->options['view_mode']);
}
}
return [];
}
public function calculateDependencies() {
$dependencies = parent::calculateDependencies();
if (!str_contains($this->options['target'], '{{')) {
if ($entity = $this->entityRepository
->loadEntityByConfigTarget($this->entityType, $this->options['target'])) {
$dependencies[$this->entityTypeManager
->getDefinition($this->entityType)
->getConfigDependencyKey()][] = $entity
->getConfigDependencyName();
}
}
return $dependencies;
}
}
Classes