PharFileInfo::getMetadata

ファイルとともに保存されている、ファイル固有のメタデータを返す

説明

public mixed PharFileInfo::getMetadata(array $unserializeOptions = [])

Phar アーカイブ内で、このファイル用のマニフェストに保存されたメタデータを返します。

パラメータ

戻り値

ファイルのメタデータとして保存されている、シリアライズ可能な任意の PHP 変数を返します。メタデータが保存されていない場合は null を返します。

変更履歴

バージョン	説明
8.0.0	引数 `unserializeOptions` が追加されました。

例

例1 PharFileInfo::getMetadata の例


<?php
// 確実に消しておきます
@unlink('brandnewphar.phar');
try {
    $p = new Phar(dirname(__FILE__) . '/brandnewphar.phar', 0, 'brandnewphar.phar');
    $p['file.txt'] = 'hello';
    $p['file.txt']->setMetadata(array('user' => 'bill', 'mime-type' => 'text/plain'));
    var_dump($p['file.txt']->getMetadata());
} catch (Exception $e) {
    echo 'brandnewphar.phar を作成/変更できません: ', $e;
}
?>

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

array(2) {
  ["user"]=>
  string(4) "bill"
  ["mime-type"]=>
  string(10) "text/plain"
}

参考

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