You are here

class WebformShareScript in Webform 6.x

Same name and namespace in other branches
  1. 8.5 modules/webform_share/src/Element/WebformShareScript.php \Drupal\webform_share\Element\WebformShareScript

Provides a render element that creates a <script> tag to share a webform.

Plugin annotation

@RenderElement("webform_share_script");

Hierarchy

Expanded class hierarchy of WebformShareScript

2 #type uses of WebformShareScript
WebformShareNodeTest::testShare in modules/webform_share/tests/src/Functional/WebformShareNodeTest.php
Test share.
WebformShareTest::testShare in modules/webform_share/tests/src/Functional/WebformShareTest.php
Test share.

File

modules/webform_share/src/Element/WebformShareScript.php, line 15

Namespace

Drupal\webform_share\Element
View source
class WebformShareScript extends RenderElement implements TrustedCallbackInterface {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = get_class($this);
    return [
      '#webform' => NULL,
      '#source_entity' => NULL,
      '#query' => [],
      '#theme' => 'webform_share_script',
      '#pre_render' => [
        [
          $class,
          'preRenderWebformShareScript',
        ],
      ],
    ];
  }

  /**
   * Webform share iframe element pre render callback.
   */
  public static function preRenderWebformShareScript($element) {

    /** @var \Drupal\webform\WebformInterface $webform */
    $webform = $element['#webform'];

    /** @var \Drupal\Core\Entity\EntityInterface $source_entity */
    $source_entity = $element['#source_entity'];
    $route_name = 'entity.webform.share_script';
    $route_parameters = [
      'webform' => $webform
        ->id(),
    ];
    $route_options = QueryStringWebformSourceEntity::getRouteOptionsQuery($source_entity);

    // Append prepopulate and variant query to route options.
    if ($element['#query']) {
      $route_options += [
        'query' => [],
      ];
      $route_options['query'] += $element['#query'];
    }
    $url = Url::fromRoute($route_name, $route_parameters, $route_options);
    $script = preg_replace('#^https?:#', '', $url
      ->setAbsolute()
      ->toString());
    $element['#script'] = $script;
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public static function trustedCallbacks() {
    return [
      'preRenderWebformShareScript',
    ];
  }

}

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
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.
TrustedCallbackInterface::THROW_EXCEPTION constant Untrusted callbacks throw exceptions.
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION constant Untrusted callbacks trigger silenced E_USER_DEPRECATION errors.
TrustedCallbackInterface::TRIGGER_WARNING constant Untrusted callbacks trigger E_USER_WARNING errors.
WebformShareScript::getInfo public function Returns the element properties for this element. Overrides ElementInterface::getInfo
WebformShareScript::preRenderWebformShareScript public static function Webform share iframe element pre render callback.
WebformShareScript::trustedCallbacks public static function Lists the trusted callbacks provided by the implementing class. Overrides TrustedCallbackInterface::trustedCallbacks