Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork5.2k
[Process] Add doc for Process::disableOutput and Process::enableOutput#3664
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
28 changes: 28 additions & 0 deletionscomponents/process.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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``. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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) | ||
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.