Skip to content

Added proc_open() stub for param-out #4261

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.

Sign up for GitHub

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

Open
wants to merge 8 commits into
base: 2.1.x
Choose a base branch
from
+90 −0
Open

Added proc_open() stub for param-out #4261

Changes from 5 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
915cf39
Added proc_open() stub for param-out
staabm Aug 26, 2025
7700e12
fix types
staabm Aug 26, 2025
b90abfb
iterable types
staabm Aug 26, 2025
88c1fb4
fix php 7.4
staabm Aug 26, 2025
b56ad89
Update core.stub
staabm Aug 27, 2025
45a2620
regression test
staabm Aug 30, 2025
605a5f3
more precise types
staabm Aug 30, 2025
036ce45
simplify
staabm Aug 30, 2025
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
13 changes: 13 additions & 0 deletions stubs/core.stub
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -362,3 +362,16 @@ function header_register_callback(callable $callback): bool {}
* @param-later-invoked-callable $callback
*/
function register_tick_function(callable $callback, mixed ...$args): bool {}

/**
* @param string|array<string> $command
* @param list<list<string>|resource> $descriptor_spec
* @param array<resource> $pipes
* @param array<mixed> $env_vars
* @param array<string, bool> $options
*
* @param-out list<resource> $pipes
Copy link

@mvorisek mvorisek Aug 27, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Suggested change
* @param string|array<string> $command
* @param list<list<string>|resource> $descriptor_spec
* @param array<resource> $pipes
* @param array<mixed> $env_vars
* @param array<string, bool> $options
*
* @param-out list<resource> $pipes
* @template P of int = int
*
* @param string|list<string> $command
* @param array<P, <list<string>|resource> $descriptor_spec
* @param array<string, mixed> $env_vars
* @param array<string, bool> $options
*
* @param-out array<P, resource> $pipes

reasoning:

@template / $descriptor_spec / $pipes

$descriptor_spec describes the pipes returned in $pipes and in my understanding the keys always match.

$pipes param-in type is not wanted as it can be anything, not only array, but also null/uninitialized variable. Like $matches in preg_match.

$env_vars

Only string keys should be allowed, as at least in bash keys cannot start with number.

*
* @return resource|false
*/
function proc_open($command, array $descriptor_spec, &$pipes, ?string $cwd, ?array $env_vars, ?array $options) {}
Copy link

Choose a reason for hiding this comment

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

Suggested change
function proc_open($command, array $descriptor_spec, &$pipes, ?string $cwd, ?array $env_vars, ?array $options) {}
function proc_open($command, array $descriptor_spec, &$pipes, ?string $cwd = null, ?array $env_vars = null, ?array $options = null) {}

not sure if needed in stubs

Loading