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. Ассоциативный массив (array), ключи которого являются тегами YAML, а значения callback-функциями (callable), которые будут их обрабатывать. Более подробно этот механизм описан в разделе callback-функции разбора.

Возвращаемые значения

Возвращает значение, закодированное в input, в соответствующем PHP типе или false в случае возникновения ошибки. Если параметр pos равен -1, то будет возвращён массив (array), содержащий по одной записи для каждого документа, найденного в потоке.

Примечания

Внимание

Обрабатывать непроверенный пользовательский ввод с помощью функции yaml_parse_file() в случае, если разрешено использовать unserialize() для узлов с тегом !php/object - крайне опасно. Такое поведение может быть запрещено с помощью ini-настройки yaml.decode_php.

Смотрите также

yaml_parse() - Разбирает поток YAML
yaml_parse_url() - Разбирает YAML-поток из URL
yaml_emit() - Возвращает YAML-представление значения

add a note

User Contributed Notes 4 notes

down

Dan M ¶

4 years ago


Be aware that when parsing yaml an unquoted Y value will become a boolean true

This may be desired or undesired behavior depending on context

- chr_name: X // becomes string X
- chr_name: Y // becomes boolean true

[
 [chr_name => X],
 [chr_name => true],
]

You definitely don't want chromosome Y becoming chromosome 1 (true) as happened to me, so heads up!

down

Arne L. ¶

9 years ago


As Jesse Donat mentioned the type will be infered automatically. To enforce some type you can use the callback facility like this:

<?php
function cb_yaml_date($value, $tag, $flags) {
    return new DateTime($value);
}

$yaml = <<<YAML
event1:
  name: My Event
  date: !date 25.05.2001
YAML;

$ndocs = 0;
$data = yaml_parse($yaml, 0, $ndocs, array('!date' => 'cb_yaml_date'));

print_r($data);
?>

The above example will output something similar to:

    Array
    (
        [event1] => Array
            (
                [name] => My Event
                [date] => DateTime Object
                    (
                        [date] => 2001-05-25 00:00:00
                        [timezone_type] => 3
                        [timezone] => Europe/Berlin
                    )
    
            )
    
    )

BTW if you want to have large numbers you are probably using BC Math. Thus, you simple enclose your number in quotes:

<?php
$yaml = <<<YAML
largenumber: '14695760472279668267313200104308'
YAML;
?>

down

-3

Jesse Donat ¶

13 years ago


This is entirely dependent on type detection - as far as I can find there is no way to force a type and for instance when you have a very long integer as a value - in my case 1313035348823 it gets limited to 2147483647 - PHP's max integer.

down

-9

DarckCrystale ¶

6 years ago


When trying to read an empty file, yaml_parse_file() throws a warning:

    PHP Warning:  yaml_parse_file(): end of stream reached without finding document 0

add a note