Php/docs/phar.delmetadata

• PHP Manual
• Phar
• phar のグローバルメタデータを削除する

Phar::delMetadata

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

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

説明

public Phar::delMetadata ( ) : bool

注意:

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

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

パラメータ

返り値

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

エラー / 例外

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

例

例1 Phar::delMetaData() の例

<?phptry {    $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() - ファイルがグローバルなメタデータを持つかどうかを返す