yaml_parse_file()

yaml_parse_file - Parse a YAML stream from a file

Syntax

mixed yaml_parse_file (string $filename, int $pos, int &$ndocs, array $callbacks)

Arguments

• filename - Path to the file.
• pos - Document to extract from stream ( -1for all documents, 0for first document,...).
• ndocs - If ndocs is provided, then it is filled with the number of documents found in stream.
• callbacks - Content handlers for YAML nodes. Associative array of YAML tag => callback mappings.

Description

Convert all or part of a YAML document stream read from a file to a PHP variable.

Version

PHP PECL yaml >= 0.4.0

Return value

Returns the value encoded in input in appropriate PHP type. NULL is returned if the input cannot be decoded. If pos is -1an array will be returned with one entry for each document found in the stream.