yaml_parse_file
ファイルからの YAML ストリームをパースする
説明
mixed yaml_parse_file(
string $filename,
int $pos = 0,
int &$ndocs = ?,
array $callbacks = null
)
パラメータ
-
filename
-
ファイルへのパス。
-
pos
-
ストリームから取り出すドキュメント (-1
はすべてのドキュメント、0 は最初のドキュメント、...)。
-
ndocs
-
ndocs を渡すと、
ストリーム内で見つかったドキュメントの数がそこに格納されます。
-
callbacks
-
YAML ノードのコンテンツハンドラ。
YAML タグ => callable 形式の連想配列となります。
詳細はパースコールバック
を参照ください。
戻り値
filename にある情報を、
適切な PHP の型に変換した結果を返します。
失敗した場合に false を返します。
pos が -1 の場合は配列を返します。
配列の各要素が、ストリーム内で見つかった個々のドキュメントとなります。
注意
警告
!php/object タグを使ったノードの
unserialize を有効にしている場合に、
ユーザーからの信頼できない入力を
yaml_parse_file
で処理するのは危険です。
この挙動を無効にするには、ini 設定の yaml.decode_php を利用します。
参考
- yaml_parse
- yaml_parse_url
- yaml_emit