PhpRiot
Become Zend Certified

Prepare for the ZCE exam using our quizzes (web or iPad/iPhone). More info...


When you're ready get 7.5% off your exam voucher using voucher CJQNOV23 at the Zend Store

Introduction to LiveDocx

LiveDocx is a SOAP service that allows developers to generate word processing documents by combining structured data from PHP with a template, created in a word processor. The resulting document can be saved as a PDF, DOCX, DOC, HTML or RTF file. LiveDocx implements mail-merge in PHP.

The family of Zend_Service_LiveDocx components provides a clean and simple interface to the LiveDocx API and additionally offers functionality to improve network performance.

In addition to this section of the manual, if you are interested in learning more about Zend_Service_LiveDocx and the backend SOAP service LiveDocx, please take a look at the following resources:

Sign Up for an Account

Before you can start using LiveDocx, you must first sign up for an account. The account is completely free of charge and you only need to specify a username, password and e-mail address. Your login credentials will be dispatched to the e-mail address you supply, so please type carefully.

Templates and Documents

LiveDocx differentiates between the following terms: 1) template and 2) document. In order to fully understand the documentation and indeed the actual API, it is important that any programmer deploying LiveDocx understands the difference.

The term template is used to refer to the input file, created in a word processor, containing formatting and text fields. You can download an example template, stored as a DOCX file. The term document is used to refer to the output file that contains the template file, populated with data - i.e. the finished document. You can download an example document, stored as a PDF file.

Supported File Formats

LiveDocx supports the following file formats:

Template File Formats (input)

Templates can be saved in any of the following file formats:

  • DOCX - Office Open XML format

  • DOC - Microsoft Word DOC format

  • RTF - Rich text file format

  • TXD - TX Text Control format

Document File Formats (output):

The resulting document can be saved in any of the following file formats:

  • DOCX - Office Open XML format

  • DOC - Microsoft Word DOC format

  • HTML - XHTML 1.0 transitional format

  • RTF - Rich text file format

  • PDF - Acrobat Portable Document Format

  • TXD - TX Text Control format

  • TXT - ANSI plain text

Image File Formats (import):

Images can be merged into templates in any of following file formats:

  • BMP - Bitmap image format

  • GIF - Graphics Interchange Format

  • JPG - Joint Photographic Experts Group format

  • PNG - Portable Network Graphics format

  • TIFF - Tagged Image File Format

Image File Formats (output):

The resulting document can be exported to any of the following graphical file formats:

  • BMP - Bitmap image format

  • GIF - Graphics Interchange Format

  • JPG - Joint Photographic Experts Group format

  • PNG - Portable Network Graphics format

  • TIFF - Tagged Image File Format

  • WMF - Windows Meta File format

Zend Framework