pdx:encryptPDF Encrypts a PDF file

pdx:encryptPDF

Encrypts a PDF file.

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 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 we want to encrypt.

target

Path to the resulting encrypted PDFdocument.

options

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

key	Description
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="xmldocx" pdx:src="/var/www/xmldocx/samples/files/Test.pdf" pdx:target="/var/www/xmldocx/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>

import os as os
import sys as sys
sys.path.append(os.path.abspath("wrappers/python/XmlDocx"))
import XmlDocx as XmlDocx
document = XmlDocx.XmlDocx("config.xml")
document.setDocumentProperties("settings.xml")
document.addContent("content.xml")
document.setXmlDocxPath("xmldocx path")
document.render()

The resulting Word document looks like: