You are here

class WebformAttachmentUrl in Webform 8.5

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

Provides a 'webform_attachment_url' element.

Plugin annotation

@FormElement("webform_attachment_url");

Hierarchy

Expanded class hierarchy of WebformAttachmentUrl

File

modules/webform_attachment/src/Element/WebformAttachmentUrl.php, line 13

Namespace

Drupal\webform_attachment\Element
View source
class WebformAttachmentUrl extends WebformAttachmentBase {

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

  /**
   * {@inheritdoc}
   */
  public static function getFileContent(array $element, WebformSubmissionInterface $webform_submission) {
    try {
      $url = $element['#url'];

      // URL can contain tokens.

      /** @var \Drupal\webform\WebformTokenManagerInterface $token_manager */
      $token_manager = \Drupal::service('webform.token_manager');
      $url = $token_manager
        ->replace($url, $webform_submission);

      // Url can be a URI.
      $url = file_create_url($url) ?: $url;

      // Prepend scheme and host to root relative path.
      if (strpos($url, '/') === 0) {
        $url = \Drupal::request()
          ->getSchemeAndHttpHost() . $url;
      }
      $content = (string) \Drupal::httpClient()
        ->get($url)
        ->getBody();
    } catch (RequestException $exception) {
      $content = '';
    }
    return !empty($element['#trim']) ? trim($content) : $content;
  }

  /**
   * {@inheritdoc}
   */
  public static function getFileName(array $element, WebformSubmissionInterface $webform_submission) {
    if (!isset($element['#filename']) && !empty($element['#url'])) {

      /** @var \Drupal\webform\WebformTokenManagerInterface $token_manager */
      $token_manager = \Drupal::service('webform.token_manager');
      $url = $token_manager
        ->replace($element['#url'], $webform_submission);
      return basename($url);
    }
    else {
      return parent::getFileName($element, $webform_submission);
    }
  }

}

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
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.
WebformAttachmentBase::getFileLink public static function Get a webform attachment's file link. Overrides WebformAttachmentInterface::getFileLink
WebformAttachmentBase::getFileMimeType public static function Get a webform attachment's file type. Overrides WebformAttachmentInterface::getFileMimeType
WebformAttachmentBase::getFileUrl public static function Get a webform attachment's download URL. Overrides WebformAttachmentInterface::getFileUrl
WebformAttachmentBase::processWebformAttachment public static function Processes a 'webform_attachment' element.
WebformAttachmentUrl::getFileContent public static function Get a webform attachment's file content. Overrides WebformAttachmentInterface::getFileContent
WebformAttachmentUrl::getFileName public static function Get a webform attachment's file name. Overrides WebformAttachmentBase::getFileName
WebformAttachmentUrl::getInfo public function Returns the element properties for this element. Overrides WebformAttachmentBase::getInfo