managed_file_file.txt',
'File (Link)' => '
managed_file_link.txt',
'File (File ID)' => $submission->getElementData('managed_file_id'),
'File (File name)' => 'managed_file_name.txt',
'File (File base name (no extension))' => 'managed_file_basename',
'File (File extension)' => 'txt',
'File (URL)' => $this->getSubmissionFileUrl($submission, 'managed_file_url'),
];
foreach ($elements as $label => $value) {
$this->assertStringContainsString('
' . $label . '' . $value, $body, new FormattableMarkup('Found @label: @value', ['@label' => $label, '@value' => $value]));
}
// Check managed file element formatted as text.
$body = $this->getMessageBody($submission, 'email_text');
$elements = [
'File (Value): ' . $this->getSubmissionFileUrl($submission, 'managed_file_value'),
'File (Raw value): ' . $this->getSubmissionFileUrl($submission, 'managed_file_raw'),
'File (File): ' . $this->getSubmissionFileUrl($submission, 'managed_file_file'),
'File (Link): ' . $this->getSubmissionFileUrl($submission, 'managed_file_link'),
'File (File ID): ' . $submission->getElementData('managed_file_id'),
'File (File name): managed_file_name.txt',
'File (URL): ' . $this->getSubmissionFileUrl($submission, 'managed_file_url'),
'File (File mime type): text/plain',
'File (File size (Bytes)): 43',
'File (File content (Base64)): dGhpcyBpcyBhIHNhbXBsZSB0eHQgZmlsZQppdCBoYXMgdHdvIGxpbmVzCg==',
];
foreach ($elements as $value) {
$this->assertStringContainsString($value, $body, new FormattableMarkup('Found @value', ['@value' => $value]));
}
/* ********************************************************************** */
/* Format multiple element as HTML and text */
/* ********************************************************************** */
/** @var \Drupal\webform\WebformInterface $webforms */
$webforms = Webform::load('test_element_format_multiple');
$sid = $this->postSubmission($webforms);
$webforms_submission = WebformSubmission::load($sid);
// Check elements (single) item formatted as HTML.
$body = $this->getMessageBody($webforms_submission, 'email_html');
// cspell:disable
$elements = [
'Text field (Comma)' => 'Loremipsum, Oratione, Dixisset',
'Text field (Semicolon)' => 'Loremipsum; Oratione; Dixisset',
'Text field (And)' => 'Loremipsum, Oratione, and Dixisset',
'Text field (Ordered list)' => '
- Loremipsum
- Oratione
- Dixisset
',
'Text field (Unordered list)' => '
- Loremipsum
- Oratione
- Dixisset
',
'Checkboxes (Comma)' => 'One, Two, Three',
'Checkboxes (Semicolon)' => 'One; Two; Three',
'Checkboxes (And)' => 'One, Two, and Three',
'Checkboxes (Ordered list)' => '
- One
- Two
- Three
',
'Checkboxes (Unordered list)' => '
',
'Checkboxes (Checklist (☑/☐))' => '
☑ One
☑ Two
☑ Three
',
];
// cspell:enable
foreach ($elements as $label => $value) {
$this->assertStringContainsString('
' . $label . '' . $value, $body, new FormattableMarkup('Found @label: @value', [
'@label' => $label,
'@value' => $value,
]));
}
// Check elements formatted as text.
$body = $this->getMessageBody($webforms_submission, 'email_text');
$elements = [
'Text field (Comma): Loremipsum, Oratione, Dixisset',
'Text field (Semicolon): Loremipsum; Oratione; Dixisset',
'Text field (And): Loremipsum, Oratione, and Dixisset',
'Text field (Ordered list):
1. Loremipsum
2. Oratione
3. Dixisset',
'Text field (Unordered list):
- Loremipsum
- Oratione
- Dixisset',
'Checkboxes (Comma): One, Two, Three',
'Checkboxes (Semicolon): One; Two; Three',
'Checkboxes (And): One, Two, and Three',
'Checkboxes (Ordered list):
1. One
2. Two
3. Three',
'Checkboxes (Unordered list):
- One
- Two
- Three',
'Checkboxes (Checklist (☑/☐)):
☑ One
☑ Two
☑ Three',
];
foreach ($elements as $value) {
$this->assertStringContainsString($value, $body, new FormattableMarkup('Found @value', ['@value' => $value]));
}
/* ********************************************************************** */
/* Format element using tokens */
/* ********************************************************************** */
/** @var \Drupal\webform\WebformInterface $webform_format_token */
$webform_format_token = Webform::load('test_element_format_token');
$sid = $this->postSubmission($webform_format_token);
$webform_format_token_submission = WebformSubmission::load($sid);
// Check elements tokens formatted as HTML.
$body = $this->getMessageBody($webform_format_token_submission, 'email_html');
$elements = [
'default:' => 'one, two, three',
'comma:' => 'one, two, three',
'semicolon:' => 'one; two; three',
'and:' => 'one, two, and three',
'ul:' => '
',
'ol:' => '
- one
- two
- three
',
'raw:' => '1, 2, 3',
];
foreach ($elements as $label => $value) {
$this->assertStringContainsString('
' . $label . '
' . $value . '
', $body, new FormattableMarkup('Found @label: @value', [
'@label' => $label,
'@value' => $value,
]));
}
// Check elements tokens formatted as text.
$body = $this->getMessageBody($webform_format_token_submission, 'email_text');
$elements = [
"default:\none, two, three",
"comma:\none, two, three",
"semicolon:\none; two; three",
"and:\none, two, and three",
"ul:\n- one\n- two\n- three",
"ol:\n1. one\n2. two\n3. three",
"raw:\n1, 2, 3",
];
foreach ($elements as $value) {
$this->assertStringContainsString($value, $body, new FormattableMarkup('Found @value', ['@value' => $value]));
}
// Check that the element edit form uses the default format.
$this->drupalGet('/admin/structure/webform/manage/test_element_format_token/element/checkboxes/edit');
$assert_session->fieldValueEquals('properties[format]', 'value');
$assert_session->fieldValueEquals('properties[format_items]', 'comma');
// Check element default format item global setting.
\Drupal::configFactory()->getEditable('webform.settings')
->set('format.checkboxes.item', 'raw')
->save();
$body = $this->getMessageBody($webform_format_token_submission, 'email_text');
$this->assertStringContainsString("default:\n1, 2, 3", $body);
// Check element default format items global setting.
\Drupal::configFactory()->getEditable('webform.settings')
->set('format.checkboxes.items', 'and')
->save();
$body = $this->getMessageBody($webform_format_token_submission, 'email_text');
$this->assertStringContainsString("default:\n1, 2, and 3", $body);
// Check that the element edit form uses the overridden default format.
$this->drupalGet('/admin/structure/webform/manage/test_element_format_token/element/checkboxes/edit');
$assert_session->fieldValueEquals('properties[format]', 'raw');
$assert_session->fieldValueEquals('properties[format_items]', 'and');
}
/**
* Get webform email message body for a webform submission.
*
* @param \Drupal\webform\WebformSubmissionInterface $submission
* A webform submission.
* @param string $handler_id
* The webform email handler id.
*
* @return string
* The webform email message body for a webform submission.
*/
protected function getMessageBody(WebformSubmissionInterface $submission, $handler_id = 'email_html') {
/** @var \Drupal\webform\Plugin\WebformHandlerMessageInterface $message_handler */
$message_handler = $submission->getWebform()->getHandler($handler_id);
$message = $message_handler->getMessage($submission);
$body = (string) $message['body'];
$this->verbose($body);
return $body;
}
/**
* Get submission element's file URL.
*
* @param \Drupal\webform\WebformSubmissionInterface $submission
* A webform submission.
* @param string $element_key
* The element key.
* @param bool $relative
* Whether to return a relative. Used for testing on Drupal 9.3 due to
* https://www.drupal.org/node/3223515.
*
* @return string
* A submission element's file URL.
*/
protected function getSubmissionFileUrl(WebformSubmissionInterface $submission, $element_key, $relative = FALSE) {
$fid = $submission->getElementData($element_key);
$file = File::load($fid);
return $file->createFileUrl($relative);
}
}