Yaml.php (3884B)
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 * @api 22 */ 23 class Yaml 24 { 25 /** 26 * Parses YAML into a PHP array. 27 * 28 * The parse method, when supplied with a YAML stream (string or file), 29 * will do its best to convert YAML in a file into a PHP array. 30 * 31 * Usage: 32 * <code> 33 * $array = Yaml::parse(file_get_contents('config.yml')); 34 * print_r($array); 35 * </code> 36 * 37 * As this method accepts both plain strings and file names as an input, 38 * you must validate the input before calling this method. Passing a file 39 * as an input is a deprecated feature and will be removed in 3.0. 40 * 41 * 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. 42 * 43 * @param string $input Path to a YAML file or a string containing YAML 44 * @param bool $exceptionOnInvalidType True if an exception must be thrown on invalid types false otherwise 45 * @param bool $objectSupport True if object support is enabled, false otherwise 46 * @param bool $objectForMap True if maps should return a stdClass instead of array() 47 * 48 * @return array The YAML converted to a PHP array 49 * 50 * @throws ParseException If the YAML is not valid 51 * 52 * @api 53 */ 54 public static function parse($input, $exceptionOnInvalidType = false, $objectSupport = false, $objectForMap = false) 55 { 56 // if input is a file, process it 57 $file = ''; 58 if (strpos($input, "\n") === false && is_file($input)) { 59 @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); 60 61 if (false === is_readable($input)) { 62 throw new ParseException(sprintf('Unable to parse "%s" as the file is not readable.', $input)); 63 } 64 65 $file = $input; 66 $input = file_get_contents($file); 67 } 68 69 $yaml = new Parser(); 70 71 try { 72 return $yaml->parse($input, $exceptionOnInvalidType, $objectSupport, $objectForMap); 73 } catch (ParseException $e) { 74 if ($file) { 75 $e->setParsedFile($file); 76 } 77 78 throw $e; 79 } 80 } 81 82 /** 83 * Dumps a PHP array to a YAML string. 84 * 85 * The dump method, when supplied with an array, will do its best 86 * to convert the array into friendly YAML. 87 * 88 * @param array $array PHP array 89 * @param int $inline The level where you switch to inline YAML 90 * @param int $indent The amount of spaces to use for indentation of nested nodes. 91 * @param bool $exceptionOnInvalidType true if an exception must be thrown on invalid types (a PHP resource or object), false otherwise 92 * @param bool $objectSupport true if object support is enabled, false otherwise 93 * 94 * @return string A YAML string representing the original PHP array 95 * 96 * @api 97 */ 98 public static function dump($array, $inline = 2, $indent = 4, $exceptionOnInvalidType = false, $objectSupport = false) 99 { 100 $yaml = new Dumper(); 101 $yaml->setIndentation($indent); 102 103 return $yaml->dump($array, $inline, 0, $exceptionOnInvalidType, $objectSupport); 104 } 105 }