Phar::delMetadata

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

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

説明

public Phar::delMetadata(): true

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

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

パラメータ

戻り値

常に true を返します。

エラー / 例外

変更をディスクに書き戻す際にエラーが発生した場合は 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::getMetadata() - phar アーカイブのメタデータを返す
Phar::setMetadata() - phar アーカイブのメタデータを設定する
Phar::hasMetadata() - ファイルがグローバルなメタデータを持つかどうかを返す