Yaml.php (3835B)
1 <?php 2 3 /* 4 * This file is part of the Symfony package. 5 * 6 * (c) Fabien Potencier <fabien@symfony.com> 7 * 8 * For the full copyright and license information, please view the LICENSE 9 * file that was distributed with this source code. 10 */ 11 12 namespace Symfony\Component\Yaml; 13 14 use Symfony\Component\Yaml\Exception\ParseException; 15 16 /** 17 * Yaml offers convenience methods to load and dump YAML. 18 * 19 * @author Fabien Potencier <fabien@symfony.com> 20 */ 21 class Yaml 22 { 23 /** 24 * Parses YAML into a PHP array. 25 * 26 * The parse method, when supplied with a YAML stream (string or file), 27 * will do its best to convert YAML in a file into a PHP array. 28 * 29 * Usage: 30 * <code> 31 * $array = Yaml::parse(file_get_contents('config.yml')); 32 * print_r($array); 33 * </code> 34 * 35 * As this method accepts both plain strings and file names as an input, 36 * you must validate the input before calling this method. Passing a file 37 * as an input is a deprecated feature and will be removed in 3.0. 38 * 39 * Note: the ability to pass file names to the Yaml::parse method is deprecated since version 2.2 and will be removed in 3.0. Pass the YAML contents of the file instead. 40 * 41 * @param string $input Path to a YAML file or a string containing YAML 42 * @param bool $exceptionOnInvalidType True if an exception must be thrown on invalid types false otherwise 43 * @param bool $objectSupport True if object support is enabled, false otherwise 44 * @param bool $objectForMap True if maps should return a stdClass instead of array() 45 * 46 * @return array The YAML converted to a PHP array 47 * 48 * @throws ParseException If the YAML is not valid 49 */ 50 public static function parse($input, $exceptionOnInvalidType = false, $objectSupport = false, $objectForMap = false) 51 { 52 // if input is a file, process it 53 $file = ''; 54 if (strpos($input, "\n") === false && is_file($input)) { 55 @trigger_error('The ability to pass file names to the '.__METHOD__.' method is deprecated since version 2.2 and will be removed in 3.0. Pass the YAML contents of the file instead.', E_USER_DEPRECATED); 56 57 if (false === is_readable($input)) { 58 throw new ParseException(sprintf('Unable to parse "%s" as the file is not readable.', $input)); 59 } 60 61 $file = $input; 62 $input = file_get_contents($file); 63 } 64 65 $yaml = new Parser(); 66 67 try { 68 return $yaml->parse($input, $exceptionOnInvalidType, $objectSupport, $objectForMap); 69 } catch (ParseException $e) { 70 if ($file) { 71 $e->setParsedFile($file); 72 } 73 74 throw $e; 75 } 76 } 77 78 /** 79 * Dumps a PHP array to a YAML string. 80 * 81 * The dump method, when supplied with an array, will do its best 82 * to convert the array into friendly YAML. 83 * 84 * @param array $array PHP array 85 * @param int $inline The level where you switch to inline YAML 86 * @param int $indent The amount of spaces to use for indentation of nested nodes. 87 * @param bool $exceptionOnInvalidType true if an exception must be thrown on invalid types (a PHP resource or object), false otherwise 88 * @param bool $objectSupport true if object support is enabled, false otherwise 89 * 90 * @return string A YAML string representing the original PHP array 91 */ 92 public static function dump($array, $inline = 2, $indent = 4, $exceptionOnInvalidType = false, $objectSupport = false) 93 { 94 $yaml = new Dumper(); 95 $yaml->setIndentation($indent); 96 97 return $yaml->dump($array, $inline, 0, $exceptionOnInvalidType, $objectSupport); 98 } 99 }