関数・クラス解説

Phar::setMetadata

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

phar アーカイブのメタデータを設定する

公式リファレンス

書式

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

説明

注意:

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

Phar::setMetadata() は、 phar アーカイブ全体に関する独自の情報を保存する場合に使用します。 ファイル固有のメタデータについては PharFileInfo::setMetadata() を使うようにしましょう。大きなメタデータを使用すると、 phar アーカイブの読み込み時のパフォーマンスが低下します。

メタデータの使用例として考えられるのは、 アーカイブの中で最初に実行するファイルはどれかを指定したり、 » PEAR の package.xml のようなマニフェストの場所を指定したりすることです。 しかし、phar アーカイブに関する有用なデータなら何を保存してもかまいません。

パラメータ

metadata
phar アーカイブについての情報を含む、PHP の変数。

返値

値を返しません。

サンプル

例1 Phar::setMetadata() の例

// 確実に消しておきます @unlink('brandnewphar.phar'); try {     $p = new Phar(dirname(__FILE__) . '/brandnewphar.phar', 0, 'brandnewphar.phar');     $p['file.php'] = 'setMetadata(array('bootstrap' => 'file.php'));     var_dump($p->getMetadata()); } catch (Exception $e) {     echo 'phar の作成/変更ができません:', $e; }

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

array(1) { ["bootstrap"]=> string(8) "file.php" }

参考

  • Phar::getMetadata() - phar アーカイブのメタデータを返す
  • Phar::delMetadata() - phar のグローバルメタデータを削除する
  • Phar::hasMetadata() - ファイルがグローバルなメタデータを持つかどうかを返す
  • ワード検索


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

    関数名アルファベット別

    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用の拡張モジュール