Php/docs/function.yaml-parse-file

提供:Dev Guides
< Php
移動先:案内検索

yaml_parse_file

(PECL yaml >= 0.4.0)

yaml_parse_fileファイルからの YAML ストリームをパースする


説明

yaml_parse_file ( string $filename [, int $pos = 0 [, int &$ndocs [, array $callbacks = null ]]] ) : mixed

指定したファイルから読み込んだ YAML ドキュメントストリーム全体あるいはその一部を、PHP の変数に変換します。


パラメータ

filename
ファイルへのパス。
pos
ストリームから取り出すドキュメント (-1 はすべてのドキュメント、0 は最初のドキュメント、...)。
ndocs
ndocs を渡すと、 ストリーム内で見つかったドキュメントの数がそこに格納されます。
callbacks
YAML ノードのコンテンツハンドラ。 YAML タグ => callable 形式の連想配列となります。 詳細はパースコールバック を参照ください。


返り値

適切な PHP の型に変換した結果を返します。 失敗した場合に false を返します。 pos-1 の場合は配列を返します。 配列の各要素が、ストリーム内で見つかった個々のドキュメントとなります。


注意

警告 !php/object タグを使ったノードの unserialize() を有効にしている場合に、 ユーザーからの信頼できない入力を yaml_parse_file() で処理するのは危険です。 この挙動を無効にするには、ini 設定の yaml.decode_php を利用します。


参考