Skip to content

Use list-shapes for functionMap return types that are guaranteed lists #6024

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
zonuexe wants to merge 1 commit into
base: 2.2.x
Choose a base branch
from
+14 −14
Open

Use list-shapes for functionMap return types that are guaranteed lists #6024

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
26 changes: 13 additions & 13 deletions resources/functionMap.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2393,7 +2393,7 @@
'ffmpeg_movie::hasAudio' => ['bool'],
'ffmpeg_movie::hasVideo' => ['bool'],
'fgetc' => ['string|false', 'fp'=>'resource'],
'fgetcsv' => ['non-empty-list<string>|array{0: null}|false|null', 'fp'=>'resource', 'length='=>'0|positive-int|null', 'delimiter='=>'string', 'enclosure='=>'string', 'escape='=>'string'],
'fgetcsv' => ['non-empty-list<string>|list{null}|false|null', 'fp'=>'resource', 'length='=>'0|positive-int|null', 'delimiter='=>'string', 'enclosure='=>'string', 'escape='=>'string'],
'fgets' => ['string|false', 'fp'=>'resource', 'length='=>'0|positive-int'],
'fgetss' => ['string|false', 'fp'=>'resource', 'length='=>'0|positive-int', 'allowable_tags='=>'string'],
'file' => ['list<string>|false', 'filename'=>'string', 'flags='=>'int-mask<FILE_USE_INCLUDE_PATH|FILE_IGNORE_NEW_LINES|FILE_SKIP_EMPTY_LINES|FILE_NO_DEFAULT_CONTEXT>', 'context='=>'resource'],
Expand Down Expand Up @@ -3401,7 +3401,7 @@
'hexdec' => ['int|float', 'hexadecimal_number'=>'string'],
'highlight_file' => ['string|bool', 'file_name'=>'string', 'return='=>'bool'],
'highlight_string' => ['string|bool', 'string'=>'string', 'return='=>'bool'],
'hrtime' => ['array{0:int,1:int}|int|float|false', 'get_as_number='=>'bool'],
'hrtime' => ['list{int,int}|int|float|false', 'get_as_number='=>'bool'],
'HRTime\PerformanceCounter::getElapsedTicks' => ['int'],
'HRTime\PerformanceCounter::getFrequency' => ['int'],
'HRTime\PerformanceCounter::getLastElapsedTicks' => ['int'],
Expand Down Expand Up @@ -3995,8 +3995,8 @@
'image_type_to_mime_type' => ['string', 'imagetype'=>'int'],
'imageaffine' => ['resource|false', 'src'=>'resource', 'affine'=>'array', 'clip='=>'array'],
'imageaffineconcat' => ['array', 'm1'=>'array', 'm2'=>'array'],
'imageaffinematrixconcat' => ['array{0:float,1:float,2:float,3:float,4:float,5:float}|false', 'm1'=>'array', 'm2'=>'array'],
'imageaffinematrixget' => ['array{0:float,1:float,2:float,3:float,4:float,5:float}|false', 'type'=>'int', 'options'=>'array|float'],
'imageaffinematrixconcat' => ['list{float,float,float,float,float,float}|false', 'm1'=>'array', 'm2'=>'array'],
'imageaffinematrixget' => ['list{float,float,float,float,float,float}|false', 'type'=>'int', 'options'=>'array|float'],
'imagealphablending' => ['bool', 'im'=>'resource', 'on'=>'bool'],
'imageantialias' => ['bool', 'im'=>'resource', 'on'=>'bool'],
'imagearc' => ['bool', 'im'=>'resource', 'cx'=>'int', 'cy'=>'int', 'w'=>'int', 'h'=>'int', 's'=>'int', 'e'=>'int', 'col'=>'int'],
Expand Down Expand Up @@ -4143,9 +4143,9 @@
'Imagick::colorMatrixImage' => ['bool', 'color_matrix'=>'array'],
'Imagick::combineImages' => ['Imagick', 'channeltype'=>'Imagick::CHANNEL_*'],
'Imagick::commentImage' => ['bool', 'comment'=>'string'],
'Imagick::compareImageChannels' => ['array{Imagick,float}', 'image'=>'imagick', 'channeltype'=>'Imagick::CHANNEL_*', 'metrictype'=>'Imagick::METRIC_*'],
'Imagick::compareImageChannels' => ['list{Imagick,float}', 'image'=>'imagick', 'channeltype'=>'Imagick::CHANNEL_*', 'metrictype'=>'Imagick::METRIC_*'],
'Imagick::compareImageLayers' => ['Imagick', 'method'=>'Imagick::LAYERMETHOD_*'],
'Imagick::compareImages' => ['array{Imagick,float}', 'compare'=>'imagick', 'metric'=>'Imagick::METRIC_*'],
'Imagick::compareImages' => ['list{Imagick,float}', 'compare'=>'imagick', 'metric'=>'Imagick::METRIC_*'],
'Imagick::compositeImage' => ['bool', 'composite_object'=>'imagick', 'composite'=>'Imagick::COMPOSITE_*', 'x'=>'int', 'y'=>'int', 'channel='=>'Imagick::CHANNEL_*'],
'Imagick::compositeImageGravity' => ['bool', 'imagick'=>'Imagick', 'COMPOSITE_CONSTANT'=>'int', 'GRAVITY_CONSTANT'=>'int'],
'Imagick::contrastImage' => ['bool', 'sharpen'=>'bool'],
Expand Down Expand Up @@ -8192,7 +8192,7 @@
'preg_replace' => ['string|array|null', 'regex'=>'string|array', 'replace'=>'string|array', 'subject'=>'string|array', 'limit='=>'int', '&w_count='=>'int'],
'preg_replace_callback' => ['string|array|null', 'regex'=>'string|array', 'callback'=>'callable(array<int|string, string|null>):string', 'subject'=>'string|array', 'limit='=>'int', '&w_count='=>'int'],
'preg_replace_callback_array' => ['string|array|null', 'pattern'=>'array<string,callable>', 'subject'=>'string|array', 'limit='=>'int', '&w_count='=>'int'],
'preg_split' => ['list<string>|list<array{string, int<0, max>}>|false', 'pattern'=>'string', 'subject'=>'string', 'limit='=>'?int', 'flags='=>'int'],
'preg_split' => ['list<string>|list<list{string, int<0, max>}>|false', 'pattern'=>'string', 'subject'=>'string', 'limit='=>'?int', 'flags='=>'int'],
'prev' => ['mixed', '&rw_array_arg'=>'array|object'],
'print_r' => ['string|true', 'var'=>'mixed', 'return='=>'bool'],
'printf' => ['int', 'format'=>'string', '...values='=>'__stringAndStringable|int|float|null|bool'],
Expand Down Expand Up @@ -8641,7 +8641,7 @@
'Redis::geoadd' => ['__benevolent<Redis|int|false>', 'key'=>'string', 'lng'=>'float', 'lat'=>'float', 'member'=>'string', '...other_triples_and_options='=>'mixed'],
'Redis::geodist' => ['__benevolent<Redis|float|false>', 'key'=>'string', 'member'=>'string', '...other_members='=>'string'],
'Redis::geohash' => ['__benevolent<Redis|array<int,string>|false>', 'key'=>'string', 'member'=>'string', '...other_members='=>'string'],
'Redis::geopos' => ['__benevolent<Redis|array<int,array{0:string,1:string}>|false>', 'key'=>'string', 'member'=>'string', '...other_members'=>'string'],
'Redis::geopos' => ['__benevolent<Redis|array<int,list{string,string}>|false>', 'key'=>'string', 'member'=>'string', '...other_members'=>'string'],
'Redis::georadius' => ['__benevolent<Redis|array<int,mixed>>', 'key'=>'string', 'lng'=>'float', 'lat'=>'float', 'radius'=>'float', 'unit'=>'string', 'options='=>'array<string,mixed>'],
'Redis::georadiusbymember' => ['__benevolent<Redis|array<int,mixed>>', 'key'=>'string', 'lng'=>'float', 'lat'=>'float', 'radius'=>'float', 'unit'=>'string', 'options='=>'array<string,mixed>'],
'Redis::georadiusbymember_ro' => ['__benevolent<Redis|array<int,mixed>>', 'key'=>'string', 'lng'=>'float', 'lat'=>'float', 'radius'=>'float', 'unit'=>'string', 'options='=>'array<string,mixed>'],
Expand All @@ -8656,7 +8656,7 @@
'Redis::getOption' => ['int', 'name'=>'int'],
'Redis::getRange' => ['__benevolent<Redis|string|false>', 'key'=>'string', 'start'=>'int', 'end'=>'int'],
'Redis::getset' => ['__benevolent<Redis|string|false>', 'key'=>'string', 'value'=>'mixed'],
'Redis::getTransferredBytes' => ['array<int,array{0:int,1:int}>'],
'Redis::getTransferredBytes' => ['array<int,list{int,int}>'],
'Redis::hDel' => ['__benevolent<Redis|int|false>', 'key'=>'string', 'field'=>'string', '...other_fields='=>'string'],
'Redis::hExists' => ['__benevolent<Redis|bool>', 'key'=>'string', 'field'=>'string'],
'Redis::hGet' => ['__benevolent<Redis|string|false>', 'key'=>'string', 'member'=>'string'],
Expand Down Expand Up @@ -8773,7 +8773,7 @@
'Redis::sUnionStore' => ['__benevolent<Redis|int|false>', 'dst'=>'string', 'key'=>'string', '...other_keys='=>'string'],
'Redis::sunsubscribe' => ['__benevolent<Redis|string[]|false>', 'channels'=>'string[]'],
'Redis::swapdb' => ['__benevolent<Redis|bool>', 'src'=>'int', 'dst'=>'int'],
'Redis::time' => ['__benevolent<Redis|array{0:int,1:int}>'],
'Redis::time' => ['__benevolent<Redis|list{int,int}>'],
'Redis::ttl' => ['__benevolent<Redis|-2|-1|int|false>', 'key'=>'string'],
'Redis::type' => ['__benevolent<Redis|int|false>', 'key'=>'string'],
'Redis::unlink' => ['__benevolent<Redis|0|positive-int|false>', 'key'=>'string[]|string', '...other_keys'=>'string'],
Expand Down Expand Up @@ -9936,7 +9936,7 @@
'SplFileObject::fflush' => ['bool'],
'SplFileObject::fgetc' => ['string|false'],
// Do not believe https://www.php.net/manual/en/splfileobject.fgetcsv#refsect1-splfileobject.fgetcsv-returnvalues
'SplFileObject::fgetcsv' => ['non-empty-list<string>|array{0: null}|false|null', 'delimiter='=>'string', 'enclosure='=>'string', 'escape='=>'string'],
'SplFileObject::fgetcsv' => ['non-empty-list<string>|list{null}|false|null', 'delimiter='=>'string', 'enclosure='=>'string', 'escape='=>'string'],
'SplFileObject::fgets' => ['string'],
'SplFileObject::fgetss' => ['string|false', 'allowable_tags='=>'string'],
'SplFileObject::flock' => ['bool', 'operation'=>'int-mask<LOCK_SH, LOCK_EX, LOCK_UN, LOCK_NB>', '&w_wouldblock='=>'0|1'],
Expand Down Expand Up @@ -10831,7 +10831,7 @@
'SyncSharedMemory::size' => ['bool'],
'SyncSharedMemory::write' => ['', 'string='=>'string', 'start='=>'int'],
'sys_get_temp_dir' => ['string'],
'sys_getloadavg' => ['array{float,float,float}|false'],
'sys_getloadavg' => ['list{float,float,float}|false'],
'syslog' => ['bool', 'priority'=>'int', 'message'=>'string'],
'system' => ['string|false', 'command'=>'string', '&w_return_value='=>'int'],
'taint' => ['bool', '&rw_string'=>'string', '&...w_other_strings='=>'string'],
Expand Down Expand Up @@ -10963,7 +10963,7 @@
'timezone_transitions_get' => ['list<array{ts: int, time: string, offset: int, isdst: bool, abbr: string}>|false', 'object'=>'DateTimeZone', 'timestamp_begin='=>'int', 'timestamp_end='=>'int'],
'timezone_version_get' => ['string'],
'tmpfile' => ['__benevolent<resource|false>'],
'token_get_all' => ['list<string|array{0:int,1:string,2:int}>', 'source'=>'string', 'flags='=>'int'],
'token_get_all' => ['list<string|list{int,string,int}>', 'source'=>'string', 'flags='=>'int'],
'token_name' => ['non-falsy-string', 'type'=>'int'],
'TokyoTyrant::__construct' => ['void', 'host='=>'string', 'port='=>'int', 'options='=>'array'],
'TokyoTyrant::add' => ['int|float', 'key'=>'string', 'increment'=>'float', 'type='=>'int'],
Expand Down
2 changes: 1 addition & 1 deletion resources/functionMap_php80delta.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
'error_log' => ['bool', 'message'=>'string', 'message_type='=>'0|1|3|4', 'destination='=>'string', 'extra_headers='=>'string'],
'explode' => ['list<string>', 'separator'=>'non-empty-string', 'str'=>'string', 'limit='=>'int'],
'fdiv' => ['float', 'dividend'=>'float', 'divisor'=>'float'],
'fgetcsv' => ['non-empty-list<string>|array{0: null}|false', 'fp'=>'resource', 'length='=>'0|positive-int|null', 'delimiter='=>'string', 'enclosure='=>'string', 'escape='=>'string'],
'fgetcsv' => ['non-empty-list<string>|list{null}|false', 'fp'=>'resource', 'length='=>'0|positive-int|null', 'delimiter='=>'string', 'enclosure='=>'string', 'escape='=>'string'],
'filter_input' => ['mixed', 'type'=>'INPUT_GET|INPUT_POST|INPUT_COOKIE|INPUT_SERVER|INPUT_ENV', 'variable_name'=>'string', 'filter='=>'int', 'options='=>'array|int'],
'filter_input_array' => ['array|false|null', 'type'=>'INPUT_GET|INPUT_POST|INPUT_COOKIE|INPUT_SERVER|INPUT_ENV', 'definition='=>'int|array', 'add_empty='=>'bool'],
'floor' => ['float', 'number'=>'float'],
Expand Down
Loading