transformDocument

transformDocument

ADVANCED / PREMIUM BASIC

Transforms documents into other formats (DOCX, PDF, (X)HTML, DOC, RTF, PNG, TXT).

Description
public transformDocument (string $source, string $target [, string $method [, array $options]])

This method allows to transform a document, generated or not with phpdocx, into DOCX, PDF, HTML, DOC, ODT, RTF, PNG and TXT preserving, as much as possible, the original formatting options.

You may find more info regarding this method in the Conversion plugin section.

Due to format limitations, the PNG transformation only generates the first page of the document.

Parameters

source

Path to the DOCX that you want to convert to a different format.

target

Path to the resulting transformed document (PDF, HTML, XHTML, DOCX, DOC, ODT, RTF, PNG or TXT).

method

Method used to transform the document: 'native', 'libreoffice', 'msword', 'openoffice'

'native' method options

The possible keys and values are:

Key Type Description
stream bool False as default. If true, returns the document as stream.

'libreoffice' method options

The possible keys and values are:

Key Type Description
comments bool False by default. Export comments
debug bool False by default. Returns debug information about the conversion plugin.
formsfields bool False by default. Export form fields.
formsfields bool False by default. Lossless compression.
homeFolder string Set a custom home folder to be used for the conversions.
outdir string Set the outdir path. Useful when the PDF output path is not the same than the running script.
pdfa1 bool False by default. Generate PDF/A-1 document.
toc bool False by default. If true updates the TOC before transforming the document.

'msword' method options

The possible keys and values are:

Key Type Description
selectedContent string Scope: 'active' (default) or 'documents'.
toc bool False by default. If true updates the TOC before transforming the document.

'openoffice' method options

The possible keys and values are:

Key Type Description
debug bool False by default. Returns debug information about the conversion plugin.
homeFolder string Set a custom home folder to be used for the conversions.
odfconverter bool True by default. If set to false the conversion plugin does not use ODFConverter package. This may give better results in some cases.
tempDir string Set a custom temp folder to be used for the conversions.
version string 32-bit or 64-bit architecture. 32, 64 or null (default). If null autodetect.
Code samples

Example #1

The resulting Word document looks like:

Example #2

The resulting Word document looks like: