2010-01-04 14:26:20 +00:00
< ? php
/*
2010-04-07 01:51:29 +01:00
* This file is part of the Symfony package .
2011-01-15 13:29:43 +00:00
*
2011-03-06 11:40:06 +00:00
* ( c ) Fabien Potencier < fabien @ symfony . com >
2010-01-04 14:26:20 +00:00
*
* For the full copyright and license information , please view the LICENSE
* file that was distributed with this source code .
*/
2011-01-15 13:29:43 +00:00
namespace Symfony\Component\Yaml ;
2011-06-14 11:44:54 +01:00
use Symfony\Component\Yaml\Exception\ParseException ;
2010-01-04 14:26:20 +00:00
/**
* Yaml offers convenience methods to load and dump YAML .
*
2011-03-06 11:40:06 +00:00
* @ author Fabien Potencier < fabien @ symfony . com >
2010-01-04 14:26:20 +00:00
*/
2010-02-11 18:24:23 +00:00
class Yaml
2010-01-04 14:26:20 +00:00
{
2016-01-27 19:42:59 +00:00
const DUMP_OBJECT = 1 ;
2016-02-08 18:49:14 +00:00
const PARSE_EXCEPTION_ON_INVALID_TYPE = 2 ;
const PARSE_OBJECT = 4 ;
const PARSE_OBJECT_FOR_MAP = 8 ;
2016-02-09 19:56:50 +00:00
const DUMP_EXCEPTION_ON_INVALID_TYPE = 16 ;
2016-02-17 21:09:28 +00:00
const PARSE_DATETIME = 32 ;
2016-03-24 12:13:08 +00:00
const DUMP_OBJECT_AS_MAP = 64 ;
const DUMP_MULTI_LINE_LITERAL_BLOCK = 128 ;
2016-04-23 06:47:09 +01:00
const PARSE_CONSTANT = 256 ;
2016-01-27 19:42:59 +00:00
2010-05-06 12:25:53 +01:00
/**
2016-01-27 16:53:33 +00:00
* Parses YAML into a PHP value .
2010-05-06 12:25:53 +01:00
*
* Usage :
* < code >
2014-11-29 13:06:55 +00:00
* $array = Yaml :: parse ( file_get_contents ( 'config.yml' ));
2010-05-06 12:25:53 +01:00
* print_r ( $array );
* </ code >
*
2016-02-08 18:49:14 +00:00
* @ param string $input A string containing YAML
* @ param int $flags A bit field of PARSE_ * constants to customize the YAML parser behavior
2010-05-06 12:25:53 +01:00
*
2016-01-27 16:53:33 +00:00
* @ return mixed The YAML converted to a PHP value
2010-05-06 12:25:53 +01:00
*
2012-04-05 14:34:44 +01:00
* @ throws ParseException If the YAML is not valid
2010-05-06 12:25:53 +01:00
*/
2016-02-08 18:49:14 +00:00
public static function parse ( $input , $flags = 0 )
2010-01-04 14:26:20 +00:00
{
2016-02-08 18:49:14 +00:00
if ( is_bool ( $flags )) {
@ trigger_error ( 'Passing a boolean flag to toggle exception handling is deprecated since version 3.1 and will be removed in 4.0. Use the PARSE_EXCEPTION_ON_INVALID_TYPE flag instead.' , E_USER_DEPRECATED );
if ( $flags ) {
$flags = self :: PARSE_EXCEPTION_ON_INVALID_TYPE ;
} else {
$flags = 0 ;
}
}
if ( func_num_args () >= 3 ) {
@ trigger_error ( 'Passing a boolean flag to toggle object support is deprecated since version 3.1 and will be removed in 4.0. Use the PARSE_OBJECT flag instead.' , E_USER_DEPRECATED );
if ( func_get_arg ( 2 )) {
$flags |= self :: PARSE_OBJECT ;
}
}
if ( func_num_args () >= 4 ) {
@ trigger_error ( 'Passing a boolean flag to toggle object for map support is deprecated since version 3.1 and will be removed in 4.0. Use the Yaml::PARSE_OBJECT_FOR_MAP flag instead.' , E_USER_DEPRECATED );
if ( func_get_arg ( 3 )) {
$flags |= self :: PARSE_OBJECT_FOR_MAP ;
}
}
2010-05-06 12:25:53 +01:00
$yaml = new Parser ();
2016-02-08 18:49:14 +00:00
return $yaml -> parse ( $input , $flags );
2010-01-04 14:26:20 +00:00
}
2010-05-06 12:25:53 +01:00
/**
2016-07-10 10:48:49 +01:00
* Dumps a PHP value to a YAML string .
2010-05-06 12:25:53 +01:00
*
* The dump method , when supplied with an array , will do its best
* to convert the array into friendly YAML .
*
2016-07-17 15:02:08 +01:00
* @ param mixed $input The PHP value
2016-02-09 19:56:50 +00:00
* @ param int $inline The level where you switch to inline YAML
2016-06-29 06:41:56 +01:00
* @ param int $indent The amount of spaces to use for indentation of nested nodes
2016-02-09 19:56:50 +00:00
* @ param int $flags A bit field of DUMP_ * constants to customize the dumped YAML string
2010-05-06 12:25:53 +01:00
*
2016-07-10 10:48:49 +01:00
* @ return string A YAML string representing the original PHP value
2010-05-06 12:25:53 +01:00
*/
2016-07-17 15:02:08 +01:00
public static function dump ( $input , $inline = 2 , $indent = 4 , $flags = 0 )
2010-01-04 14:26:20 +00:00
{
2016-01-27 19:42:59 +00:00
if ( is_bool ( $flags )) {
2016-02-09 19:56:50 +00:00
@ trigger_error ( 'Passing a boolean flag to toggle exception handling is deprecated since version 3.1 and will be removed in 4.0. Use the DUMP_EXCEPTION_ON_INVALID_TYPE flag instead.' , E_USER_DEPRECATED );
if ( $flags ) {
$flags = self :: DUMP_EXCEPTION_ON_INVALID_TYPE ;
} else {
$flags = 0 ;
}
}
if ( func_num_args () >= 5 ) {
2016-01-27 19:42:59 +00:00
@ trigger_error ( 'Passing a boolean flag to toggle object support is deprecated since version 3.1 and will be removed in 4.0. Use the DUMP_OBJECT flag instead.' , E_USER_DEPRECATED );
2016-02-09 19:56:50 +00:00
if ( func_get_arg ( 4 )) {
$flags |= self :: DUMP_OBJECT ;
}
2016-01-27 19:42:59 +00:00
}
2016-02-09 22:58:46 +00:00
$yaml = new Dumper ( $indent );
2010-01-04 14:26:20 +00:00
2016-07-17 15:02:08 +01:00
return $yaml -> dump ( $input , $inline , 0 , $flags );
2010-05-06 12:25:53 +01:00
}
2010-01-04 14:26:20 +00:00
}