abstract class WebformAttachmentBase in Webform 8.5
Same name in this branch
- 8.5 modules/webform_attachment/src/Element/WebformAttachmentBase.php \Drupal\webform_attachment\Element\WebformAttachmentBase
- 8.5 modules/webform_attachment/src/Plugin/WebformElement/WebformAttachmentBase.php \Drupal\webform_attachment\Plugin\WebformElement\WebformAttachmentBase
Same name and namespace in other branches
- 6.x modules/webform_attachment/src/Element/WebformAttachmentBase.php \Drupal\webform_attachment\Element\WebformAttachmentBase
Provides a base class for 'webform_attachment' elements.
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_attachment\Element\WebformAttachmentBase implements WebformAttachmentInterface
- class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of WebformAttachmentBase
1 file declares its use of WebformAttachmentBase
- WebformEntityPrintAttachment.php in modules/
webform_entity_print_attachment/ src/ Element/ WebformEntityPrintAttachment.php
File
- modules/
webform_attachment/ src/ Element/ WebformAttachmentBase.php, line 14
Namespace
Drupal\webform_attachment\ElementView source
abstract class WebformAttachmentBase extends RenderElement implements WebformAttachmentInterface {
/**
* {@inheritdoc}
*/
public function getInfo() {
$class = get_class($this);
return [
'#filename' => '',
'#sanitize' => FALSE,
'#link_title' => '',
'#download' => FALSE,
'#trim' => FALSE,
'#process' => [
[
$class,
'processWebformAttachment',
],
[
$class,
'processAjaxForm',
],
],
'#theme_wrappers' => [
'form_element',
],
];
}
/**
* Processes a 'webform_attachment' element.
*/
public static function processWebformAttachment(&$element, FormStateInterface $form_state, &$complete_form) {
$form_object = $form_state
->getFormObject();
// Attachments only work for webform submissions.
if (!$form_object instanceof WebformSubmissionForm) {
$element['#access'] = FALSE;
return $element;
}
/** @var \Drupal\webform\WebformSubmissionInterface $webform_submission */
$webform_submission = $form_object
->getEntity();
// Attachments only work for completed and saved webform submissions.
if (!$webform_submission
->id() || !$webform_submission
->isCompleted()) {
$element['#access'] = FALSE;
return $element;
}
// Link to file download.
$element['link'] = static::getFileLink($element, $webform_submission);
return $element;
}
/****************************************************************************/
// File methods.
/****************************************************************************/
/**
* {@inheritdoc}
*/
public static function getFileName(array $element, WebformSubmissionInterface $webform_submission) {
if (!empty($element['#filename'])) {
/** @var \Drupal\webform\WebformTokenManagerInterface $token_manager */
$token_manager = \Drupal::service('webform.token_manager');
$filename = $token_manager
->replace($element['#filename'], $webform_submission);
// Remove forward slashes from filename to prevent the below error.
//
// Parameter "filename" for route
// "entity.webform.user.submission.attachment" must match "[^/]++".
$filename = str_replace('/', '', $filename);
// Sanitize filename.
// @see http://stackoverflow.com/questions/2021624/string-sanitizer-for-filename
// @see \Drupal\webform\Plugin\WebformElement\WebformManagedFileBase::getFileDestinationUri
if (!empty($element['#sanitize'])) {
/** @var \Drupal\Component\Transliteration\TransliterationInterface $transliteration */
$transliteration = \Drupal::service('transliteration');
/** @var \Drupal\Core\Language\LanguageManagerInterface $language_manager */
$language_manager = \Drupal::service('language_manager');
$langcode = $language_manager
->getCurrentLanguage()
->getId();
$extension = pathinfo($filename, PATHINFO_EXTENSION);
$basename = substr(pathinfo($filename, PATHINFO_BASENAME), 0, -strlen(".{$extension}"));
$basename = mb_strtolower($basename);
$basename = $transliteration
->transliterate($basename, $langcode, '-');
$basename = preg_replace('([^\\w\\s\\d\\-_~,;:\\[\\]\\(\\].]|[\\.]{2,})', '', $basename);
$basename = preg_replace('/\\s+/', '-', $basename);
$basename = trim($basename, '-');
$filename = $basename . '.' . $extension;
}
return $filename;
}
else {
return $element['#webform_key'] . '.txt';
}
}
/**
* {@inheritdoc}
*/
public static function getFileMimeType(array $element, WebformSubmissionInterface $webform_submission) {
/** @var \Symfony\Component\HttpFoundation\File\MimeType\MimeTypeGuesserInterface $file_mime_type_guesser */
$file_mime_type_guesser = \Drupal::service('file.mime_type.guesser');
$file_name = static::getFileName($element, $webform_submission);
return $file_mime_type_guesser
->guess($file_name);
}
/**
* {@inheritdoc}
*/
public static function getFileUrl(array $element, WebformSubmissionInterface $webform_submission) {
if (!$webform_submission
->id()) {
return NULL;
}
$route_name = 'entity.webform.user.submission.attachment';
$route_parameters = [
'webform' => $webform_submission
->getWebform()
->id(),
'webform_submission' => $webform_submission
->id(),
'element' => $element['#webform_key'],
'filename' => static::getFileName($element, $webform_submission),
];
$route_options = [
'absolute' => TRUE,
];
$url = Url::fromRoute($route_name, $route_parameters, $route_options);
return $url;
}
/**
* {@inheritdoc}
*/
public static function getFileLink(array $element, WebformSubmissionInterface $webform_submission) {
$title = !empty($element['#link_title']) ? $element['#link_title'] : static::getFileName($element, $webform_submission);
$url = static::getFileUrl($element, $webform_submission);
return [
'#type' => 'link',
'#title' => $title,
'#url' => $url,
];
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
PluginBase:: |
public | function | Constructs a \Drupal\Component\Plugin\PluginBase object. | 92 |
RenderElement:: |
public static | function | Adds Ajax information about an element to communicate with JavaScript. | |
RenderElement:: |
public static | function | Adds members of this group as actual elements for rendering. | |
RenderElement:: |
public static | function | Form element processing handler for the #ajax form property. | 1 |
RenderElement:: |
public static | function | Arranges elements into groups. | |
RenderElement:: |
public static | function |
Sets a form element's class attribute. Overrides ElementInterface:: |
|
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
WebformAttachmentBase:: |
public static | function |
Get a webform attachment's file link. Overrides WebformAttachmentInterface:: |
|
WebformAttachmentBase:: |
public static | function |
Get a webform attachment's file type. Overrides WebformAttachmentInterface:: |
|
WebformAttachmentBase:: |
public static | function |
Get a webform attachment's file name. Overrides WebformAttachmentInterface:: |
2 |
WebformAttachmentBase:: |
public static | function |
Get a webform attachment's download URL. Overrides WebformAttachmentInterface:: |
|
WebformAttachmentBase:: |
public | function |
Returns the element properties for this element. Overrides ElementInterface:: |
4 |
WebformAttachmentBase:: |
public static | function | Processes a 'webform_attachment' element. | |
WebformAttachmentInterface:: |
public static | function | Get a webform attachment's file content. | 4 |