move Dumper section above the Caster one

symfony · Oct 21, 2014 · b5b45bc · b5b45bc
1 parent 2fc3811
commit b5b45bc
Showing 1 changed file with 58 additions and 58 deletions.
diff --git a/components/var_dumper/advanced.rst b/components/var_dumper/advanced.rst
@@ -27,6 +27,64 @@ Before cloning, you can configure the limits with::
 
 They will be applied when calling ``->cloneVar()`` afterwards.
 
+Dumpers
+~~~~~~~
+
+A dumper is responsible for outputting a string representation of a PHP variable,
+using a :class:`Symfony\\Component\\VarDumper\\Cloner\\Data` object as input.
+The destination and the formatting of this output vary with dumpers.
+
+This component comes with an :class:`Symfony\\Component\\VarDumper\\Dumper\\HtmlDumper`
+for HTML output and a :class:`Symfony\\Component\\VarDumper\\Dumper\\CliDumper`
+for optionally colored command line output.
+
+For example, if you want to dump some ``$variable``, just do::
+
+    $cloner = new VarCloner();
+    $dumper = new CliDumper();
+
+    $dumper->dump($cloner->cloneVar($variable));
+
+By using the first argument of the constructor, you can select the output
+stream where the dump will be written. By default, the ``CliDumper`` writes
+on ``php://stdout`` and the ``HtmlDumper`` on ``php://output``, but any PHP
+stream (resource or URL) is acceptable.
+
+Instead of a stream destination, you can also pass it a ``callable`` that
+will be called repeatedly for each line generated by a dumper. This
+callable can be configured using the first argument of a dumper's constructor,
+but also using the
+:method:`Symfony\\Component\\VarDumper\\Dumper\\AbstractDumper::setLineDumper`
+method or the second argument of the
+:method:`Symfony\\Component\\VarDumper\\Dumper\\AbstractDumper::dump` method.
+
+For example, to get a dump as a string in a variable, you can do::
+
+    $cloner = new VarCloner();
+    $dumper = new CliDumper();
+    $output = '';
+
+    $dumper->dump(
+        $cloner->cloneVar($variable),
+        function ($line, $depth) use (&$output) {
+            // A negative depth means "end of dump"
+            if ($depth >= 0) {
+                // Adds a two spaces indentation to the line
+                $output .= str_repeat('  ', $depth).$line."\n";
+            }
+        }
+    );
+
+    // $output is now populated with the dump representation of $variable
+
+Dumpers implement the :class:`Symfony\\Component\\VarDumper\\Dumper\\DataDumperInterface`
+interface that specifies the
+:method:`dump(Data $data) <Symfony\\Component\\VarDumper\\Dumper\\DataDumperInterface::dump>`
+method. They also typically implement the
+:class:`Symfony\\Component\\VarDumper\\Cloner\\DumperInterface` that frees
+them from re-implementing the logic required to walk through a
+:class:`Symfony\\Component\\VarDumper\\Cloner\\Data` object's internal structure.
+
 Casters
 ~~~~~~~
 
@@ -98,61 +156,3 @@ properties not in the class declaration).
 .. note::
     Although you can, it is best advised not to alter the state of an object
     while casting it in a Caster.
-
-Dumpers
-~~~~~~~
-
-A dumper is responsible for outputting a string representation of a PHP variable,
-using a :class:`Symfony\\Component\\VarDumper\\Cloner\\Data` object as input.
-The destination and the formatting of this output vary with dumpers.
-
-This component comes with an :class:`Symfony\\Component\\VarDumper\\Dumper\\HtmlDumper`
-for HTML output and a :class:`Symfony\\Component\\VarDumper\\Dumper\\CliDumper`
-for optionally colored command line output.
-
-For example, if you want to dump some ``$variable``, just do::
-
-    $cloner = new VarCloner();
-    $dumper = new CliDumper();
-
-    $dumper->dump($cloner->cloneVar($variable));
-
-By using the first argument of the constructor, you can select the output
-stream where the dump will be written. By default, the ``CliDumper`` writes
-on ``php://stdout`` and the ``HtmlDumper`` on ``php://output``, but any PHP
-stream (resource or URL) is acceptable.
-
-Instead of a stream destination, you can also pass it a ``callable`` that
-will be called repeatedly for each line generated by a dumper. This
-callable can be configured using the first argument of a dumper's constructor,
-but also using the
-:method:`Symfony\\Component\\VarDumper\\Dumper\\AbstractDumper::setLineDumper`
-method or using the second argument of the
-:method:`Symfony\\Component\\VarDumper\\Dumper\\AbstractDumper::dump` method.
-
-For example, to get a dump in a variable, you can do::
-
-    $cloner = new VarCloner();
-    $dumper = new CliDumper();
-    $output = '';
-
-    $dumper->dump(
-        $cloner->cloneVar($variable),
-        function ($line, $depth) use (&$output) {
-            // A negative depth means "end of dump"
-            if ($depth >= 0) {
-                // Adds a two spaces indentation to the line
-                $output .= str_repeat('  ', $depth).$line."\n";
-            }
-        }
-    );
-
-    // $output is now populated with the dump representation of $variable
-
-Dumpers implement the :class:`Symfony\\Component\\VarDumper\\Dumper\\DataDumperInterface`
-interface that specifies the
-:method:`dump(Data $data) <Symfony\\Component\\VarDumper\\Dumper\\DataDumperInterface::dump>`
-method. They also typically implement the
-:class:`Symfony\\Component\\VarDumper\\Cloner\\DumperInterface` that frees
-them from re-implementing the logic required to walk through a
-:class:`Symfony\\Component\\VarDumper\\Cloner\\Data` object's internal structure.