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-функции разбора.

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

Функция возвращает значение, закодированное в пути filename, в соответствующем PHP-типе

В случае ошибки возвращается строка, содержащая сообщение об ошибке.

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

Примечания

Внимание

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

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

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