関数・クラス解説

PharFileInfo::setMetadata

version:PHP 5 >= 5.3.0, PHP 7, PECL phar (公式)

ファイルとともに保存する、ファイル固有のメタデータを設定する

公式リファレンス

書式

public PharFileInfo::setMetadata ( mixed $metadata ) : void

説明

PharFileInfo::setMetadata() を使用するのは、 既存のファイル情報としては表せない独自の情報を保存する場合のみに限るべきです。 メタデータを使用すると、phar アーカイブの読み込み時のパフォーマンスが劇的に低下します。これは、 メタデータのサイズが大きい場合やメタデータを含むファイルが大量にある場合に顕著になります。 ファイルのパーミッションについては phar 自体でネイティブにサポートしており、 PharFileInfo->chmod() で設定できることを覚えておきましょう。 この関数は phar の内容を変更するので、Phar アーカイブ内のファイルを操作するには INI 設定 phar.readonly がオフでなければなりません。 PharData アーカイブ内のファイルについては、この制約はありません。

メタデータの使用例として考えられるのは、ユーザー/グループ を指定し、phar からディスクに展開する際にそれを設定することなどです。 ほかには、MIME 型として返す値を明示的に指定することなどがあります。 その他、ファイルについて説明するデータであるが ファイル自体に含むべきでないものを保存したりします。

パラメータ

metadata
ファイルとともに保存する情報を含む、PHP の変数。

返値

値を返しません。

サンプル

例1 PharFileInfo::setMetadata() の例

// 確実に消しておきます @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 'phar を作成/変更できません:', $e; }

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

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

参考

  • PharFileInfo::hasMetadata() - エントリのメタデータを返す
  • PharFileInfo::getMetadata() - ファイルとともに保存されている、ファイル固有のメタデータを返す
  • PharFileInfo::delMetadata() - エントリのメタデータを削除する
  • Phar::setMetadata() - phar アーカイブのメタデータを設定する
  • Phar::hasMetadata() - ファイルがグローバルなメタデータを持つかどうかを返す
  • Phar::getMetadata() - phar アーカイブのメタデータを返す
  • ワード検索


    ※入力キーワードが、関数名・説明文・タグに含まれるものを検索

    関数名アルファベット別

    A B C D E F G H I J
    K L M N O P Q R S T
    U V W X Y Z _

    最終更新一覧

    stristr
     大文字小文字を区別せず文字列を検索し、ヒット箇所以降(あるいは以前)の文字列を返却

    stripslashes
     バックスラッシュでエスケープされた文字列から、バックスラッシュを取り除く

    stripos
     大文字小文字を区別せずに文字列が最初に現れる位置を取得する

    stripcslashes
     addcslashes() でクォートされた文字列をアンクォートする

    strip_tags
     文字列から HTML と PHP のタグを除去して返却

    strcspn
     指定した文字が最初に現れる位置を調べる

    strcoll
     ロケールに基づいて2つの文字列を比較し同じか(あるいは大小)を判定する

    strcmp
     2つの文字列を比較し同じか(あるいは大小)を判定する

    strchr
     strstr() のエイリアス

    strcasecmp
     2つの文字列を比較(大文字小文字を区別せず同じとみなす)

    カテゴリー一覧

    PHP の振る舞いの変更
    音声フォーマットの操作
    認証サービス
    コマンドライン関連
    圧縮およびアーカイブ
    暗号
    データベース関連
    日付および時刻関連
    ファイルシステム
    自然言語および文字エンコーディング
    画像処理および作成
    メール関連
    数学
    テキスト以外の MIME 型
    プロセス制御
    その他の基本モジュール
    その他のサービス
    検索エンジン用の拡張モジュール
    サーバー固有のモジュール
    セッション関連
    テキスト処理
    変数・データ型関連
    ウェブサービス
    Windows 用のモジュール
    XML 操作
    GUI用の拡張モジュール