class RenderedEntity in Entity Browser 8

Displays the fully rendered entity.

Plugin annotation

@EntityBrowserFieldWidgetDisplay(
  id = "rendered_entity",
  label = @Translation("Rendered entity"),
  description = @Translation("Displays fully rendered entity.")
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\entity_browser\FieldWidgetDisplayBase implements FieldWidgetDisplayInterface
      • class \Drupal\entity_browser\Plugin\EntityBrowser\FieldWidgetDisplay\RenderedEntity implements ContainerFactoryPluginInterface

File

src/Plugin/EntityBrowser/FieldWidgetDisplay/RenderedEntity.php, line 22

Namespace

Drupal\entity_browser\Plugin\EntityBrowser\FieldWidgetDisplay

class RenderedEntity extends FieldWidgetDisplayBase implements ContainerFactoryPluginInterface {

  /**
   * Entity manager service.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * Entity display repository.
   *
   * @var \Drupal\Core\Entity\EntityDisplayRepositoryInterface
   */
  protected $entityDisplayRepository;

  /**
   * Constructs widget plugin.
   *
   * @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
   *   Entity type manager service.
   * @param \Drupal\Core\Entity\EntityDisplayRepositoryInterface $entity_display_repository
   *   Entity display repository service.
   */
  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 view(EntityInterface $entity) {
    $build = $this->entityTypeManager
      ->getViewBuilder($this->configuration['entity_type'])
      ->view($entity, $this->configuration['view_mode']);
    $build['#entity_browser_suppress_contextual'] = TRUE;
    $build['#cache']['keys'][] = 'entity_browser';
    return $build;
  }

  /**
   * Get the label from the view mode.
   *
   * @return string
   *   View mode label.
   */
  public function getViewModeLabel() {
    if (!empty($this->configuration['entity_type']) && !empty($this->configuration['view_mode'])) {
      $view_modes = $this->entityDisplayRepository
        ->getViewModeOptions($this->configuration['entity_type']);
      return $view_modes[$this->configuration['view_mode']];
    }
    return $this
      ->t('Default');
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $options = [];
    foreach ($this->entityDisplayRepository
      ->getViewModeOptions($this->configuration['entity_type']) as $id => $view_mode_label) {
      $options[$id] = $view_mode_label;
    }
    return [
      'view_mode' => [
        '#type' => 'select',
        '#title' => $this
          ->t('View mode'),
        '#description' => $this
          ->t('Select view mode to be used when rendering entities.'),
        '#default_value' => $this->configuration['view_mode'],
        '#options' => $options,
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'view_mode' => 'default',
    ] + parent::defaultConfiguration();
  }

  /**
   * {@inheritdoc}
   */
  public function calculateDependencies() {
    $dependencies = parent::calculateDependencies();
    if ($view_mode = $this->entityTypeManager
      ->getStorage('entity_view_mode')
      ->load($this->configuration['entity_type'] . '.' . $this->configuration['view_mode'])) {
      $dependencies[$view_mode
        ->getConfigDependencyKey()][] = $view_mode
        ->getConfigDependencyName();
    }
    return $dependencies;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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		1
DependencySerializationTrait::__wakeup	public	function		2
FieldWidgetDisplayBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
FieldWidgetDisplayBase::isApplicable	public	function	Returns if the FieldWidgetDisplay can be used for the provided field. Overrides FieldWidgetDisplayInterface::isApplicable	1
FieldWidgetDisplayBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
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::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
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.
RenderedEntity::$entityDisplayRepository	protected	property	Entity display repository.
RenderedEntity::$entityTypeManager	protected	property	Entity manager service.
RenderedEntity::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides FieldWidgetDisplayBase::calculateDependencies
RenderedEntity::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
RenderedEntity::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides FieldWidgetDisplayBase::defaultConfiguration
RenderedEntity::getViewModeLabel	public	function	Get the label from the view mode.
RenderedEntity::settingsForm	public	function	Returns a form to configure settings for the plugin. Overrides FieldWidgetDisplayBase::settingsForm
RenderedEntity::view	public	function	Builds and gets render array for the entity. Overrides FieldWidgetDisplayInterface::view
RenderedEntity::__construct	public	function	Constructs widget plugin. Overrides FieldWidgetDisplayBase::__construct
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
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.