feature #7833 Documented the getIterator() method (javiereguiluz)

xabbuh · xabbuh · commit a6c5de8227c1 · 2017-05-11T09:48:53.000+02:00
This PR was squashed before being merged into the 3.2 branch (closes #7833). Discussion ---------- Documented the getIterator() method This fixes #7184. Commits ------- c84cb10 Documented the getIterator() method
diff --git a/components/process.rst b/components/process.rst
@@ -69,6 +69,22 @@ for new output before going to the next iteration::
         }
     }
 
+.. tip::
+
+    The Process component internally uses a PHP iterator to get the output while
+    it is generated. That iterator is exposed via the ``getIterator()`` method
+    to allow customizing its behavior::
+
+        $process = new Process('ls -lsa');
+        $process->start();
+        $iterator = $process->getIterator($process::ITER_SKIP_ERR | $process::ITER_KEEP_OUTPUT);
+        foreach ($iterator as $data) {
+            echo $data."\n";
+        }
+
+    .. versionadded:: 3.2
+        The ``getIterator()`` method was introduced in Symfony 3.2.
+
 The ``mustRun()`` method is identical to ``run()``, except that it will throw
 a :class:`Symfony\\Component\\Process\\Exception\\ProcessFailedException`
 if the process couldn't be executed successfully (i.e. the process exited
