Skip to content

[Process] Documented the new PhpSubprocess feature #18693

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

Merged
merged 1 commit into from
Aug 8, 2023
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
44 changes: 44 additions & 0 deletions components/process.rst
Original file line number Diff line number Diff line change
Expand Up @@ -410,6 +410,50 @@ instead::
);
$process->run();

Executing a PHP child processes with the same configuration
-----------------------------------------------------------

.. versionadded:: 6.4

The ``PhpSubprocess`` helper was added in Symfony 6.4.

When you start a PHP process, it's started using its default ``ini`` settings. Let's assume you have a configured
``memory_limit`` of ``256M`` in your `php.ini` and you want to disable it when running your ``bin/console`` script to access
the Symfony console without any memory limit. You can then dynamically override it using the ``-d`` command line option
like so: ``php -d memory_limit=-1 bin/console app:my-command``.

Problem solved. However, let's assume you have an ``app:my-command`` that itself again, starts a PHP child process::

use Symfony\Component\Process\Process;

class MyCommand extends Command
{
protected function execute(InputInterface $input, OutputInterface $output): int
{
$childProcess = new Process(['bin/console', 'cache:pool:prune']);
}
}

What happens now is that PHP will start the ``bin/console cache:pool:prune`` command with a ``memory_limit`` of ``256M``. That's
because this is your ``ini`` setting.

If you want to make sure that the child processes inherit the dynamically adjusted configuration as well, there is only one
way to do that: You have to write a temporary ``ini`` file with all the current settings and start the child process using
``php -c temporary.ini bin/console cache:pool:prune``.

Doing this yourself can be cumbersome but don't worry, Symfony's got you covered! All you need to do is replace the
usage of ``Process`` with :class:`Symfony\\Component\\Process\\PhpSubprocess`::

use Symfony\Component\Process\PhpSubprocess;

class MyCommand extends Command
{
protected function execute(InputInterface $input, OutputInterface $output): int
{
$childProcess = new PhpSubprocess(['bin/console', 'cache:pool:prune']);
}
}

Process Timeout
---------------

Expand Down