opensourcemirror/phpstorm-stubs
1
0
Fork 0
mirror of https://github.com/JetBrains/phpstorm-stubs.git synced 2024-09-12 18:50:49 +02:00
Code Issues Releases Wiki Activity
No description
3948 commits 18 branches 17 tags 20 MiB
PHP 99.8%
Dockerfile 0.2%
Find a file
Ivan Fedorov 63db92ae3d update stubs map
2024-09-06 15:20:48 +02:00
.github/workflows massive update tests 2024-08-25 22:45:53 +02:00
.idea [phpstorm-stubs] suppress PhpInconsistentReturnPointsInspection in stubs 2022-07-15 21:43:34 +02:00
aerospike update stubs 2024-08-25 23:18:07 +02:00
amqp Update amqp.php 2024-05-28 19:02:53 +02:00
apache batch update of all stubs with defined code style 2021-03-17 17:45:32 +03:00
apcu batch update of all stubs with defined code style 2021-03-17 17:45:32 +03:00
ast [phpstorm-stubs] replace deprecated cs-fixer rule with a modern one 2022-02-23 17:45:11 +01:00
bcmath update stubs 2024-08-25 23:18:07 +02:00
blackfire Transaction related transactions are static 2022-03-15 15:06:42 +01:00
brotli Removed space 2024-04-17 10:03:08 +02:00
bz2 Add ArrayShape attributes for functions 2022-10-17 11:21:37 +02:00
calendar Add ArrayShape attributes for functions 2022-10-17 11:21:37 +02:00
cassandra Fix: of of => of 2023-02-20 11:01:57 +01:00
com_dotnet batch update of all stubs with defined code style 2021-03-17 17:45:32 +03:00
Core Use TKey in ArrayAccess::offsetExists(), offsetGet() 2024-08-26 13:10:58 +02:00
couchbase [phpstorm-stubs] WI-75601 fix wrong typehint 2024-01-15 12:53:54 +01:00
couchbase_v2 [phpstorm-stubs] replace deprecated cs-fixer rule with a modern one 2022-02-23 17:45:11 +01:00
crypto batch update of all stubs with defined code style 2021-03-17 17:45:32 +03:00
ctype WI-62004 Deprecations for PHP 8.1 2021-08-11 16:26:16 +03:00
cubrid [phpstorm-stubs] WI-74930 add cubrid_lob2_write function stub 2023-11-03 12:54:06 +01:00
curl use php 8.4 beta 4 2024-09-01 16:35:14 +02:00
date update stubs 2024-08-25 23:18:07 +02:00
dba update stubs 2024-08-25 23:18:07 +02:00
decimal [phpstorm-stubs] replace deprecated cs-fixer rule with a modern one 2022-02-23 17:45:11 +01:00
dio CS Fixer fixes 2022-03-25 09:52:40 +01:00
dom update stubs 2024-08-25 23:18:07 +02:00
ds php-ds: add missed return types for the getIterator() methods 2024-01-17 11:11:03 +01:00
eio [phpstorm-stubs] WI-65025 add stubs for eio extension 2022-02-18 11:02:20 +01:00
elastic_apm Add stubs for elastic_apm extension 2021-11-23 18:09:59 +01:00
enchant update cs-fixer to latest stable version 2021-05-09 12:48:46 +03:00
Ev fix cs-fixer 2024-03-15 13:01:43 +01:00
event [phpstorm-stubs] replace deprecated cs-fixer rule with a modern one 2022-02-23 17:45:11 +01:00
exif batch update of all stubs with defined code style 2021-03-17 17:45:32 +03:00
expect batch update of all stubs with defined code style 2021-03-17 17:45:32 +03:00
fann batch update of all stubs with defined code style 2021-03-17 17:45:32 +03:00
FFI Fix FFI\CType::TYPE_LONG_DOUBLE constant typo. 2022-06-28 12:18:48 +02:00
ffmpeg batch update of all stubs with defined code style 2021-03-17 17:45:32 +03:00
fileinfo update stubs 2024-08-25 23:18:07 +02:00
filter Bulk changes based on https://github.com/JetBrains/phpstorm-stubs/pull/1411 2022-07-27 17:56:51 +02:00
fpm fpm_get_status may return false if the fpm scoreboard is locked or unavailable. 2022-10-06 17:37:46 +02:00
frankenphp bool to false 2024-08-27 13:47:20 +02:00
ftp [phpstorm-stubs] fix cs-fixer errors 2023-12-15 20:42:51 +01:00
gd update stubs 2024-08-25 23:18:07 +02:00
gearman Fixes types on $unique of Gearman task methods 2024-08-20 15:52:18 +02:00
geoip batch update of all stubs with defined code style 2021-03-17 17:45:32 +03:00
geos batch update of all stubs with defined code style 2021-03-17 17:45:32 +03:00
gettext update stubs 2024-08-25 23:18:07 +02:00
gmagick [phpstorm-stubs] replace deprecated cs-fixer rule with a modern one 2022-02-23 17:45:11 +01:00
gmp update stubs 2024-08-25 23:18:07 +02:00
gnupg Update gnupg.php 2024-08-28 11:10:44 +02:00
grpc Fix parameter definition for Grpc\ChannelCredentials::createSsl 2021-09-09 18:57:58 +02:00
hash update stubs 2024-08-25 23:18:07 +02:00
http [phpstorm-stubs] fix cs-fixer errors 2023-12-15 20:42:51 +01:00
ibm_db2 [phpstorm-stubs] WI-74929 add db2_pclose function stub 2023-11-03 12:43:57 +01:00
iconv Add ArrayShape attributes for functions 2022-10-17 11:21:37 +02:00
igbinary batch update of all stubs with defined code style 2021-03-17 17:45:32 +03:00
imagick Mark Imagick::destroy as deprecated 2024-08-26 10:06:19 +02:00
imap fix param type in imap_headerinfo 2024-03-24 13:22:58 +01:00
inotify fix stubs according to reflection for new extensions 2021-03-18 17:50:44 +03:00
interbase Remove empty comments 2023-01-15 10:26:23 +01:00
intl update stubs 2024-08-25 23:18:07 +02:00
json Fix JSON_OBJECT_AS_ARRAY flag documentation 2024-04-02 16:08:19 +02:00
judy [phpstorm-stubs] replace deprecated cs-fixer rule with a modern one 2022-02-23 17:45:11 +01:00
ldap update stubs 2024-08-25 23:18:07 +02:00
leveldb batch update of all stubs with defined code style 2021-03-17 17:45:32 +03:00
libevent update cs-fixer to latest stable version 2021-05-09 12:48:46 +03:00
libsodium update stubs 2024-08-25 23:18:07 +02:00
libvirt-php Fix phpdoc blocks 2021-04-12 00:14:29 +03:00
libxml update stubs 2024-08-25 23:18:07 +02:00
lua batch update of all stubs with defined code style 2021-03-17 17:45:32 +03:00
LuaSandbox [phpstorm-stubs] replace deprecated cs-fixer rule with a modern one 2022-02-23 17:45:11 +01:00
lzf batch update of all stubs with defined code style 2021-03-17 17:45:32 +03:00
mailparse mailparse_msg_get_part() can return false 2023-03-13 12:34:42 +01:00
mapscript batch update of all stubs with defined code style 2021-03-17 17:45:32 +03:00
mbstring update stubs 2024-08-25 23:18:07 +02:00
mcrypt [phpstorm-stubs] update deprecations 2022-01-05 13:50:04 +01:00
memcache [phpstorm-stubs] replace deprecated cs-fixer rule with a modern one 2022-02-23 17:45:11 +01:00
memcached Documented Memcached checkKey method 2022-12-06 21:50:18 +01:00
meminfo batch update of all stubs with defined code style 2021-03-17 17:45:32 +03:00
meta make explicit nullable types in ExpectedValues attribute 2024-09-06 15:20:48 +02:00
ming batch update of all stubs with defined code style 2021-03-17 17:45:32 +03:00
mongo [phpstorm-stubs] replace deprecated cs-fixer rule with a modern one 2022-02-23 17:45:11 +01:00
mongodb update stubs 2024-08-25 23:18:07 +02:00
mosquitto-php update stubs 2024-08-25 23:18:07 +02:00
mqseries batch update of all stubs with defined code style 2021-03-17 17:45:32 +03:00
msgpack batch update of all stubs with defined code style 2021-03-17 17:45:32 +03:00
mssql batch update of all stubs with defined code style 2021-03-17 17:45:32 +03:00
mysql allow stdClass 2021-12-04 15:33:33 +01:00
mysql_xdevapi batch update of all stubs with defined code style 2021-03-17 17:45:32 +03:00
mysqli use php 8.4 beta 4 2024-09-01 16:35:14 +02:00
ncurses batch update of all stubs with defined code style 2021-03-17 17:45:32 +03:00
newrelic [newrelic] Add missing "newrelic_set_user_id" function definition 2024-05-28 19:03:16 +02:00
oauth update cs-fixer to latest stable version 2021-05-09 12:48:46 +03:00
oci8 [phpstorm-stubs] WI-74925 add oci_set_prefetch_lob function stub 2023-11-03 13:31:13 +01:00
odbc add new extensions and update stubs 2024-08-29 11:55:29 +02:00
openssl update stubs 2024-08-25 23:18:07 +02:00
opentelemetry fixing param typehint 2023-10-04 15:43:47 +02:00
pam Fix error default value for pam functions 2024-08-26 13:04:28 +02:00
parallel batch update of all stubs with defined code style 2021-03-17 17:45:32 +03:00
Parle Add template annotations for Parle\Stack 2024-01-13 08:35:40 +01:00
pcntl minor formatting fix 2024-09-01 16:35:14 +02:00
pcov cleanup pcov 2021-08-03 13:32:00 +02:00
pcre [phpstorm-stubs] Update value of PCRE_VERSION_MINOR 2023-10-30 18:41:37 +01:00
pdflib fix cs-fixer issues 2024-04-17 12:35:07 +02:00
PDO update stubs 2024-08-25 23:18:07 +02:00
pgsql update stubs 2024-08-25 23:18:07 +02:00
Phar use php 8.4 beta 4 2024-09-01 16:35:14 +02:00
phpdbg Add stubs for sapi/phpdbg functions 2020-05-13 21:20:22 +03:00
posix update stubs 2024-08-25 23:18:07 +02:00
pq update stubs 2024-08-25 23:18:07 +02:00
pspell [phpstorm-stubs] fix default values according to reflection 2022-01-20 12:50:21 +01:00
pthreads batch update of all stubs with defined code style 2021-03-17 17:45:32 +03:00
radius batch update of all stubs with defined code style 2021-03-17 17:45:32 +03:00
random update stubs 2024-08-25 23:18:07 +02:00
rar [phpstorm-stubs] replace deprecated cs-fixer rule with a modern one 2022-02-23 17:45:11 +01:00
rdkafka fixed return type RdKafka\ConsumerTopic::consume() 2022-10-14 11:43:20 +02:00
readline Add ArrayShape attributes for functions 2022-10-17 11:21:37 +02:00
recode [phpstorm-stubs] update deprecations 2022-01-05 13:50:04 +01:00
redis fix return tag for redis stub 2024-08-26 16:10:31 +02:00
Reflection use php 8.4 beta 4 2024-09-01 16:35:14 +02:00
regex batch update of all stubs with defined code style 2021-03-17 17:45:32 +03:00
relay fix styling 2024-05-30 11:04:40 +02:00
rpminfo [phpstorm-stubs] WI-74924 add rpmaddtag function stub 2023-11-03 12:07:35 +01:00
rrd batch update of all stubs with defined code style 2021-03-17 17:45:32 +03:00
SaxonC batch update of all stubs with defined code style 2021-03-17 17:45:32 +03:00
session WI-77313 remove redundant methods. 2024-04-29 14:35:57 +02:00
shmop batch update of all stubs with defined code style 2021-03-17 17:45:32 +03:00
simdjson Added simdjson stubs. 2023-12-01 12:49:33 +01:00
simple_kafka_client [phpstorm-stubs] replace deprecated cs-fixer rule with a modern one 2022-02-23 17:45:11 +01:00
SimpleXML update stubs 2024-08-25 23:18:07 +02:00
snappy/snappy Updated StubsMap and fixed formatting. 2022-04-08 16:44:22 +02:00
snmp [phpstorm-stubs] replace deprecated cs-fixer rule with a modern one 2022-02-23 17:45:11 +01:00
soap update stubs 2024-08-25 23:18:07 +02:00
sockets use php 8.4 beta 4 2024-09-01 16:35:14 +02:00
sodium [phpstorm-stubs] update stubs according to latest php version 2024-01-13 00:28:28 +01:00
solr batch update of all stubs with defined code style 2021-03-17 17:45:32 +03:00
SPL SplFile{Info,Object} stub fixes 2024-08-26 09:42:46 +02:00
SplType batch update of all stubs with defined code style 2021-03-17 17:45:32 +03:00
SQLite [phpstorm-stubs] move SQLITE3_DETERMINISTIC to correct stub 2022-11-03 21:45:55 +01:00
sqlite3 update stubs 2024-08-25 23:18:07 +02:00
sqlsrv batch update of all stubs with defined code style 2021-03-17 17:45:32 +03:00
ssh2 [phpstorm-stubs] WI-74921 add ssh2_send_eof function stub 2023-11-03 13:38:01 +01:00
standard add magic constant __PROPERTY__ 2024-09-05 15:59:44 +02:00
stats batch update of all stubs with defined code style 2021-03-17 17:45:32 +03:00
stomp batch update of all stubs with defined code style 2021-03-17 17:45:32 +03:00
suhosin batch update of all stubs with defined code style 2021-03-17 17:45:32 +03:00
superglobals Add missing $_SERVER superglobals 2024-01-13 00:31:52 +01:00
svm update stubs 2024-08-25 23:18:07 +02:00
svn [phpstorm-stubs] replace deprecated cs-fixer rule with a modern one 2022-02-23 17:45:11 +01:00
swoole Remove Swoole SIG- and PRIO- pcntl constants redefinitions. 2022-03-10 17:27:04 +01:00
sybase update cs-fixer to latest stable version 2021-05-09 12:48:46 +03:00
sync fix typehints in extensions according to reflections 2021-07-28 13:42:43 +02:00
sysvmsg update stubs 2024-08-25 23:18:07 +02:00
sysvsem batch update of all stubs with defined code style 2021-03-17 17:45:32 +03:00
sysvshm batch update of all stubs with defined code style 2021-03-17 17:45:32 +03:00
tests use php 8.4 beta 4 2024-09-01 16:35:14 +02:00
tidy add new extensions and update stubs 2024-08-29 11:55:29 +02:00
tokenizer use php 8.4 beta 4 2024-09-01 16:35:14 +02:00
uopz update stubs for uopz 2021-08-14 20:08:16 +02:00
uploadprogress Add stubs for uploadprogress PECL extension 2022-01-20 07:49:42 +01:00
uuid batch update of all stubs with defined code style 2021-03-17 17:45:32 +03:00
uv Fix uv stubs 2024-04-08 13:11:20 +02:00
v8js [phpstorm-stubs] improve PhpDocs a bit 2022-05-03 13:08:34 +02:00
wddx add new extensions and update stubs 2024-08-29 11:55:29 +02:00
win32service batch update of all stubs with defined code style 2021-03-17 17:45:32 +03:00
winbinder cleanup winbinder 2021-08-03 13:32:00 +02:00
wincache Fix phpdoc blocks 2021-04-12 00:14:29 +03:00
xcache add more type fixes + fix phpdoc syntax 2020-12-21 17:43:34 +03:00
xdebug update stubs 2024-08-25 23:18:07 +02:00
xdiff csfixer + format function 2021-08-14 20:08:16 +02:00
xhprof batch update of all stubs with defined code style 2021-03-17 17:45:32 +03:00
xlswriter [phpstorm-stubs] replace deprecated cs-fixer rule with a modern one 2022-02-23 17:45:11 +01:00
xml update stubs 2024-08-25 23:18:07 +02:00
xmlreader update stubs 2024-08-25 23:18:07 +02:00
xmlrpc batch update of all stubs with defined code style 2021-03-17 17:45:32 +03:00
xmlwriter update stubs 2024-08-25 23:18:07 +02:00
xsl add new extensions and update stubs 2024-08-29 11:55:29 +02:00
xxtea batch update of all stubs with defined code style 2021-03-17 17:45:32 +03:00
yaf Code review fixes 2024-04-03 23:27:18 +02:00
yaml batch update of all stubs with defined code style 2021-03-17 17:45:32 +03:00
yar [phpstorm-stubs] replace deprecated cs-fixer rule with a modern one 2022-02-23 17:45:11 +01:00
zend [phpstorm-stubs] replace deprecated cs-fixer rule with a modern one 2022-02-23 17:45:11 +01:00
Zend OPcache Add opcache jit to arrayshape 2023-01-25 14:23:06 +01:00
ZendCache Added missing zend_disk_cache_info and zend_shm_cache_info functions 2021-09-07 13:17:50 +02:00
ZendDebugger batch update of all stubs with defined code style 2021-03-17 17:45:32 +03:00
ZendUtils batch update of all stubs with defined code style 2021-03-17 17:45:32 +03:00
zip add new extensions and update stubs 2024-08-29 11:55:29 +02:00
zlib [phpstorm-stubs] fix default values according to reflection 2022-01-20 12:50:21 +01:00
zmq [phpstorm-stubs] replace deprecated cs-fixer rule with a modern one 2022-02-23 17:45:11 +01:00
zookeeper [phpstorm-stubs] replace deprecated cs-fixer rule with a modern one 2022-02-23 17:45:11 +01:00
zstd minor reformat 2021-03-24 23:44:07 +03:00
.gitignore [phpstorm-stubs] use composer install instead of composer update 2023-09-07 08:46:31 +02:00
.php-cs-fixer.php [phpstorm-stubs] fix cs-fixer rules 2024-01-13 00:28:28 +01:00
.space.kts Warmup jobs 2021-11-24 15:32:25 +00:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2023-02-01 22:24:18 +01:00
composer.json massive update tests 2024-08-25 22:45:53 +02:00
composer.lock massive update tests 2024-08-25 22:45:53 +02:00
CONTRIBUTING.md Remove more unnecessary dir args 2022-03-21 10:22:36 +01:00
docker-compose.yml massive update tests 2024-08-25 22:45:53 +02:00
Inspections.xml qodana: try custom inspections profile 2021-02-01 18:13:25 +03:00
LICENSE Create LICENSE 2023-02-01 22:11:29 +01:00
PhpStormStubsMap.php update stubs map 2024-09-06 15:20:48 +02:00
phpunit.xml.dist massive update tests 2024-08-25 22:45:53 +02:00
qodana.yaml [phpstorm-stubs] fix stubs dirs in qodana config 2021-11-14 08:36:23 +01:00
README.md Update Redis stub from an very outdated version to the latest stable version 2024-08-26 15:17:34 +02:00
runTests.sh Convert stub map check into a phpunit test and add it to tests runner 2022-03-21 10:22:36 +01:00

README.md

phpstorm-stubs

official JetBrains project License Total Downloads

PhpStorm Stubs Tests PhpStorm Stubs PECL Test PhpStorm Stubs Check Links

STUBS are normal, syntactically correct PHP files that contain function & class signatures, constant definitions, etc. for all built-in PHP stuff and most standard extensions. Stubs need to include complete PHPDOC, especially proper @return annotations.

An IDE needs them for completion, code inspection, type inference, doc popups, etc. Quality of most of these services depend on the quality of the stubs (basically their PHPDOC @annotations).

Note that the stubs for “non-standard” extensions are provided as is. (Non-Standard extensions are the ones that are not part of PHP Core or are not Bundled/External - see the complete list here.)

The support for such “non-standard” stubs is community-driven, and we only validate their PHPDoc. We do not check whether a stub matches the actual extension or whether the provided descriptions are correct.

Please note that currently there are no tests for the thrown exceptions so @throws tags should be checked manually according to official docs or PHP source code

Relevant open issues

Contribution process

Contribution process

Updating the IDE

Have a full copy of the .git repo within an IDE and provide its path in Settings | Languages & Frameworks | PHP | PHP Runtime | Advanced settings | Default stubs path. It should then be easily updatable both ways via normal git methods.

Extensions enabled by default

The set of extensions enabled by default in PhpStorm can change anytime without prior notice. To learn how to view the enabled extensions, look here.

How to run tests

  1. Execute docker compose -f docker-compose.yml run test_runner composer install --ignore-platform-reqs
  2. Execute docker compose -f docker-compose.yml run -e PHP_VERSION=8.0 test_runner vendor/bin/phpunit --testsuite PHP_8.0

How to update stub map

Execute docker compose -f docker-compose.yml run test_runner /usr/local/bin/php tests/Tools/generate-stub-map and commit the resulting PhpStormStubsMap.php

License

Apache 2

contains material by the PHP Documentation Group, licensed with CC-BY 3.0