Phar::delMetadata

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

Phar::delMetadataphar のグローバルメタデータを削除する

説明

public Phar::delMetadata(): bool

注意:

このメソッドは、php.iniphar.readonly0 でないと Phar オブジェクトで動作しません。それ以外の場合は PharException がスローされます。

phar のグローバルメタデータを削除します。

パラメータ

戻り値

成功した場合に true を返します。しかし、より安全を期すなら try/catch ブロック内で使用して例外がスローされないことを確認するといいでしょう。

エラー / 例外

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

例1 Phar::delMetaData() の例

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

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

NULL
string(8) "hi there"
NULL

参考

関連キーワード:  phar, メタデータ, Phar, 削除, グローバル, スロー, delMetadata, 例外, アーカイブ, エラー