You are here

Home » API reference » Webform 6.x » WebformEntityReferenceEntityFormatter.php

class WebformEntityReferenceEntityFormatter in Webform 6.x

Same name and namespace in other branches
  1. 8.5 src/Plugin/Field/FieldFormatter/WebformEntityReferenceEntityFormatter.php \Drupal\webform\Plugin\Field\FieldFormatter\WebformEntityReferenceEntityFormatter

Plugin implementation of the 'Webform rendered entity' formatter.

Plugin annotation


@FieldFormatter(
  id = "webform_entity_reference_entity_view",
  label = @Translation("Webform"),
  description = @Translation("Display the referenced webform with default submission data."),
  field_types = {
    "webform"
  }
)

Hierarchy

Expanded class hierarchy of WebformEntityReferenceEntityFormatter

File

src/Plugin/Field/FieldFormatter/WebformEntityReferenceEntityFormatter.php, line 25

Namespace

Drupal\webform\Plugin\Field\FieldFormatter
View source 
class WebformEntityReferenceEntityFormatter extends WebformEntityReferenceFormatterBase {

  /**
   * The route match.
   *
   * @var \Drupal\Core\Routing\RouteMatchInterface
   */
  protected $routeMatch;

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The webform message manager.
   *
   * @var \Drupal\webform\WebformMessageManagerInterface
   */
  protected $messageManager;

  /**
   * Webform request handler.
   *
   * @var \Drupal\webform\WebformRequestInterface
   */
  protected $requestHandler;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    $instance = parent::create($container, $configuration, $plugin_id, $plugin_definition);
    $instance->routeMatch = $container
      ->get('current_route_match');
    $instance->entityTypeManager = $container
      ->get('entity_type.manager');
    $instance->messageManager = $container
      ->get('webform.message_manager');
    $instance->requestHandler = $container
      ->get('webform.request');
    return $instance;
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'source_entity' => TRUE,
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = parent::settingsSummary();
    $summary[] = $this
      ->t('Set submission source entity: @source_entity', [
      '@source_entity' => $this
        ->getSetting('source_entity') ? $this
        ->t('Yes') : $this
        ->t('No'),
    ]);
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    if ($this->fieldDefinition
      ->getTargetEntityTypeId() === 'paragraph') {
      $title = $this
        ->t("Use this paragraph field's main entity as the webform submission's source entity.");
      $description = $this
        ->t("If unchecked, the current page's entity will be used as the webform submission's source entity.");
    }
    else {
      $entity_type_definition = $this->entityTypeManager
        ->getDefinition($this->fieldDefinition
        ->getTargetEntityTypeId());
      $title = $this
        ->t("Use this field's %entity_type entity as the webform submission's source entity.", [
        '%entity_type' => $entity_type_definition
          ->getLabel(),
      ]);
      $description = $this
        ->t("If unchecked, the current page's entity will be used as the webform submission's source entity. For example, if this webform was displayed on a node's page, the current node would be used as the webform submission's source entity.", [
        '%entity_type' => $entity_type_definition
          ->getLabel(),
      ]);
    }
    $form = parent::settingsForm($form, $form_state);
    $form['source_entity'] = [
      '#title' => $title,
      '#description' => $description,
      '#type' => 'checkbox',
      '#return_type' => TRUE,
      '#default_value' => $this
        ->getSetting('source_entity'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {

    // Get items entity, which is the entity that the webform
    // is directly attached to. For Paragraphs this would be the field's
    // paragraph entity.
    $items_entity = $items
      ->getEntity();

    // Get the items main entity. For Paragraphs this would be the parent entity
    // of the the paragraph field.
    $items_main_entity = WebformSourceEntityManager::getMainSourceEntity($items_entity);
    $request_source_entity = $this->requestHandler
      ->getCurrentSourceEntity();

    // Determine if webform is previewed within a Paragraph on
    // entity edit forms (via *.edit_form or .content_translation_add routes).
    $route_name = $this->routeMatch
      ->getRouteName();
    $is_entity_edit_form = preg_match('/\\.edit_form$/', $route_name) || preg_match('/\\.content_translation_add$/', $route_name) || in_array($route_name, [
      'entity.block_content.canonical',
    ]);

    // Same goes for entity add forms.
    $is_entity_add_form = preg_match('/\\.add$/', $route_name);
    $is_paragraph = $items_entity && $items_entity
      ->getEntityTypeId() === 'paragraph';
    $is_paragraph_current_source_entity = $items_main_entity && $request_source_entity && $items_main_entity
      ->getEntityTypeId() === $request_source_entity
      ->getEntityTypeId() && $items_main_entity
      ->id() === $request_source_entity
      ->id();
    $is_paragraph_entity_edit_form = $is_entity_edit_form && $is_paragraph && $is_paragraph_current_source_entity;
    $is_paragraph_entity_add_form = $is_entity_add_form && $is_paragraph;
    $elements = [];
    foreach ($this
      ->getEntitiesToView($items, $langcode) as $delta => $entity) {
      if ($is_paragraph_entity_edit_form || $is_paragraph_entity_add_form) {

        // Webform can not be nested within node edit form because the nested
        // <form> tags will cause unexpected validation issues.
        $elements[$delta] = [
          '#type' => 'webform_message',
          '#message_message' => $this
            ->t('%label webform can not be previewed when editing content.', [
            '%label' => $entity
              ->label(),
          ]),
          '#message_type' => 'info',
        ];
      }
      else {
        $elements[$delta] = [
          '#type' => 'webform',
          '#webform' => $entity,
          '#default_data' => !empty($items[$delta]->default_data) ? Yaml::decode($items[$delta]->default_data) : [],
          '#entity' => $this
            ->getSetting('source_entity') ? $items_entity : NULL,
        ];
      }
      $this
        ->setCacheContext($elements[$delta], $entity, $items[$delta]);
    }
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  protected function checkAccess(EntityInterface $entity) {

    // Always allow access so that the Webform element can determine if the
    // Webform is accessible or an access denied message should be displayed.
    // @see \Drupal\webform\Element\Webform
    return AccessResult::allowed();
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
EntityReferenceFormatterBase::needsEntityLoad protected function Returns whether the entity referenced by an item needs to be loaded. 1
EntityReferenceFormatterBase::prepareView public function Loads the entities referenced in that field across all the entities being viewed. Overrides FormatterBase::prepareView
EntityReferenceFormatterBase::view public function Overrides FormatterBase::view
FormatterBase::$fieldDefinition protected property The field definition.
FormatterBase::$label protected property The label display setting.
FormatterBase::$settings protected property The formatter settings. Overrides PluginSettingsBase::$settings
FormatterBase::$viewMode protected property The view mode.
FormatterBase::getFieldSetting protected function Returns the value of a field setting.
FormatterBase::getFieldSettings protected function Returns the array of field settings.
FormatterBase::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides FormatterInterface::isApplicable 14
FormatterBase::__construct public function Constructs a FormatterBase object. Overrides PluginBase::__construct 12
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
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 2
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.
PluginSettingsBase::$defaultSettingsMerged protected property Whether default settings have been merged into the current $settings.
PluginSettingsBase::$thirdPartySettings protected property The plugin settings injected by third party modules.
PluginSettingsBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 6
PluginSettingsBase::getSetting public function Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings public function Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults protected function Merges default settings values into $settings.
PluginSettingsBase::onDependencyRemoval public function Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface::onDependencyRemoval 3
PluginSettingsBase::setSetting public function Sets the value of a setting for the plugin. Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings public function Sets the settings for the plugin. Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
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.
WebformEntityReferenceEntityFormatter::$entityTypeManager protected property The entity type manager.
WebformEntityReferenceEntityFormatter::$messageManager protected property The webform message manager.
WebformEntityReferenceEntityFormatter::$requestHandler protected property Webform request handler.
WebformEntityReferenceEntityFormatter::$routeMatch protected property The route match.
WebformEntityReferenceEntityFormatter::checkAccess protected function Checks access to the given entity. Overrides EntityReferenceFormatterBase::checkAccess
WebformEntityReferenceEntityFormatter::create public static function Creates an instance of the plugin. Overrides WebformEntityReferenceFormatterBase::create
WebformEntityReferenceEntityFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
WebformEntityReferenceEntityFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
WebformEntityReferenceEntityFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
WebformEntityReferenceEntityFormatter::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
WebformEntityReferenceFormatterBase::$configFactory protected property The config factory. 1
WebformEntityReferenceFormatterBase::$renderer protected property The renderer.
WebformEntityReferenceFormatterBase::$time protected property The time service.
WebformEntityReferenceFormatterBase::getEntitiesToView protected function Returns the referenced entities for display. Overrides EntityReferenceFormatterBase::getEntitiesToView
WebformEntityReferenceFormatterBase::setCacheContext protected function Set cache context.