class EntityView
Provides a block to view a specific entity.
Plugin annotation
@Block(
id = "entity_view",
deriver = "Drupal\ctools\Plugin\Deriver\EntityViewDeriver",
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
- class \Drupal\Core\Block\BlockBase implements \Drupal\Core\Block\BlockPluginInterface, \Drupal\Core\Plugin\PluginWithFormsInterface, \Drupal\Core\Plugin\PreviewAwarePluginInterface, \Drupal\Core\Render\PreviewFallbackInterface, \Drupal\Core\Plugin\ContextAwarePluginInterface uses \Drupal\Core\Block\BlockPluginTrait, \Drupal\Core\Plugin\ContextAwarePluginTrait, \Drupal\Core\Plugin\ContextAwarePluginAssignmentTrait extends \Drupal\Core\Plugin\PluginBase
- class \Drupal\ctools\Plugin\Block\EntityView implements \Drupal\Core\Plugin\ContextAwarePluginInterface, \Drupal\Core\Plugin\ContainerFactoryPluginInterface extends \Drupal\Core\Block\BlockBase
- class \Drupal\Core\Block\BlockBase implements \Drupal\Core\Block\BlockPluginInterface, \Drupal\Core\Plugin\PluginWithFormsInterface, \Drupal\Core\Plugin\PreviewAwarePluginInterface, \Drupal\Core\Render\PreviewFallbackInterface, \Drupal\Core\Plugin\ContextAwarePluginInterface uses \Drupal\Core\Block\BlockPluginTrait, \Drupal\Core\Plugin\ContextAwarePluginTrait, \Drupal\Core\Plugin\ContextAwarePluginAssignmentTrait extends \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
Expanded class hierarchy of EntityView
1 file declares its use of EntityView
- EntityViewTest.php in tests/
src/ Kernel/ Plugin/ Block/ EntityViewTest.php
File
-
src/
Plugin/ Block/ EntityView.php, line 23
Namespace
Drupal\ctools\Plugin\BlockView source
class EntityView extends BlockBase implements ContextAwarePluginInterface, ContainerFactoryPluginInterface {
/**
* The entity type manager.
*
* @var \Drupal\Core\Entity\EntityTypeManagerInterface
*/
protected $entityTypeManager;
/**
* The entity display repository.
*
* @var \Drupal\Core\Entity\EntityDisplayRepositoryInterface
*/
protected $entityDisplayRepository;
/**
* Constructs a new EntityView.
*
* @param array $configuration
* A configuration array containing information about the plugin instance.
* @param string $plugin_id
* The plugin ID for the plugin instance.
* @param mixed $plugin_definition
* The plugin implementation definition.
* @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
* The entity type manager.
* @param \Drupal\Core\Entity\EntityDisplayRepositoryInterface $entity_display_repository
* The entity display repository.
*/
public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entity_type_manager, EntityDisplayRepositoryInterface $entity_display_repository) {
parent::__construct($configuration, $plugin_id, $plugin_definition);
$this->entityTypeManager = $entity_type_manager;
$this->entityDisplayRepository = $entity_display_repository;
}
/**
* {@inheritdoc}
*/
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_display.repository'));
}
/**
* {@inheritdoc}
*/
public function defaultConfiguration() {
return [
'view_mode' => 'default',
];
}
/**
* {@inheritdoc}
*/
public function blockForm($form, FormStateInterface $form_state) {
$form['view_mode'] = [
'#type' => 'select',
'#options' => $this->entityDisplayRepository
->getViewModeOptions($this->getDerivativeId()),
'#title' => $this->t('View mode'),
'#default_value' => $this->configuration['view_mode'],
];
return $form;
}
/**
* {@inheritdoc}
*/
public function blockSubmit($form, FormStateInterface $form_state) {
$this->configuration['view_mode'] = $form_state->getValue('view_mode');
}
/**
* {@inheritdoc}
*/
public function access(AccountInterface $account, $return_as_object = FALSE) {
// Check the parent's access.
$parent_access = parent::access($account, TRUE);
if (!$parent_access->isAllowed()) {
return $return_as_object ? $parent_access : $parent_access->isAllowed();
}
/** @var \Drupal\Core\Entity\EntityInterface $entity */
$entity = $this->getContextValue('entity');
return $entity->access('view', $account, $return_as_object);
}
/**
* {@inheritdoc}
*/
public function build() {
/** @var \Drupal\Core\Entity\EntityInterface $entity */
$entity = $this->getContextValue('entity');
$view_builder = $this->entityTypeManager
->getViewBuilder($entity->getEntityTypeId());
$build = $view_builder->view($entity, $this->configuration['view_mode']);
CacheableMetadata::createFromObject($entity)->merge(CacheableMetadata::createFromRenderArray($build))
->applyTo($build);
return $build;
}
}
Members
| Title Sort descending | Modifiers | Object type | Summary | Member alias | Overriden Title | Overrides |
|---|---|---|---|---|---|---|
| BlockBase::buildConfigurationForm | public | function | Form constructor. | Overrides PluginFormInterface::buildConfigurationForm | 2 | |
| BlockPluginInterface::BLOCK_LABEL_VISIBLE | constant | Indicates the block label (title) should be displayed to end users. | ||||
| BlockPluginTrait::$inPreview | protected | property | Whether the plugin is being rendered in preview mode. | |||
| BlockPluginTrait::$transliteration | protected | property | The transliteration service. | |||
| BlockPluginTrait::baseConfigurationDefaults | protected | function | Returns generic default configuration for block plugins. | |||
| BlockPluginTrait::blockAccess | protected | function | Indicates whether the block should be shown. | 18 | ||
| BlockPluginTrait::blockValidate | public | function | 3 | |||
| BlockPluginTrait::buildConfigurationForm | public | function | Creates a generic configuration form for all block types. Individual block plugins can add elements to this form by overriding BlockBase::blockForm(). Most block plugins should not override this method unless they need to alter the generic form elements. |
Aliased as: traitBuildConfigurationForm | ||
| BlockPluginTrait::calculateDependencies | public | function | 1 | |||
| BlockPluginTrait::getConfiguration | public | function | 1 | |||
| BlockPluginTrait::getMachineNameSuggestion | public | function | 1 | |||
| BlockPluginTrait::getPreviewFallbackString | public | function | 3 | |||
| BlockPluginTrait::label | public | function | ||||
| BlockPluginTrait::setConfiguration | public | function | ||||
| BlockPluginTrait::setConfigurationValue | public | function | ||||
| BlockPluginTrait::setInPreview | public | function | ||||
| BlockPluginTrait::setTransliteration | public | function | Sets the transliteration service. | |||
| BlockPluginTrait::submitConfigurationForm | public | function | Most block plugins should not override this method. To add submission handling for a specific block type, override BlockBase::blockSubmit(). |
|||
| BlockPluginTrait::transliteration | protected | function | Wraps the transliteration service. | |||
| BlockPluginTrait::validateConfigurationForm | public | function | Most block plugins should not override this method. To add validation for a specific block type, override BlockBase::blockValidate(). |
1 | ||
| ContextAwarePluginAssignmentTrait::addContextAssignmentElement | protected | function | Builds a form element for assigning a context to a given slot. | |||
| ContextAwarePluginAssignmentTrait::contextHandler | protected | function | Wraps the context handler. | |||
| ContextAwarePluginTrait::$context | protected | property | The data objects representing the context of this plugin. | |||
| ContextAwarePluginTrait::getCacheContexts | public | function | 10 | |||
| ContextAwarePluginTrait::getCacheMaxAge | public | function | 6 | |||
| ContextAwarePluginTrait::getCacheTags | public | function | 3 | |||
| ContextAwarePluginTrait::getContext | public | function | ||||
| ContextAwarePluginTrait::getContextDefinition | public | function | ||||
| ContextAwarePluginTrait::getContextDefinitions | public | function | ||||
| ContextAwarePluginTrait::getContextMapping | public | function | 1 | |||
| ContextAwarePluginTrait::getContexts | public | function | ||||
| ContextAwarePluginTrait::getContextValue | public | function | ||||
| ContextAwarePluginTrait::getContextValues | public | function | ||||
| ContextAwarePluginTrait::getPluginDefinition | abstract public | function | 1 | |||
| ContextAwarePluginTrait::setContext | public | function | 1 | |||
| ContextAwarePluginTrait::setContextMapping | public | function | ||||
| ContextAwarePluginTrait::setContextValue | public | function | ||||
| ContextAwarePluginTrait::validateContexts | public | function | ||||
| DependencySerializationTrait::$_entityStorages | protected | property | An array of entity type IDs keyed by the property name of their storages. | |||
| DependencySerializationTrait::$_serviceIds | protected | property | An array of service IDs keyed by property name used for serialization. | |||
| DependencySerializationTrait::__sleep | public | function | 2 | |||
| DependencySerializationTrait::__wakeup | public | function | #[\ReturnTypeWillChange] | 2 | ||
| EntityView::$entityDisplayRepository | protected | property | The entity display repository. | |||
| EntityView::$entityTypeManager | protected | property | The entity type manager. | |||
| EntityView::access | public | function | Overrides BlockPluginTrait::access | |||
| EntityView::blockForm | public | function | Overrides BlockPluginTrait::blockForm | |||
| EntityView::blockSubmit | public | function | Overrides BlockPluginTrait::blockSubmit | |||
| EntityView::build | public | function | Builds and returns the renderable array for this block plugin. | Overrides BlockPluginInterface::build | ||
| EntityView::create | public static | function | Creates an instance of the plugin. | Overrides ContainerFactoryPluginInterface::create | ||
| EntityView::defaultConfiguration | public | function | Overrides BlockPluginTrait::defaultConfiguration | |||
| EntityView::__construct | public | function | Constructs a new EntityView. | Overrides BlockPluginTrait::__construct | ||
| MessengerTrait::$messenger | protected | property | The messenger. | 25 | ||
| MessengerTrait::messenger | public | function | Gets the messenger. | 25 | ||
| MessengerTrait::setMessenger | public | function | Sets the messenger. | |||
| PluginBase::$configuration | protected | property | Configuration information passed into the plugin. | 1 | ||
| PluginBase::$pluginDefinition | protected | property | The plugin implementation definition. | 1 | ||
| PluginBase::$pluginId | protected | property | The plugin ID. | |||
| PluginBase::DERIVATIVE_SEPARATOR | constant | A string which is used to separate base plugin IDs from the derivative ID. | ||||
| 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::getPluginId | public | function | Gets the plugin ID of the plugin instance. | Overrides PluginInspectionInterface::getPluginId | ||
| PluginBase::isConfigurable | public | function | Determines if the plugin is configurable. | |||
| PluginWithFormsTrait::getFormClass | public | function | Implements \Drupal\Core\Plugin\PluginWithFormsInterface::getFormClass(). | |||
| PluginWithFormsTrait::hasFormClass | public | function | Implements \Drupal\Core\Plugin\PluginWithFormsInterface::hasFormClass(). | |||
| StringTranslationTrait::$stringTranslation | protected | property | The string translation service. | 3 | ||
| 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. | 2 | ||
| StringTranslationTrait::t | protected | function | Translates a string to the current language or to a given language. |