Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Process] Add doc for Process::disableOutput and Process::enableOutput #3664

Merged
merged 1 commit into from
Mar 18, 2014
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions components/process.rst
Original file line number Diff line number Diff line change
Expand Up @@ -281,6 +281,34 @@ You can access the `pid`_ of a running process with the
you may have to prefix your commands with `exec`_. Please read
`Symfony Issue#5759`_ to understand why this is happening.

Disabling Output
----------------

.. versionadded:: 2.5
The :method:`Symfony\\Component\\Process\\Process::disableOutput` and
:method:`Symfony\\Component\\Process\\Process::enableOutput` methods were
introduced in Symfony 2.5.

As standard output and error output are always fetched from the underlying process,
it might be convenient to disable output in some cases to save memory.
Use :method:`Symfony\\Component\\Process\\Process::disableOutput` and
:method:`Symfony\\Component\\Process\\Process::enableOutput` to toggle this feature::

use Symfony\Component\Process\Process;

$process = new Process('/usr/bin/php worker.php');
$process->disableOutput();
$process->run();

.. caution::

You can not enable or disable the output while the process is running.

If you disable the output, you cannot access ``getOutput``,
``getIncrementalOutput``, ``getErrorOutput`` or ``getIncrementalErrorOutput``.
Moreover, you could not pass a callback to the ``start``, ``run`` or ``mustRun``
methods or use ``setIdleTimeout``.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've added this note


.. _`Symfony Issue#5759`: https://github.com/symfony/symfony/issues/5759
.. _`PHP Bug#39992`: https://bugs.php.net/bug.php?id=39992
.. _`exec`: http://en.wikipedia.org/wiki/Exec_(operating_system)
Expand Down