You are here

class WebformShareIframe in Webform 6.x

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

Provides a render element that createa an iframe to share a webform.

Plugin annotation

@RenderElement("webform_share_iframe");

Hierarchy

Expanded class hierarchy of WebformShareIframe

2 files declare their use of WebformShareIframe
WebformShareTest.php in modules/webform_share/tests/src/Functional/WebformShareTest.php
WebformShareVariantTest.php in modules/webform_share/tests/src/Functional/WebformShareVariantTest.php
3 #type uses of WebformShareIframe
WebformShareController::preview in modules/webform_share/src/Controller/WebformShareController.php
Returns a preview of a webform to be shared.
WebformShareController::script in modules/webform_share/src/Controller/WebformShareController.php
Returns a webform to be shared using (java)script.
WebformShareController::test in modules/webform_share/src/Controller/WebformShareController.php
Returns a test of a webform to be shared.

File

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

Namespace

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

  /**
   * The JavaScript iframe library.
   */
  const LIBRARY = 'iframe-resizer';

  /**
   * The JavaScript iframe library version.
   */
  const VERSION = '4.2.10';

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = get_class($this);
    return [
      '#webform' => NULL,
      '#source_entity' => NULL,
      '#javascript' => FALSE,
      '#script' => '//cdn.jsdelivr.net/gh/davidjbradshaw/iframe-resizer@' . static::VERSION . '/js/iframeResizer.min.js',
      '#query' => [],
      '#options' => [],
      '#test' => [],
      '#theme' => 'webform_share_iframe',
      '#pre_render' => [
        [
          $class,
          'preRenderWebformShareIframe',
        ],
      ],
    ];
  }

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

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

    /** @var \Drupal\Core\Entity\EntityInterface $source_entity */
    $source_entity = $element['#source_entity'];

    // Get iframe src route information and attributes.
    if ($element['#javascript']) {

      // Set JavaScript iframe.
      // @see https://github.com/davidjbradshaw/iframe-resizer
      $route_name = 'entity.webform.share_page.javascript';
      $route_parameters = [
        'webform' => $webform
          ->id(),
        'library' => static::LIBRARY,
        'version' => static::VERSION,
      ];
      $attributes = [
        'style' => 'width:1px;min-width:100%',
      ];
    }
    else {

      // Set static iframe.
      $route_name = 'entity.webform.share_page';
      $route_parameters = [
        'webform' => $webform
          ->id(),
      ];
      $attributes = [
        'style' => 'width:100%;height:600px;border:none',
      ];
    }
    $route_options = QueryStringWebformSourceEntity::getRouteOptionsQuery($source_entity);
    $route_options += [
      'query' => [],
    ];

    // Append prepopulate and variant query to route options.
    if ($element['#query']) {
      $route_options['query'] += $element['#query'];
    }

    // Append ?_webform_test={webform} to route options.
    if ($element['#test']) {
      $route_options['query']['_webform_test'] = $webform
        ->id();
    }
    if (empty($route_options['query'])) {
      unset($route_options['query']);
    }

    // Get iframe URL.
    $url = Url::fromRoute($route_name, $route_parameters, $route_options);

    // Get iframe src and title.
    $src = preg_replace('#^https?:#', '', $url
      ->setAbsolute()
      ->toString());
    $title = $webform
      ->label() . ' | ' . \Drupal::config('system.site')
      ->get('name');
    $element += [
      '#attributes' => [],
    ];
    $element['#attributes'] += [
      'src' => $src,
      'title' => $title,
      'class' => [],
      'frameborder' => '0',
      'allow' => 'geolocation; microphone; camera',
      'allowtransparency' => 'true',
      'allowfullscreen' => 'true',
    ] + $attributes;
    return $element;
  }

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

}

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.
WebformShareIframe::getInfo public function Returns the element properties for this element. Overrides ElementInterface::getInfo
WebformShareIframe::LIBRARY constant The JavaScript iframe library.
WebformShareIframe::preRenderWebformShareIframe public static function Webform share iframe element pre render callback.
WebformShareIframe::trustedCallbacks public static function Lists the trusted callbacks provided by the implementing class. Overrides TrustedCallbackInterface::trustedCallbacks
WebformShareIframe::VERSION constant The JavaScript iframe library version.