Generate DOCX with fillable forms

The addStructuredDocumentTag method, available in the javadocx API, allows to generate DOCX with forms to be filled by the users.

In case of need of additional protection, javadocx lets also protect these DOCX, so the user can only modify the form fields. The rest of the document would remain locked.

Generating the form

The addStructuredDocumentTag method allows to create five types of fields for the forms: checkboxes, combo boxes, dates, dropdown lists and rich texts.

As an example, let's see how to generate a small survey which the user has to fill with her or his name, email, age and an option with a checkbox: whether she or him has a car. The code is as follows:

<?php

require_once '../../../classes/CreateDocx.php';

$docx = new CreateDocx();

$docx->addText('Please fill the following survey:');

$docx->addText('Name:', array('bold' => true));
$docx->addStructuredDocumentTag('richText', array('placeholderText' => 'Click here to enter your name'));

$docx->addText('E-mail:', array('bold' => true));
$docx->addStructuredDocumentTag('richText', array('placeholderText' => 'Click here to enter your e-mail'));

$docx->addText('Age:', array('bold' => true));
$selectOptions = array(
    'listItems' => array(
        array('21-31', '21-31'),
        array('32-41', '32-41'),
        array('42-51', '42-51'),
        array('52-60', '52-60'),
        array('60+', '60+'),
    ),
    'placeholderText' => 'Choose a value',
);
$docx->addStructuredDocumentTag('comboBox', $selectOptions);

$docx->addText('Do you have a vehicle?:', array('bold' => true));
$docx->addStructuredDocumentTag('checkbox', array('checked' => false));

$docx->createDocx('document');

Reading the information filled in the forms (Advanced and Premium licenses only)

Let's say that you need to parse all the users' information that the document form has gathered. You can do that easily with the DOCXPath class.

The following code returns an array with the values of the form, in the same order in which the fields are placed in the document.

$docx = new CreateDocxFromTemplate('document_protected_filled.docx');

$referenceNode = array(
    'customQuery' => '//w:sdt/w:sdtContent',
);

$contents = $docx->getWordContents($referenceNode);

print_r($contents);

Protecting the document to allow changes only in the document (Premium license only)

Documents created through forms can be modified freely. That is, a user could fill the form just as easily as modifying other document texts.

If you want to protect the document in order to allow only changes in the form while locking the rest of the text, you just have to call this code:

$crypto = new CryptoPHPDOCX();
$crypto->protectDocx('document.docx', 'document_protected.docx', array('password' => 'phpdocx', 'type' => 'forms'));

Cookbook