XML API - pdx:encryptPDF

LAYOUT & GENERAL

WORD CONTENT

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

DOCXPATHUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

CRYPTOPHPDOCX

DIGITAL SIGNATURE

pdx:encryptPDF

Encrypts a PDF file.

Note

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

Description

Element definition

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

This element allows to encrypt a PDF file. The final user will be prompted to introduce the password included in the $options array to access the contents of the resulting PDF file.

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 PDF document that you want to encrypt.

target

Path to the resulting encrypted PDF document.

options

The possible keys and values are (required options are shown with red background):

Key	Description
annotations	Import annotations (links, comments and others).
password	String of 15 or less characters.
mode	0, RSA 40 bit; 1, RSA 128 bit; 2, AES 128 bit; 3, AES 256 bit Optional default 0

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="pdf" />
        <pdx:crypto>
            <pdx:encrypt pdx:password="phpdocx" pdx:src="/var/www/phpdocx/samples/files/Test.pdf" pdx:target="/var/www/phpdocx/samples/Crypto/encryptPdf/Crypted.pdf" />
        </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: