Advanced YAML component usage

Author: dantleech

components/yaml/introduction.rst

@@ -185,7 +185,10 @@ If you only need to dump one array, you can use the
 
     use Symfony\Component\Yaml\Yaml;
 
-    $yaml = Yaml::dump($array, $inline);
+    $yaml = Yaml::dump($array);
+
+Array Expansion and Inlining
+""""""""""""""""""""""""""""
 
 The YAML format supports two kind of representation for arrays, the expanded
 one, and the inline one. By default, the dumper uses the inline
@@ -219,6 +222,55 @@ representation to the inline one:
         foo: bar
         bar: baz
 
+Indentation
+"""""""""""
+
+By default the YAML component will use 4 spaces for indentation, this can be
+changed using the second argument as follows:
+
+.. code-block:: php
+
+    // use 8 spaces for indentation
+    echo $dumper->dump($array, 2, 8);
+
+.. code-block:: yaml
+
+    foo: bar
+    bar:
+            foo: bar
+            bar: baz
+
+Invalid Types and Object Serialization
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+By default the YAML component will encode any "unsupported" type (i.e.
+resources and objects) as a string value "null".
+
+Instead of encoding as null you can choose to throw an exception if an invalid
+type is encoutered in either the dumper or parser as follows:
+
+.. code-block:: php
+
+    // throw an exception if a resource or object is encoutered
+    $dumper->dump($data, 2, 4, true);
+
+    // throw an exception if an encoded object is found in the YAML string
+    $parser->parse($yaml, true);        // throw an exception
+
+However you can activate object support using the next argument:
+
+.. code-block:: php
+
+    $object = new \stdClass();
+    $object->hello = 'goodbye';
+
+    $dumoed = $dumper->dump($object, 2, 0, false, true);
+    // !!php/object:O:8:"stdClass":1:{s:5:"hello";s:7:"goodbye";}
+
+    $parsed = $parser->parse($dumped, false, true);
+    is_object($parsed); // true
+    echo $parsed->hello; // goodbye
+
 .. _YAML: http://yaml.org/
 .. _Packagist: https://packagist.org/packages/symfony/yaml
 .. _`YAML 1.2 version specification`: http://yaml.org/spec/1.2/spec.html