PharFileInfo::delMetadata

エントリのメタデータを削除する

説明

public bool PharFileInfo::delMetadata()

エントリのメタデータが存在する場合にそれを削除します。

パラメータ

パラメータはありません。

戻り値

成功した場合に true を返します。エントリがメタデータを持っていない場合に false を返します。この関数は phar の内容を変更するので、Phar アーカイブ内のファイルを操作するには INI 設定 phar.readonly がオフでなければなりません。 PharData アーカイブ内のファイルについては、この制約はありません。

エラー / 例外

変更のディスクへの書き込み時にエラーが発生した場合は PharException、書き込みアクセスが無効となっている場合は BadMethodCallException をスローします。

例

例1 PharFileInfo::delMetaData の例


<?php
try {
    $a = new Phar('myphar.phar');
    $a['hi'] = 'hi';
    var_dump($a['hi']->delMetadata());
    $a['hi']->setMetadata('there');
    var_dump($a['hi']->delMetadata());
    var_dump($a['hi']->delMetadata());
} catch (Exception $e) {
    // エラー処理
}
?>

上の例の出力は以下となります。

bool(false)
bool(true)
bool(false)

参考

PharFileInfo::setMetadata
PharFileInfo::hasMetadata
PharFileInfo::getMetadata
Phar::setMetadata
Phar::hasMetadata
Phar::getMetadata