proc_open
proc_open
Execute a command and open file pointers for input/output
**proc_open** $command array $descriptor_spec array $pipes $cwd $env_vars $options
is similar to
but provides a much greater degree of control over the program execution.
`proc_open``popen`
commandThe commandline to execute as string. Special characters have to be properly escaped,
and proper quoting has to be applied.
Opmerking: > On , unless is set to true in , the is passed to (actually, ) with the flag as string (i.e. exactly as has been given to ). This can cause to remove enclosing quotes from (for details see the documentation), resulting in unexpected, and potentially even dangerous behavior, because error messages may contain (parts of) the passed (see example below). Windows
bypass_shell``options``command``%ComSpec%``/cunquotedproc_open``command``command
As of PHP 7.4.0, may be passed as array of command parameters.
In this case the process will be opened directly (without going through a shell)
and PHP will take care of any necessary argument escaping.
`command`
Opmerking: > On Windows, the argument escaping of the array elements assumes that the command line parsing of the executed command is compatible with the parsing of command line arguments done by the VC runtime.
descriptor_specAn indexed array where the key represents the descriptor number and the
value represents how PHP will pass that descriptor to the child
process. 0 is stdin, 1 is stdout, while 2 is stderr.
Each element can be:
`pipe``r``w``file``w``r``STDIN`
The file descriptor numbers are not limited to 0, 1 and 2 - you may specify any valid file descriptor number and it will be passed to the child process. This allows your script to interoperate with other scripts that run as "co-processes". In particular, this is useful for passing passphrases to programs like PGP, GPG and openssl in a more secure manner. It is also useful for reading status information provided by those programs on auxiliary file descriptors.
pipesWill be set to an indexed array of file pointers that correspond to
PHP's end of any pipes that are created.
cwd
The initial working dir for the command. This must be an
directory path, or null
if you want to use the default value (the working dir of the current
PHP process)
absolute
env_varsAn array with the environment variables for the command that will be
run, or null to use the same environment as the current PHP process
options
Allows you to specify additional options. Currently supported options
include:
`suppress_errors``bypass_shell``cmd.exe``blocking_pipes``create_process_group``CTRL``create_new_console`
Returns a resource representing the process, which should be freed using
when you are finished with it. On failure
returns false.
proc_close
As of PHP 8.3.0, throws a if
is an array without at least one
non-empty element.
command
Voorbeeld: A example
<?php
$descriptorspec = array(
0 => array("pipe", "r"), // stdin is a pipe that the child will read from
1 => array("pipe", "w"), // stdout is a pipe that the child will write to
2 => array("file", "/tmp/error-output.txt", "a") // stderr is a file to write to
);
$cwd = '/tmp';
$env = array('some_option' => 'aeiou');
$process = proc_open('php', $descriptorspec, $pipes, $cwd, $env);
if (is_resource($process)) {
// $pipes now looks like this:
// 0 => writeable handle connected to child stdin
// 1 => readable handle connected to child stdout
// Any error output will be appended to /tmp/error-output.txt
fwrite($pipes[0], '<?php print_r($_ENV); ?>');
fclose($pipes[0]);
echo stream_get_contents($pipes[1]);
fclose($pipes[1]);
// It is important that you close any pipes before calling
// proc_close in order to avoid a deadlock
$return_value = proc_close($process);
echo "command returned $return_value\n";
}
?>
Array
(
[some_option] => aeiou
[PWD] => /tmp
[SHLVL] => 1
[_] => /usr/local/bin/php
)
command returned 0
Voorbeeld: quirk on Windows
While one may expect the following program to search the file
for the text and
to print the results, it behaves rather differently.
`search`
<?php
$descriptorspec = [STDIN, STDOUT, STDOUT];
$cmd = '"findstr" "search" "filename.txt"';
$proc = proc_open($cmd, $descriptorspec, $pipes);
proc_close($proc);
?>
'findstr" "search" "filename.txt' is not recognized as an internal or external command,
operable program or batch file.
To work around that behavior, it is usually sufficient to enclose the
in additional quotes:
`command`
$cmd = '""findstr" "search" "filename.txt""';
Opmerking: > Windows compatibility: Descriptors beyond 2 (stderr) are made available to the child process as inheritable handles, but since the Windows architecture does not associate file descriptor numbers with low-level handles, the child process does not (yet) have a means of accessing those handles. Stdin, stdout and stderr work as expected.
Opmerking: > If you only need a uni-directional (one-way) process pipe, use instead, as it is much easier to use.
popen
popen``exec``system``passthru``stream_selectbacktick operator