class WebformSubmissionInformation in Webform 6.x

Provides a render element to display webform submission information.

Plugin annotation

@RenderElement("webform_submission_information");

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\Element\WebformSubmissionInformation

4 #type uses of WebformSubmissionInformation

WebformSubmissionForm::form in src/WebformSubmissionForm.php

Gets the actual form array to be built.

WebformSubmissionNotesForm::form in src/WebformSubmissionNotesForm.php

Gets the actual form array to be built.

WebformSubmissionResendForm::buildForm in src/Form/WebformSubmissionResendForm.php

Form constructor.

WebformSubmissionViewController::view in src/Controller/WebformSubmissionViewController.php

Provides a page to render a single entity.

File

src/Element/WebformSubmissionInformation.php, line 12

Namespace

Drupal\webform\Element

class WebformSubmissionInformation extends RenderElement {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = get_class($this);
    return [
      '#theme' => 'webform_submission_information',
      '#webform_submission' => NULL,
      '#source_entity' => NULL,
      '#pre_render' => [
        [
          $class,
          'preRenderWebformSubmissionInformation',
        ],
      ],
      '#theme_wrappers' => [
        'details',
      ],
      '#summary_attributes' => [],
    ];
  }

  /**
   * Create webform submission information for rendering.
   *
   * @param array $element
   *   An associative array containing the properties and children of the
   *   element.
   *
   * @return array
   *   The modified element with webform submission information.
   */
  public static function preRenderWebformSubmissionInformation(array $element) {

    /** @var \Drupal\webform\WebformSubmissionInterface $webform_submission */
    $webform_submission = $element['#webform_submission'];
    $webform = $webform_submission
      ->getWebform();

    // Add title.
    $element += [
      '#title' => t('Submission information'),
    ];

    // Add details attributes.
    $element['#attributes']['data-webform-element-id'] = $webform
      ->id() . '-submission-information';
    $element['#attributes']['class'] = [
      'webform-submission-information',
    ];
    return $element;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
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.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	98
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.	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.
WebformSubmissionInformation::getInfo	public	function	Returns the element properties for this element. Overrides ElementInterface::getInfo
WebformSubmissionInformation::preRenderWebformSubmissionInformation	public static	function	Create webform submission information for rendering.