XML API - pdx:encryptDocx

LAYOUT & GENERAL

WORD CONTENT

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

DOCXPATHUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

CRYPTOPHPDOCX

DIGITAL SIGNATURE

pdx:encryptDocx

Encrypts (AES128) a Word document.

Note

You are reading the XML API documentation. For the PHP API method please go to encryptDocx.

Description

Element definition

<pdx:config>
    <pdx:crypto>
        <pdx:encrypt pdx:password="" pdx:src="" pdx:target="" />
    </pdx:crypto>
</pdx:config>

This element allows to encrypt a Word document. The final user needs to insert the password included in the options array to access the content of the resulting file.

The encrypted file is a Microsoft Binary Compound File that is directly recognized as an encrypted Word document by the standard Word interface.

You may find a detailed description of this package in the cryptophpdocx section of the API documentation.

Attributes and sub-elements

src

Path to the word document that you want to encrypt.

target

Path to the resulting encrypted document.

Key	Description
password	The password should be a string of 15 or less characters. If you introduce a password with more than 15 characters it will be automatically truncated.

Code samples

Example #1

config.xml

<?xml version="1.0" encoding="UTF-8"?>
<pdx:document xmlns:pdx="http://www.phpdocx.com/main">
    <pdx:config>
        <pdx:output pdx:name="output" pdx:type="docx" />
        <pdx:crypto>
            <pdx:encrypt pdx:password="phpdocx" pdx:src="/var/www/phpdocx/samples/files/Text.docx" pdx:target="/var/www/phpdocx/samples/Crypto/encryptDocx/Crypted.docx" />
        </pdx:crypto>
    </pdx:config>
</pdx:document>

content.xml

<?xml version="1.0" encoding="UTF-8"?>
<pdx:document xmlns:pdx="http://www.phpdocx.com/main">
    <pdx:content>
    </pdx:content>
</pdx:document>

settings.xml

<?xml version="1.0" encoding="UTF-8"?>
<pdx:document xmlns:pdx="http://www.phpdocx.com/main">
    <pdx:settings>
    </pdx:settings>
</pdx:document>

PHP code

require_once 'path_to_phpdocx/classes/CreateDocx.php';

$docx = new XMLAPI('config.xml');
$docx->setDocumentProperties('settings.xml');
$docx->addContent('content.xml');

$docx->render();

The resulting Word document looks like: