PharData::offsetUnset

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

PharData::offsetUnset — ファイルを tar/zip アーカイブから削除する

説明

PharData::offsetUnset ( string $offset ) : bool

これは ArrayAccess インターフェイスを実装したものです。これにより、Phar アーカイブの内容に対して配列形式の角括弧を使用したアクセスが可能となります。 offsetUnset を使用して、既存のファイルを削除します。また unset() が使用された場合にもコールされます。

パラメータ

offset: tar/zip アーカイブ内で変更するファイル名 (相対パス)。

返り値

成功した場合に TRUE を、失敗した場合に FALSE を返します。

エラー / 例外

tar/zip アーカイブへの変更をディスクに書き込む際に何らかのエラーが発生すると PharException をスローします。

例

例1 PharData::offsetUnset() の例


<?php
$p = new PharData('/path/to/my.zip');
try {
    // offsetUnset がコールされ、file.txt が my.zip から削除されます
    unset($p['file.txt']);
} catch (Exception $e) {
    echo 'file.txt を削除できません: ', $e;
}
?>

参考

Phar::offsetUnset() - ファイルを phar から削除する