From 363e38fc2a3ae9c5b4f9f07a8cb0ce9cbd5ba5a3 Mon Sep 17 00:00:00 2001
From: WouterJ <waldio.webdesign@gmail.com>
Date: Tue, 18 Nov 2014 17:13:19 +0100
Subject: [PATCH 1/3] Added documentation about the DebugFormatter helper

---
 .../console/helpers/debug_formatter.rst       | 109 ++++++++++++++++++
 components/console/helpers/index.rst          |   1 +
 components/console/helpers/map.rst.inc        |   1 +
 3 files changed, 111 insertions(+)
 create mode 100644 components/console/helpers/debug_formatter.rst

diff --git a/components/console/helpers/debug_formatter.rst b/components/console/helpers/debug_formatter.rst
new file mode 100644
index 00000000000..ba584b349fc
--- /dev/null
+++ b/components/console/helpers/debug_formatter.rst
@@ -0,0 +1,109 @@
+.. index::
+    single: Console Helpers; DebugFormatter Helper
+
+DebugFormatter Helper
+=====================
+
+.. versionadded:: 2.6
+    The DebugFormatter helper was introduced in Symfony 2.6.
+
+The :class:`Symfony\\Component\\Console\\Helper\\DebugFormatterHelper` provides
+functions to output debug information when running an external program, for
+instance a process or HTTP request. It is included in the default helper set,
+which you can get by calling
+:method:`Symfony\\Component\\Console\\Command\\Command::getHelperSet`::
+
+    $debugFormatter = $this->getHelper('debug_formatter');
+
+The formatter only formats strings, which you can use to output to the console,
+but also to log the information or anything else.
+
+All methods of this helper have an identifier as the first argument. This is an
+unique value for each program. This way, the helper can debug information for
+multiple programs at the same time. When using the
+:doc:`Process component </components/process>`, you probably want to use
+:phpfunction:`spl_object_hash`.
+
+.. tip::
+
+    This information is often too verbose to show by default. You can use
+    :ref:`verbosity levels <verbosity-levels>` to only show it when in
+    debugging mode (``-vvv``).
+
+Starting a Program
+------------------
+
+As soon as you start a program, you can use
+:method:`Symfony\\Component\\Console\\Helper\\DebugFormatterHelper::start` to
+display information that the program is started::
+
+    // ...
+    $process = new Process(...);
+    $process->run();
+
+    $output->writeln($debugFormatter->start(spl_object_hash($process), 'Some process description'));
+
+This will output:
+
+.. code-block:: text
+
+     RUN Some process description
+
+You can tweak the prefix using the third argument::
+
+    $output->writeln($debugFormatter->start(spl_object_hash($process), 'Some process description', 'STARTED');
+    // will output:
+    //  STARTED Some process description
+
+Output Progress Information
+---------------------------
+
+Some programs give output while they are running. This information can be shown
+using
+:method:`Symfony\\Component\\Console\\Helper\\DebugFormatterHelper::progress`::
+
+    // ...
+    $output->writeln($debugFormatter->progress(spl_object_hash($process), $buffer, Process::ERR === $type));
+
+In case of success, this will output:
+
+.. code-block:: text
+
+    OUT The output of the process
+
+And this in case of failure:
+
+.. code-block:: text
+
+    ERR The output of the process
+
+The third argument is a boolean which tells the function if the output is error
+output or not. When ``true``, the output is considered error output.
+
+The fourth and fifth argument allow you to override the prefix for respectively
+the normal output and error output.
+
+Stopping a Program
+------------------
+
+When a program is stopped, you can use
+:method:`Symfony\\Component\\Console\\Helper\\DebugFormatterHelper::progress`
+to notify this to the users::
+
+    // ...
+    $output->writeln($debugFormatter->progress(spl_object_hash($process), 'Some command description', $process->isSuccesfull()));
+
+This will output:
+
+.. code-block:: text
+
+    RES Some command description
+
+In case of failure, this will be in red and in case of success it will be green.
+
+Using multiple Programs
+-----------------------
+
+As said before, you can also use the helper to display more programs at the
+same time. Information about different programs will be shown in different
+colors, to make it clear which output belongs to which command.
diff --git a/components/console/helpers/index.rst b/components/console/helpers/index.rst
index 909671fb08c..96034459478 100644
--- a/components/console/helpers/index.rst
+++ b/components/console/helpers/index.rst
@@ -7,6 +7,7 @@ The Console Helpers
 .. toctree::
     :hidden:
 
+    debug_formatter
     dialoghelper
     formatterhelper
     processhelper
diff --git a/components/console/helpers/map.rst.inc b/components/console/helpers/map.rst.inc
index 15e6e9f8da9..ea7e472dca8 100644
--- a/components/console/helpers/map.rst.inc
+++ b/components/console/helpers/map.rst.inc
@@ -1,3 +1,4 @@
+* :doc:`/components/console/helpers/debug_formatter` (new in 2.6)
 * :doc:`/components/console/helpers/dialoghelper`
 * :doc:`/components/console/helpers/formatterhelper`
 * :doc:`/components/console/helpers/processhelper`

From 6a02f68f4e51067d5b16956040eb40dacb548dbc Mon Sep 17 00:00:00 2001
From: WouterJ <waldio.webdesign@gmail.com>
Date: Sun, 23 Nov 2014 21:27:04 +0100
Subject: [PATCH 2/3] Applied comments from our great reviewers

---
 .../console/helpers/debug_formatter.rst       | 45 ++++++++++++-------
 1 file changed, 30 insertions(+), 15 deletions(-)

diff --git a/components/console/helpers/debug_formatter.rst b/components/console/helpers/debug_formatter.rst
index ba584b349fc..6368686b78d 100644
--- a/components/console/helpers/debug_formatter.rst
+++ b/components/console/helpers/debug_formatter.rst
@@ -1,24 +1,24 @@
 .. index::
     single: Console Helpers; DebugFormatter Helper
 
-DebugFormatter Helper
-=====================
+Debug Formatter Helper
+======================
 
 .. versionadded:: 2.6
-    The DebugFormatter helper was introduced in Symfony 2.6.
+    The Debug Formatter helper was introduced in Symfony 2.6.
 
 The :class:`Symfony\\Component\\Console\\Helper\\DebugFormatterHelper` provides
 functions to output debug information when running an external program, for
-instance a process or HTTP request. It is included in the default helper set,
-which you can get by calling
-:method:`Symfony\\Component\\Console\\Command\\Command::getHelperSet`::
+instance a process or HTTP request. It is included in the default helper set
+and you can get it by calling
+:method:`Symfony\\Component\\Console\\Command\\Command::getHelper`::
 
     $debugFormatter = $this->getHelper('debug_formatter');
 
 The formatter only formats strings, which you can use to output to the console,
-but also to log the information or anything else.
+but also to log the information or do anything else.
 
-All methods of this helper have an identifier as the first argument. This is an
+All methods of this helper have an identifier as the first argument. This is a
 unique value for each program. This way, the helper can debug information for
 multiple programs at the same time. When using the
 :doc:`Process component </components/process>`, you probably want to use
@@ -26,7 +26,7 @@ multiple programs at the same time. When using the
 
 .. tip::
 
-    This information is often too verbose to show by default. You can use
+    This information is often too verbose to be shown by default. You can use
     :ref:`verbosity levels <verbosity-levels>` to only show it when in
     debugging mode (``-vvv``).
 
@@ -62,8 +62,17 @@ Some programs give output while they are running. This information can be shown
 using
 :method:`Symfony\\Component\\Console\\Helper\\DebugFormatterHelper::progress`::
 
+    use Symfony\Component\Process\Process;
+
+    // ...
+    $process = new Process(...);
+
+    $process->run(function ($type, $buffer) use ($output, $debugFormatter, $process) {
+        $output->writeln(
+            $debugFormatter->progress(spl_object_hash($process), $buffer, Process::ERR === $type)
+        );
+    });
     // ...
-    $output->writeln($debugFormatter->progress(spl_object_hash($process), $buffer, Process::ERR === $type));
 
 In case of success, this will output:
 
@@ -80,18 +89,24 @@ And this in case of failure:
 The third argument is a boolean which tells the function if the output is error
 output or not. When ``true``, the output is considered error output.
 
-The fourth and fifth argument allow you to override the prefix for respectively
-the normal output and error output.
+The fourth and fifth argument allow you to override the prefix for the normal
+output and error output respectively.
 
 Stopping a Program
 ------------------
 
 When a program is stopped, you can use
-:method:`Symfony\\Component\\Console\\Helper\\DebugFormatterHelper::progress`
-to notify this to the users::
+:method:`Symfony\\Component\\Console\\Helper\\DebugFormatterHelper::run` to
+notify this to the users::
 
     // ...
-    $output->writeln($debugFormatter->progress(spl_object_hash($process), 'Some command description', $process->isSuccesfull()));
+    $output->writeln(
+        $debugFormatter->stop(
+            spl_object_hash($process),
+            'Some command description',
+            $process->isSuccessfull()
+        )
+    );
 
 This will output:
 

From 99f31fc212a66b329bfe3eb371e1ece744271c98 Mon Sep 17 00:00:00 2001
From: WouterJ <waldio.webdesign@gmail.com>
Date: Mon, 15 Dec 2014 11:53:01 +0100
Subject: [PATCH 3/3] Reordered list of helpers

---
 components/console/helpers/map.rst.inc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/components/console/helpers/map.rst.inc b/components/console/helpers/map.rst.inc
index ea7e472dca8..f1794ef3d5e 100644
--- a/components/console/helpers/map.rst.inc
+++ b/components/console/helpers/map.rst.inc
@@ -1,4 +1,3 @@
-* :doc:`/components/console/helpers/debug_formatter` (new in 2.6)
 * :doc:`/components/console/helpers/dialoghelper`
 * :doc:`/components/console/helpers/formatterhelper`
 * :doc:`/components/console/helpers/processhelper`
@@ -7,3 +6,4 @@
 * :doc:`/components/console/helpers/questionhelper`
 * :doc:`/components/console/helpers/table`
 * :doc:`/components/console/helpers/tablehelper`
+* :doc:`/components/console/helpers/debug_formatter` (new in 2.6)

<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Transitional//EN' 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd'>
<html xmlns='http://www.w3.org/1999/xhtml'>
<head>
<title>pFad - Phonifier reborn</title>
<meta http-equiv='Content-Type' content='text/html; charset=utf-8' />
</head>
<body>
<h1>Pfad - The Proxy pFad of &#169; 2024 Garber Painting. All rights reserved.</h1>


<!-- Disclaimer -->
<p>Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.</p>
<br>
<p>Alternative Proxies:</p><p><a href="http://rainy.clevelandohioweatherforecast.com/php-proxy/index.php?q=https://patch-diff.githubusercontent.com/raw/symfony/symfony-docs/pull/4485.patch" target="_blank">Alternative Proxy</a></p><p><a href="http://rainy.clevelandohioweatherforecast.com/pFad/index.php?u=https://patch-diff.githubusercontent.com/raw/symfony/symfony-docs/pull/4485.patch" target="_blank">pFad Proxy</a></p><p><a href="http://rainy.clevelandohioweatherforecast.com/pFad/v3index.php?u=https://patch-diff.githubusercontent.com/raw/symfony/symfony-docs/pull/4485.patch" target="_blank">pFad v3 Proxy</a></p><p><a href="http://rainy.clevelandohioweatherforecast.com/pFad/v4index.php?u=https://patch-diff.githubusercontent.com/raw/symfony/symfony-docs/pull/4485.patch" target="_blank">pFad v4 Proxy</a></p></body>
</html>