Spec-Zone.ru › Symfony 3.0

Yaml

класс Yaml

Yaml предлагает удобные методы для загрузки и вывода YAML.

Методы

статический массив parse(строка $input, bool $exceptionOnInvalidType = false, bool $objectSupport = false, bool $objectForMap = false)

Парсит YAML в массив PHP.

статический строка dump(массив $array, int $inline = 2, int $indent = 4, bool $exceptionOnInvalidType = false, bool $objectSupport = false)

Выводит массив PHP в строку YAML.

Подробности

статический массив parse(строка $input, bool $exceptionOnInvalidType = false, bool $objectSupport = false, bool $objectForMap = false)

Парсит YAML в массив PHP.

Метод parse, когда получает поток YAML (строка или файл), делает всё возможное, чтобы преобразовать YAML из файла в массив PHP.

Использование: $array = Yaml::parse(filegetcontents('config.yml')); print_r($array);

Параметры

строка $input Строка, содержащая YAML
bool $exceptionOnInvalidType True, если исключение должно быть выброшено при недопустимых типах; false в противном случае
bool $objectSupport True, если поддержка объектов включена; false в противном случае
bool $objectForMap True, если карты должны возвращать объект stdClass вместо array()

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

массив YAML, преобразованный в массив PHP

Исключения

ParseException Если YAML некорректен

статический строка dump(массив $array, int $inline = 2, int $indent = 4, bool $exceptionOnInvalidType = false, bool $objectSupport = false)

Выводит массив PHP в строку YAML.

Метод dump, когда получает массив, делает всё возможное, чтобы преобразовать массив в дружественный YAML.

Параметры

массив $array Массив PHP
int $inline Уровень, на котором происходит переход к инлайновому YAML
int $indent Количество пробелов для отступа вложенных узлов.
bool $exceptionOnInvalidType true, если исключение должно быть выброшено при недопустимых типах (ресурс PHP или объект); false в противном случае
bool $objectSupport true, если поддержка объектов включена; false в противном случае

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

строка Строка YAML, представляющая исходный массив PHP

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.0/Symfony/Component/Yaml/Yaml.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API