You are here

class WebformComputedTwig in Webform 8.5

Same name in this branch
  1. 8.5 src/Element/WebformComputedTwig.php \Drupal\webform\Element\WebformComputedTwig
  2. 8.5 src/Plugin/WebformElement/WebformComputedTwig.php \Drupal\webform\Plugin\WebformElement\WebformComputedTwig
Same name and namespace in other branches
  1. 6.x src/Element/WebformComputedTwig.php \Drupal\webform\Element\WebformComputedTwig

Provides an item to display computed webform submission values using Twig.

Plugin annotation

@RenderElement("webform_computed_twig");

Hierarchy

Expanded class hierarchy of WebformComputedTwig

1 file declares its use of WebformComputedTwig
WebformComputedBase.php in src/Plugin/WebformElement/WebformComputedBase.php

File

src/Element/WebformComputedTwig.php, line 13

Namespace

Drupal\webform\Element
View source
class WebformComputedTwig extends WebformComputedBase {

  /**
   * Whitespace spaceless.
   *
   * Remove whitespace around the computed value and between HTML tags.
   */
  const WHITESPACE_SPACELESS = 'spaceless';

  /**
   * Whitespace trim.
   *
   * Remove whitespace around the computed value.
   */
  const WHITESPACE_TRIM = 'trim';

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    return parent::getInfo() + [
      '#whitespace' => '',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public static function computeValue(array $element, WebformSubmissionInterface $webform_submission) {

    /** @var \Drupal\webform\WebformThemeManagerInterface $theme_manager */
    $theme_manager = \Drupal::service('webform.theme_manager');

    // Do not compute value via Twig if there is no active theme,
    // except for CLI.
    // Rendering a Twig template before the theme is activated can cause
    // unexpected behaviors.
    if (!$theme_manager
      ->hasActiveTheme() && PHP_SAPI !== 'cli') {
      return '';
    }
    $whitespace = !empty($element['#whitespace']) ? $element['#whitespace'] : '';
    $template = $whitespace === static::WHITESPACE_SPACELESS ? '{% spaceless %}' . $element['#template'] . '{% endspaceless %}' : $element['#template'];
    $options = [
      'html' => static::getMode($element) === WebformComputedInterface::MODE_HTML,
    ];
    $value = WebformTwigExtension::renderTwigTemplate($webform_submission, $template, $options);
    return $whitespace === static::WHITESPACE_TRIM ? trim($value) : $value;
  }

}

Members

Namesort descending 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
FormElement::processAutocomplete public static function Adds autocomplete functionality to elements.
FormElement::processPattern public static function #process callback for #pattern form element property.
FormElement::validatePattern public static function #element_validate callback for #pattern form element property.
FormElement::valueCallback public static function Determines how user input is mapped to an element's #value property. Overrides FormElementInterface::valueCallback 15
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.
WebformComputedBase::$submissions protected static property Cache of submissions being processed.
WebformComputedBase::ajaxWebformComputedCallback public static function Webform computed element Ajax callback.
WebformComputedBase::getMode public static function Get an element's value mode/type.
WebformComputedBase::getWebformSubmission protected static function Get the Webform submission for element.
WebformComputedBase::isAjax protected static function Determine if the current request is using Ajax.
WebformComputedBase::processWebformComputed public static function Processes a Webform computed token element.
WebformComputedBase::setWebformComputedElementValue protected static function Set computed element's value.
WebformComputedBase::submitWebformComputedCallback public static function Webform computed element submit callback.
WebformComputedBase::validateWebformComputed public static function Validates an computed element.
WebformComputedBase::validateWebformComputedCallback public static function Webform computed element validate callback.
WebformComputedInterface::MODE_AUTO constant Denotes markup whose content type should be detected.
WebformComputedInterface::MODE_HTML constant Denotes HTML.
WebformComputedInterface::MODE_TEXT constant Denotes plain text.
WebformComputedTwig::computeValue public static function Compute value. Overrides WebformComputedBase::computeValue
WebformComputedTwig::getInfo public function Returns the element properties for this element. Overrides WebformComputedBase::getInfo
WebformComputedTwig::WHITESPACE_SPACELESS constant Whitespace spaceless.
WebformComputedTwig::WHITESPACE_TRIM constant Whitespace trim.