API Documentation

Download PHPDocX

download PhpDocX

Choose the version that better suits your needs

Click here

ON DEMAND

On demand

Do you have
special needs?

You may ask here for a quote

Support

Support

Do you need technical support?

We can help

addTemplate

Allows to use a predefined Word document template.

PRO, PRO+ and CORPORATE PHPDocX >= 1.7

report a bug

Description

public addTemplate ( string $filePath )

This method allows the user to build a Word document up from an existing template, something particularly useful when only a few elements have to be generated dinamically.

With the help of PHPDocX placeholder variables you may, among other posibilities, insert:

  • text, charts and images,
  • HTML with images and its associated CSS styles,
  • full documents like other Word, RTF and MHT files,
  • indefinite numbers of rows in cells or items in lists as well as
  • replace existing placeholder images.

In order to harness the full potential of this and related methods we recommend you to visit our PHPDocX tutorial.

report a bug

Parameters

filePath

Path to the document that we will use as a Word template. This document should have the .docx extension.

report a bug

Return values

Void.

report a bug

Code samples

Example #1: adds a template and returns it without modifying it


require_once 'classes/CreateDocx.inc';

$docx = new CreateDocx();

$docx->addTemplate('TemplateText.docx');
$docx->createDocx('template_text.docx');

The resulting Word document looks like (download .docx file):

Change log

  • Available since 1.7

Available examples

See also