ZipArchive::setPassword
Set the password for the active archive
Description
public bool ZipArchive::setPassword(#[\SensitiveParameter]string $password)
Parameters
-
password
-
The password to be used for the archive.
Return Values
Returns true on success or false on failure.
Notes
Note:
As of PHP 7.2.0 and libzip 1.2.0 the password is used to decompress the archive,
and is also the default password for ZipArchive::setEncryptionName
and ZipArchive::setEncryptionIndex.
Formerly, this function only set the password to be used to decompress the archive;
it did not turn a non-password-protected ZipArchive
into a password-protected ZipArchive.
See Also
- ZipArchive::setEncryptionIndex
- ZipArchive::setEncryptionName