Skip to content

Made digital signature text placement on attachment configurable #306

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jekuaitk wants to merge 3 commits into
base: develop
Choose a base branch
from
+62 −13
Open

Made digital signature text placement on attachment configurable #306

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7fb5332
Made digital signature text placement on attachment configurable
jekuaitk Feb 19, 2026
96c578c
Comment and CHANGELOG
jekuaitk Feb 19, 2026
f972417
Use constants
jekuaitk Feb 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ before starting to add changes. Use example [placed in the end of the page](#exa

## [Unreleased]

- [PR-306](https://github.com/OS2Forms/os2forms/pull/306)
Made digital signature text placement configurable.

## [5.0.0] 2025-11-18

- [PR-192](https://github.com/OS2Forms/os2forms/pull/192)
Expand Down
5 changes: 4 additions & 1 deletion modules/os2forms_attachment/src/Element/AttachmentElement.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

namespace Drupal\os2forms_attachment\Element;

use Drupal\os2forms_attachment\Os2formsAttachmentPrintBuilder;
use Drupal\webform\Entity\WebformSubmission;
use Drupal\webform\WebformSubmissionInterface;
use Drupal\webform_attachment\Element\WebformAttachmentBase;
Expand All @@ -21,6 +22,7 @@ public function getInfo() {
'#view_mode' => 'html',
'#export_type' => 'pdf',
'#digital_signature' => FALSE,
'#digital_signature_position' => Os2formsAttachmentPrintBuilder::SIGNATURE_POSITION_AFTER_CONTENT,
'#template' => '',
];
}
Expand Down Expand Up @@ -77,7 +79,8 @@ public static function getFileContent(array $element, WebformSubmissionInterface

// Adding digital signature.
if (isset($element['#digital_signature']) && $element['#digital_signature']) {
$file_path = $print_builder->savePrintableDigitalSignature([$webform_submission], $print_engine, $scheme, $file_name);
$signaturePosition = $element['#digital_signature_position'] ?? Os2formsAttachmentPrintBuilder::SIGNATURE_POSITION_AFTER_CONTENT;
$file_path = $print_builder->savePrintableDigitalSignature([$webform_submission], $print_engine, $scheme, $file_name, TRUE, $signaturePosition);
}
else {
$file_path = $print_builder->savePrintable([$webform_submission], $print_engine, $scheme, $file_name);
Expand Down
48 changes: 36 additions & 12 deletions modules/os2forms_attachment/src/Os2formsAttachmentPrintBuilder.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,11 @@
*/
class Os2formsAttachmentPrintBuilder extends PrintBuilder {

public const SIGNATURE_POSITION_FOOTER = 'footer';
public const SIGNATURE_POSITION_HEADER = 'header';
public const SIGNATURE_POSITION_AFTER_CONTENT = 'after_content';
public const SIGNATURE_POSITION_BEFORE_CONTENT = 'before_content';

/**
* {@inheritdoc}
*/
Expand All @@ -44,16 +49,16 @@ public function printHtml(EntityInterface $entity, $use_default_css = TRUE, $opt
/**
* Modified version of the original savePrintable() function.
*
* The only difference is modified call to prepareRenderer with digitalPost
* flag TRUE.
* The only difference is modified call to prepareRenderer with a
* signature position parameter.
*
* @see PrintBuilder::savePrintable()
*
* @return string
* FALSE or the URI to the file. E.g. public://my-file.pdf.
*/
public function savePrintableDigitalSignature(array $entities, PrintEngineInterface $print_engine, $scheme = 'public', $filename = FALSE, $use_default_css = TRUE) {
$renderer = $this->prepareRenderer($entities, $print_engine, $use_default_css, TRUE);
public function savePrintableDigitalSignature(array $entities, PrintEngineInterface $print_engine, $scheme = 'public', $filename = FALSE, $use_default_css = TRUE, string $signaturePosition = self::SIGNATURE_POSITION_AFTER_CONTENT) {
$renderer = $this->prepareRenderer($entities, $print_engine, $use_default_css, $signaturePosition);

// Allow other modules to alter the generated Print object.
$this->dispatcher->dispatch(new PreSendPrintEvent($print_engine, $entities), PrintEvents::PRE_SEND);
Expand Down Expand Up @@ -82,15 +87,16 @@ public function savePrintableDigitalSignature(array $entities, PrintEngineInterf
* The print engine.
* @param bool $use_default_css
* TRUE if we want the default CSS included.
* @param bool $digitalSignature
* If the digital signature message needs to be added.
* @param string $signaturePosition
* The position for the digital signature validation text. Empty string
* means no signature. Use the SIGNATURE_POSITION_* class constants.
*
* @return \Drupal\entity_print\Renderer\RendererInterface
* A print renderer.
*
* @see PrintBuilder::prepareRenderer
*/
protected function prepareRenderer(array $entities, PrintEngineInterface $print_engine, $use_default_css, $digitalSignature = FALSE) {
protected function prepareRenderer(array $entities, PrintEngineInterface $print_engine, $use_default_css, string $signaturePosition = '') {
if (empty($entities)) {
throw new \InvalidArgumentException('You must pass at least 1 entity');
}
Expand All @@ -106,12 +112,30 @@ protected function prepareRenderer(array $entities, PrintEngineInterface $print_
'#attached' => [],
];

// Adding hardcoded negative margin to avoid margins in <fieldset> <legend>
// structure. That margin is automatically added in PDF and PDF only.
$generatedHtml = (string) $renderer->generateHtml($entities, $render, $use_default_css, TRUE);
$generatedHtml .= "<style>fieldset legend {margin-left: -12px;}</style>";
if ($digitalSignature) {
$generatedHtml .= $this->t('You can validate the signature on this PDF file via validering.nemlog-in.dk.');

// Place signature according to the passed parameter.
if ($signaturePosition) {
$signatureHtml = '<div class="validate-signature-element"><p>' . $this->t('You can validate the signature on this PDF file via validering.nemlog-in.dk.') . '</p></div>';

switch ($signaturePosition) {
case self::SIGNATURE_POSITION_HEADER:
$generatedHtml = str_replace('</header>', $signatureHtml . '</header>', $generatedHtml);
break;

case self::SIGNATURE_POSITION_BEFORE_CONTENT:
$generatedHtml = str_replace('<div class="page">', '<div class="page">' . $signatureHtml, $generatedHtml);
break;

case self::SIGNATURE_POSITION_FOOTER:
$generatedHtml = str_replace('</footer>', $signatureHtml . '</footer>', $generatedHtml);
break;

case self::SIGNATURE_POSITION_AFTER_CONTENT:
default:
$generatedHtml = str_replace('</body>', $signatureHtml . '</body>', $generatedHtml);
break;
}
}

$print_engine->addPage($generatedHtml);
Expand Down
19 changes: 19 additions & 0 deletions modules/os2forms_attachment/src/Plugin/WebformElement/AttachmentElement.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
use Drupal\Core\Form\FormStateInterface;
use Drupal\webform\Twig\WebformTwigExtension;
use Drupal\webform\Utility\WebformElementHelper;
use Drupal\os2forms_attachment\Os2formsAttachmentPrintBuilder;
use Drupal\webform_attachment\Plugin\WebformElement\WebformAttachmentBase;

/**
Expand All @@ -28,6 +29,7 @@ protected function defineDefaultProperties() {
'template' => '',
'export_type' => '',
'digital_signature' => '',
'digital_signature_position' => Os2formsAttachmentPrintBuilder::SIGNATURE_POSITION_AFTER_CONTENT,
'exclude_empty' => '',
'exclude_empty_checkbox' => '',
'excluded_elements' => '',
Expand Down Expand Up @@ -93,6 +95,23 @@ public function form(array $form, FormStateInterface $form_state) {
'#type' => 'checkbox',
'#title' => $this->t('Digital signature'),
];
$form['attachment']['digital_signature_position'] = [
'#type' => 'select',
'#title' => $this->t('Digital signature position'),
'#description' => $this->t('Select where the digital signature validation text should be placed in the PDF document.'),
'#options' => [
Os2formsAttachmentPrintBuilder::SIGNATURE_POSITION_FOOTER => $this->t('Footer (repeats on every page)'),
Os2formsAttachmentPrintBuilder::SIGNATURE_POSITION_HEADER => $this->t('Header (repeats on every page)'),
Os2formsAttachmentPrintBuilder::SIGNATURE_POSITION_AFTER_CONTENT => $this->t('After content (end of document)'),
Os2formsAttachmentPrintBuilder::SIGNATURE_POSITION_BEFORE_CONTENT => $this->t('Before content (start of document)'),
],
'#default_value' => Os2formsAttachmentPrintBuilder::SIGNATURE_POSITION_AFTER_CONTENT,
'#states' => [
'visible' => [
':input[name="properties[digital_signature]"]' => ['checked' => TRUE],
],
],
];

// Set #access so that help is always visible.
WebformElementHelper::setPropertyRecursive($form['attachment']['help'], '#access', TRUE);
Expand Down
Loading