class WebformNodeElement in Webform Node Element 8

Provides a render element to display a node.

Plugin annotation

@FormElement("webform_node_element");

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
      • class \Drupal\webform_node_element\Element\WebformNodeElement

1 #type use of WebformNodeElement

WebformNodeElementFunctionalTest::testGet in tests/src/Functional/WebformNodeElementFunctionalTest.php

Test that the webform node element is displayed on the form.

File

src/Element/WebformNodeElement.php, line 13

Namespace

Drupal\webform_node_element\Element

class WebformNodeElement extends RenderElement {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = get_class($this);
    return [
      '#pre_render' => [
        [
          $class,
          "preRenderWebformNodeElement",
        ],
      ],
      '#webform_node_element_nid' => NULL,
    ];
  }

  /**
   * Add the rendered node to the element.
   *
   * @param array $element
   *   An associative array containing the properties of the element.
   *
   * @return array
   *   The $element.
   */
  public static function preRenderWebformNodeElement(array $element) {
    $element['#markup'] = "";
    $nid = $element['#webform_node_element_nid'];
    $element_id = $element['#webform_id'];

    // Allow event subscribers to set the nid and display mode.
    $dispatcher = \Drupal::service('event_dispatcher');
    $event = new WebformNodeElementPreRender($element_id, $nid, 'webform_element');
    $dispatcher
      ->dispatch(WebformNodeElementPreRender::PRERENDER, $event);
    $nid = $event
      ->getNid();

    // This guarantees the nid is valid.
    $nid_array = \Drupal::entityQuery('node')
      ->condition('nid', $nid)
      ->execute();
    $nid = reset($nid_array);
    $display_mode = $event
      ->getDisplayMode();
    if ($nid && $display_mode) {
      $node = \Drupal::entityTypeManager()
        ->getStorage('node')
        ->load($nid);
      if ($node
        ->access('view')) {
        $view_builder = \Drupal::entityTypeManager()
          ->getViewBuilder('node');
        if ($node && $view_builder) {
          if ($render_array = $view_builder
            ->view($node, $display_mode)) {
            $element['#markup'] = \Drupal::service('renderer')
              ->render($render_array, false);
          }
        }
      }
    }
    else {
      \Drupal::logger('webform_node_element')
        ->notice('webform_node_element @element_id not rendered because nid was set to "@nid" and display_mode was set to "@display_mode"', [
        '@element_id' => $element_id,
        '@nid' => $nid,
        '@display_mode' => $display_mode,
      ]);
    }
    return $element;
  }

}

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
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.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
RenderElement::preRenderAjaxForm	public static	function	Adds Ajax information about an element to communicate with JavaScript.
RenderElement::preRenderGroup	public static	function	Adds members of this group as actual elements for rendering.
RenderElement::processAjaxForm	public static	function	Form element processing handler for the #ajax form property.	1
RenderElement::processGroup	public static	function	Arranges elements into groups.
RenderElement::setAttributes	public static	function	Sets a form element's class attribute. Overrides ElementInterface::setAttributes
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.
WebformNodeElement::getInfo	public	function	Returns the element properties for this element. Overrides ElementInterface::getInfo
WebformNodeElement::preRenderWebformNodeElement	public static	function	Add the rendered node to the element.