public function PdfBackendInterface::mergeFile in FillPDF 8.4

Same name and namespace in other branches

1. 5.0.x src/Plugin/PdfBackendInterface.php \Drupal\fillpdf\Plugin\PdfBackendInterface::mergeFile()

Populate a PDF file with field data.

Parameters

\Drupal\file\FileInterface $template_file: The PDF template the field values specified in the mapping should be merged into.

\Drupal\fillpdf\FieldMapping[] $field_mappings: An array of FieldMapping objects mapping PDF field keys to the values they should be replaced with. Example:

[
  'Foo' => new TextFieldMapping('bar'),
  'Foo2' => new TextFieldMapping('bar2'),
  'Image1' => new ImageFieldMapping(base64_encode(file_get_contents($image)), 'jpg'),
];

array $context: The request context as returned by FillPdfLinkManipulator::parseLink().

Return value

string|null The raw file contents of the new PDF, or NULL if merging failed. The caller has to handle saving or serving the file accordingly.

See also

\Drupal\fillpdf\Plugin\PdfBackendInterface::mergeStream()

4 methods override PdfBackendInterface::mergeFile()

FillPdfServicePdfBackend::mergeFile in src/Plugin/PdfBackend/FillPdfServicePdfBackend.php

Populate a PDF file with field data.

LegacyProviderPdfBackend::mergeFile in modules/fillpdf_legacy/src/Plugin/PdfBackend/LegacyProviderPdfBackend.php

Populate a PDF file with field data.

LocalServerPdfBackend::mergeFile in src/Plugin/PdfBackend/LocalServerPdfBackend.php

Populate a PDF file with field data.

PdftkPdfBackend::mergeFile in src/Plugin/PdfBackend/PdftkPdfBackend.php

Populate a PDF file with field data.

File

src/Plugin/PdfBackendInterface.php, line 73

Class

PdfBackendInterface

Defines an interface for FillPDF PdfBackend plugins.

Namespace

Drupal\fillpdf\Plugin

Code

public function mergeFile(FileInterface $template_file, array $field_mappings, array $context);