Added Yaml\Dumper::setIndentation() method to allow a custom indentation level of nested nodes.

sun · sun · commit 5be7237b69a5 · 2012-08-05T08:07:18.000+02:00
YAML does not specify an absolute indentation level, but a consistent indentation of nested nodes only: http://www.yaml.org/spec/1.2/spec.html#space/indentation/ Projects that are generally using 2 spaces for indentation should be able to retain consistency with their coding standards by supplying a custom value for the new $indent parameter added to Yaml::dump(), or the new Dumper::setIndentation() method. The new parameter is a backwards-compatible API addition and defaults to the previous default of 4 (which was changed from 2 via PR #2242 only recently).
diff --git a/src/Symfony/Component/Yaml/Dumper.php b/src/Symfony/Component/Yaml/Dumper.php
@@ -18,6 +18,23 @@
  */
 class Dumper
 {
+    /**
+     * The amount of spaces to use for indentation of nested nodes.
+     *
+     * @var integer
+     */
+    protected $indentation = 4;
+
+    /**
+     * Sets the indentation.
+     *
+     * @param integer $num The amount of spaces to use for intendation of nested nodes.
+     */
+    public function setIndentation($num)
+    {
+        $this->indentation = $num;
+    }
+
     /**
      * Dumps a PHP value to YAML.
      *
@@ -44,7 +61,7 @@ public function dump($input, $inline = 0, $indent = 0)
                     $prefix,
                     $isAHash ? Inline::dump($key).':' : '-',
                     $willBeInlined ? ' ' : "\n",
-                    $this->dump($value, $inline - 1, $willBeInlined ? 0 : $indent + 4)
+                    $this->dump($value, $inline - 1, $willBeInlined ? 0 : $indent + $this->indentation)
                 ).($willBeInlined ? "\n" : '');
             }
         }
diff --git a/src/Symfony/Component/Yaml/Yaml.php b/src/Symfony/Component/Yaml/Yaml.php
@@ -97,14 +97,16 @@ public static function parse($input)
      *
      * @param array   $array  PHP array
      * @param integer $inline The level where you switch to inline YAML
+     * @param integer $indent The amount of spaces to use for indentation of nested nodes.
      *
      * @return string A YAML string representing the original PHP array
      *
      * @api
      */
-    public static function dump($array, $inline = 2)
+    public static function dump($array, $inline = 2, $indent = 4)
     {
         $yaml = new Dumper();
+        $yaml->setIndentation($indent);
 
         return $yaml->dump($array, $inline);
     }

Original file line number	Diff line number	Diff line change
`@@ -97,14 +97,16 @@ public static function parse($input)`
`97`	`97`	`*`
`98`	`98`	`* @param array $array PHP array`
`99`	`99`	`* @param integer $inline The level where you switch to inline YAML`
	`100`	`+ * @param integer $indent The amount of spaces to use for indentation of nested nodes.`
`100`	`101`	`*`
`101`	`102`	`* @return string A YAML string representing the original PHP array`
`102`	`103`	`*`
`103`	`104`	`* @api`
`104`	`105`	`*/`
`105`		`- public static function dump($array, $inline = 2)`
	`106`	`+ public static function dump($array, $inline = 2, $indent = 4)`
`106`	`107`	`{`
`107`	`108`	`$yaml = new Dumper();`
	`109`	`+ $yaml->setIndentation($indent);`
`108`	`110`
`109`	`111`	`return $yaml->dump($array, $inline);`
`110`	`112`	`}`