ZipArchive::setEncryptionName

名前で定義されたエントリの暗号化方式を設定する

説明

public bool ZipArchive::setEncryptionName(string $name, int $method, #[\SensitiveParameter]stringnull $password = null)

名前で定義されたエントリの暗号化方式を設定する

パラメータ

name

エントリの名前です

method

ZipArchive::EM_ 定数のうちのひとつによって定義された暗号化方式

password

オプションで指定するパスワード。 指定されない場合はデフォルトの値が使われます。

戻り値

成功した場合に true を、失敗した場合に false を返します。

変更履歴

バージョン 説明
8.0.0 password は、nullable になりました。

この例は、ZIP ファイルアーカイブ test.zip を作成し、 AES 256ビット で暗号化した test.txt を追加します。

例1 アーカイブを作成し、ファイルを暗号化する

<?php
$zip = new ZipArchive();
if ($zip->open('test.zip', ZipArchive::CREATE) === TRUE) {
    $zip->setPassword('secret');
    $zip->addFile('text.txt');
    $zip->setEncryptionName('text.txt', ZipArchive::EM_AES_256);
    $zip->close();
    echo "Ok\n";
} else {
    echo "KO\n";
}
?>

注意

注意:

この関数は、libzip ≥ 1.2.0 でビルドされた場合にのみ利用可能です。

参考

  • ZipArchive::setPassword
  • ZipArchive::setEncryptionIndex