encryptXLSX

encryptXLSX

PREMIUM TRIAL / ADVANCED

Encrypts an Excel document.

Description
public encryptXLSX (string $source, string $target, array $options)

This method allows to encrypt an Excel 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 Excel document by the standard Excel interface.

Parameters

source

Path to the Excel document that you want to encrypt.

target

Path to the resulting encrypted document.

options

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

Key Type Description
password string 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.
Exceptions

File does not exist.

Password not set.

Code samples

Example #1

Release notes
  • phpdocx 15.0:
    • supported files bigger than 6.5MB.
  • phpdocx 13.0:
    • removed external files.
  • phpdocx 8.5:
    • new method.