attachFile

WORD CONTENTS

LAYOUT & SETTINGS

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

DOCXPATHUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

PERFORMANCE

BULK PROCESSING

TRACKING

CRYPTOPHPDOCX

DIGITAL SIGNATURE

ARTIFICIAL INTELLIGENCE

XLSXUTILITIES

PPTXUTILITIES

BLOCKCHAIN

VARIANT

attachFile

ADVANCED / PREMIUM

TRIAL

Attaches files into a PDF document.

Description

public attachFile (string $source, string $target, mixed $file, [array $options])

Attaches files into a PDF document.

Parameters

source

Path to the PDF document.

target

Path to the output PDF.

file

string or array. Files to be attached.

options

The possible keys and values are:

key	Type	Description
annotations	bool	Import annotations (links, comments and others). Default as false.
extraXMPRDF	array	useBaseXmpRdf (bool): default as true xmp (string): XMP RDF content
useFixedAnnotationPositions	bool	Force annotation page link IDs. Useful when using PDF readers that don't detect all PDF contents automatically. Default as false.

Exceptions

File doesn't exist.

Code samples

Example #1

require_once 'classes/PdfUtilities.php';

$pdf = new PdfUtilities();
$pdf->attachFile('document.pdf', 'output.pdf', 'file.txt');

Example #2

require_once 'classes/PdfUtilities.php';

$pdf = new PdfUtilities();
$xmpRdf = '<rdf:Description rdf:about="" xmlns:phpdocx="http://phpdocx.com/"><phpdocx:Instructions>OOOInstructions</phpdocx:Instructions><phpdocx:Headline>OOOHeadline</phpdocx:Headline></rdf:Description>';
$pdf->attachFile('document.pdf', 'output.pdf', 'file.txt', array('extraXMPRDF' => array('xmp' => $xmpRdf)));

Release notes

phpdocx 16.0:
- new method.