PharData::delete

(PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL phar >= 2.0.0)

PharData::deletetar/zip アーカイブ内のファイルを削除する

説明

public PharData::delete(string $localName): bool

アーカイブ内のファイルを削除します。 これは、ストリームラッパー上で unlink() をコールするのと同じ意味です。以下に例を示します。

パラメータ

localName

削除したいファイルの、アーカイブ内でのパス。

戻り値

成功した場合に true を返します。 しかし、例外がスローされているかどうかを確認したうえで 例外がなければ成功とみなすほうがいいでしょう。

エラー / 例外

変更内容をディスクに書き込む際にエラーが発生した場合は PharException をスローします。

例1 PharData::delete() の例

<?php
try {
    
$phar = new PharData('myphar.zip');
    
$phar->delete('unlink/me.php');
    
// これは以下と同じ意味です
    
unlink('phar://myphar.phar/unlink/me.php');
} catch (
Exception $e) {
    
// エラー処理
}
?>

参考

  • Phar::delete() - phar アーカイブ内のファイルを削除する

関連キーワード:  アーカイブ, 削除, tar, PharData, ファイル, 例外, スロー, エラー, localName, 成功