XML API - pdx:protectPDF

LAYOUT & GENERAL

WORD CONTENT

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

DOCXPATHUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

CRYPTOPHPDOCX

DIGITAL SIGNATURE

pdx:protectPDF

Password protects the contents of a PDF document.

Note

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

Description

Element definition

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

This element allows to password protect a PDF document. One may protect the PDF from being printed, copied, etcetera

Notice that this element does not encrypt the contents of the PDF document. This element is not secure and can be easily overridden by an experienced user.

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 you want to protect.

target

Path to the resulting protected PDF document.

password

The password.

options

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

Key	Description
annotations	Import annotations (links, comments and others). False as default.
permissionsBlocked	print modify copy annot-forms fill-forms extract assemble print-high
passwordOwner	String to allow full access to the PDF file.

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:protect pdx:password="phpdocx" pdx:src="/var/www/phpdocx/samples/files/Test.pdf" pdx:target="/var/www/phpdocx/samples/Crypto/protectPdf/Protected.pdf" pdx:type="print,annot-forms" />
        </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();