Running a shell command
Nobody has claimed this yet.
- Dominant language
- C
- Stars
- 40.4k
- Forks
- 8.1k
- Avg merge
- 2d 13h
- Merged PRs (30d)
- 96
Description
Description
There's a handful of ways to run a command in PHP - I have to look this up every single time, and every time, I end up reaching the conclusion that none of them are exactly good.
The most common, most basic requirement is you just want to run a command, capture the output, and get the exit status code - it appears there is still no simple way to achieve this in PHP.
-
shell_execcan't reliably detect failures, doesn't return the status code, fails for binary output on Windows 👎 -
systemonly returns the last line of the command output. 👎 -
pcntl_execis not available on Windows 👎 -
popenrequires some hand holding and leads to bugs 👎 -
proc_openrequires even more hand holding and is difficult just to get it working at all 👎 -
passthrurequires an output buffer, which may be slightly less error prone than other options, but still 👎 -
execopens a command window (on Windows only?) 👎
Finally, there's the backtick operator, which, having dedicated syntax, seems like the most obvious option - but turns out to be an alias for shell_exec, being one of the worst options overall.
Of all these options, exec probably comes closest to fulfilling the most basic requirements - yet still falls short by opening a command window on Windows; behavior that is (I'm sure, for some historical reason) inconsistent with that of Linux.
Rather than suggesting we add yet another function to run a command, how about fixing this issue with exec?
Yes, that is technically a breaking change, but do we imagine anyone is writing Windows-specific PHP programs that rely on opening command windows, expecting interaction from the user? This seems highly unlikely.
I think it would be really great if this situation could finally be remedied, so that just running a simple command is simple and "feature-complete" with no cross-platform quirks - this should not be something that requires any mental gymnastics, and it should be extremely obvious and easy to find in the manual, e.g. with an opening note on every other manual page for all these other functions.
I'm not going to suggest deprecating any of these functions, as they are most likely all being used for something.
But wouldn't it be great if there was one clear choice going forward that "just works" for the 98% use case? 🙂
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the behavior and documentation of exec alongside shell_exec, system, pcntl_exec, popen, proc_open, passthru, and backticks, with particular attention to the Windows command-window behavior described here. Compare the existing output and exit-status requirements across Windows and Linux; done means the proposed exec behavior and its compatibility impact are clearly resolved.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php
- Domain
- cli
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100