Go to file
Maxim.Kolmakov ebef9b5bad Fix packagist update 2020-11-25 14:58:20 +01:00
.idea Update project language level 2020-10-19 13:16:16 +02:00
Core Php docs fixes from official docs: descriptions and types 2020-11-03 14:44:09 +03:00
Ev Stubs doc test: better types comparison function, some more fixes 2020-11-03 14:45:15 +03:00
FFI use "&" for references 2020-08-23 01:03:37 +02:00
LuaSandbox Update LuaSandbox PECL library (#900) 2020-09-26 10:22:13 +03:00
PDO Revert "Make attributes backward compatible" 2020-10-30 15:57:35 +01:00
Parle Php docs fixes from official docs: more descriptions and types fixes 2020-11-03 14:44:09 +03:00
Phar Update stubs to 8.0 beta 1 2020-08-07 14:48:31 +02:00
Reflection Amend deprecations (#939) 2020-10-29 09:29:15 +03:00
SPL Php docs fixes from official docs: more descriptions and types fixes 2020-11-03 14:44:09 +03:00
SQLite Stubs doc test: better types comparison function, some more fixes 2020-11-03 14:45:15 +03:00
SaxonC [+]: normalize more phpdocs (double -> float) + fix some more types 2020-09-03 22:41:10 +02:00
SimpleXML Set correct return type for SimpleXMLElement::__get() 2020-11-02 14:30:35 +01:00
SplType Use https for @link annotations (#367) 2018-08-13 14:15:36 +03:00
Zend OPcache Update to 8rc2 and align parameter names 2020-10-17 18:52:47 +03:00
ZendCache use "&" for references 2020-08-23 01:03:37 +02:00
ZendDebugger WI-33237 split embedded stubs into modules 2017-03-07 14:52:15 +01:00
ZendUtils WI-33237 split embedded stubs into modules 2017-03-07 14:52:15 +01:00
aerospike Add missing deprecations 2020-10-27 18:44:21 +01:00
amqp Move @deprecated to #[Deprecated] 2020-10-27 18:05:51 +01:00
apache Annotate apache functions with #[Pure] 2020-10-20 19:40:06 +02:00
apcu Php docs fixes from official docs: descriptions and types 2020-11-03 14:44:09 +03:00
bcmath Make bcscale unpure (#943) 2020-11-02 09:36:06 +03:00
blackfire Add stubs for BlackfireProbe (#764) 2020-03-30 17:36:48 +03:00
bz2 Apply suggestions from code review 2020-10-21 10:59:12 +02:00
calendar Update to 8rc2 and align parameter names 2020-10-17 18:52:47 +03:00
cassandra #[Pure] for Exception (and children) methods 2020-10-29 09:15:23 +03:00
com_dotnet Php docs fixes from official docs: more descriptions and types fixes 2020-11-03 14:44:09 +03:00
couchbase lowercase keywords null/true/false 2020-06-18 21:20:10 +03:00
crypto use "&" for references 2020-08-23 01:03:37 +02:00
ctype Annotate ctype functions with #[Pure] 2020-10-20 19:39:47 +02:00
cubrid Php docs fixes from official docs: more descriptions and types fixes 2020-11-03 14:44:09 +03:00
curl Php docs fixes from official docs: descriptions and types 2020-11-03 14:44:09 +03:00
date Stubs doc test: better types comparison function, some more fixes 2020-11-03 14:45:15 +03:00
dba Update to 8rc2 and align parameter names 2020-10-17 18:52:47 +03:00
decimal Updated Decimal extension stubs 2020-06-16 15:49:37 +03:00
dio Added Direct IO Functions stubs https://www.php.net/manual/en/ref.dio.php 2020-11-02 09:51:39 +01:00
dom Stubs doc test: better types comparison function, some more fixes 2020-11-03 14:45:15 +03:00
ds Merge branch 'master' into phpdoc_fixes 2020-09-01 09:45:30 +03:00
enchant Php docs fixes from official docs: descriptions and types 2020-11-03 14:44:09 +03:00
event Annotate event methods with #[Pure] 2020-11-02 09:53:44 +01:00
exif Merge branch 'master' into deprecation_to_attribute 2020-10-22 15:56:43 +02:00
expect use "&" for references 2020-08-23 01:03:37 +02:00
fann Php docs fixes from official docs: more descriptions and types fixes 2020-11-03 14:44:09 +03:00
ffmpeg Fix undefined class inspection 2020-06-08 16:34:00 +02:00
fileinfo Annotate fileinfo methods with #[Pure] 2020-11-02 09:53:44 +01:00
filter Annotate filter with #[Pure] 2020-10-20 18:01:05 +02:00
fpm Moved fastcgi_finish_request() to fpm/fpm.php 2020-08-07 18:17:04 +02:00
ftp Php docs fixes from official docs: descriptions and types 2020-11-03 14:44:09 +03:00
gd Amend deprecations (#939) 2020-10-29 09:29:15 +03:00
gearman Php docs fixes from official docs: more descriptions and types fixes 2020-11-03 14:44:09 +03:00
geoip Annotate geoio functions with #[Pure] 2020-10-20 20:01:36 +02:00
geos Revert "Cleanup and rules for PHPCS" 2020-06-12 14:02:01 +03:00
gettext Don't remove the function, it actually exists 2020-10-20 23:06:03 +02:00
gmagick Annotate gmagick methods with #[Pure] 2020-11-02 09:53:44 +01:00
gmp Php docs fixes from official docs: more descriptions and types fixes 2020-11-03 14:44:09 +03:00
gnupg use "&" for references 2020-08-23 01:03:37 +02:00
grpc Grpc\ChannelCredentials::createSsl() has all optional parameters. 2019-07-26 12:38:45 -04:00
hash Php docs fixes from official docs: more descriptions and types fixes 2020-11-03 14:44:09 +03:00
http Annotate http methods with #[Pure] 2020-11-02 09:53:44 +01:00
ibm_db2 Php docs fixes from official docs: more descriptions and types fixes 2020-11-03 14:44:09 +03:00
iconv Annotate iconv functions with #[Pure] 2020-10-20 19:39:26 +02:00
igbinary Remove duplicate url scheme inside phpDoc blocks 2018-11-28 17:34:30 +01:00
imagick Stubs doc test: better types comparison function, some more fixes 2020-11-03 14:45:15 +03:00
imap Added missing IMAP functions 2020-06-01 13:36:11 +03:00
inotify PHP tags cleanup 2020-03-19 14:48:38 +01:00
interbase [+]: review "..." usage 2020-09-01 01:06:24 +02:00
intl Php docs fixes from official docs: more descriptions and types fixes 2020-11-03 14:44:09 +03:00
json Annotate json methods with #[Pure] 2020-11-02 09:53:44 +01:00
judy Stubs doc test: better types comparison function, some more fixes 2020-11-03 14:45:15 +03:00
ldap Php docs fixes from official docs: descriptions and types 2020-11-03 14:44:09 +03:00
leveldb lowercase keywords null/true/false 2020-06-18 21:20:10 +03:00
libevent Remove whitespaces from stubs. 2020-05-13 21:13:07 +03:00
libsodium Revert "Cleanup and rules for PHPCS" 2020-06-12 14:02:01 +03:00
libxml Move @deprecated to #[Deprecated] 2020-10-27 18:05:51 +01:00
lua Fix `false on error` returns 2020-08-07 17:53:35 +10:00
lzf Added pecl LZF 2019-12-22 18:12:48 +03:00
mailparse Add hand-picked changes from pr553 2019-06-26 15:26:31 +03:00
mapscript [+]: normalize more phpdocs (double -> float) + fix some more types 2020-09-03 22:41:10 +02:00
mbstring Migrate mbstring entities to #[Deprecated] 2020-10-29 10:01:18 +03:00
mcrypt Php docs fixes from official docs: descriptions and types 2020-11-03 14:44:09 +03:00
memcache use "&" for references 2020-08-23 01:03:37 +02:00
memcached #[Pure] for Exception (and children) methods 2020-10-29 09:15:23 +03:00
meminfo Add ext-meminfo stub 2019-05-15 19:23:38 +02:00
meta Revert "Make attributes backward compatible" 2020-10-30 15:57:35 +01:00
ming Php docs fixes from official docs: descriptions and types 2020-11-03 14:44:09 +03:00
mongo Stubs doc test: better types comparison function, some more fixes 2020-11-03 14:45:15 +03:00
mongodb Stubs doc test: better types comparison function, some more fixes 2020-11-03 14:45:15 +03:00
mosquitto-php Revert "Cleanup and rules for PHPCS" 2020-06-12 14:02:01 +03:00
mqseries use "&" for references 2020-08-23 01:03:37 +02:00
msgpack lowercase keywords null/true/false 2020-06-18 21:20:10 +03:00
mssql use "&" for references 2020-08-23 01:03:37 +02:00
mysql Php docs fixes from official docs: descriptions and types 2020-11-03 14:44:09 +03:00
mysql_xdevapi Fix undefined class inspection 2020-06-08 16:34:00 +02:00
mysqli Php docs fixes from official docs: descriptions and types 2020-11-03 14:44:09 +03:00
ncurses use "&" for references 2020-08-23 01:03:37 +02:00
newrelic Properly add newrelic_record_datastore_segment to newrelic 2020-10-30 14:24:13 +01:00
oauth Update oauth.php 2020-06-17 22:25:17 +03:00
oci8 Php docs fixes from official docs: descriptions and types 2020-11-03 14:44:09 +03:00
odbc use "&" for references 2020-08-23 01:03:37 +02:00
openssl Php docs fixes from official docs: more descriptions and types fixes 2020-11-03 14:44:09 +03:00
parallel Php docs fixes from official docs: descriptions and types 2020-11-03 14:44:09 +03:00
pcntl Annotate pcntl functions with #[Pure] 2020-10-20 19:51:23 +02:00
pcov Revert "Cleanup and rules for PHPCS" 2020-06-12 14:02:01 +03:00
pcre Apply suggestions from code review 2020-10-21 10:59:12 +02:00
pdflib Php docs fixes from official docs: descriptions and types 2020-11-03 14:44:09 +03:00
pdo_ibm WI-33237 split embedded stubs into modules 2017-03-07 14:52:15 +01:00
pdo_mysql WI-33237 split embedded stubs into modules 2017-03-07 14:52:15 +01:00
pdo_pgsql WI-33237 split embedded stubs into modules 2017-03-07 14:52:15 +01:00
pdo_sqlite WI-33237 split embedded stubs into modules 2017-03-07 14:52:15 +01:00
pgsql Remove whitespaces from stubs. 2020-05-13 21:13:07 +03:00
phpdbg Add stubs for sapi/phpdbg functions 2020-05-13 21:20:22 +03:00
posix Annotate posix functions with #[Pure] 2020-10-20 19:51:38 +02:00
pq [+]: fix some more phpdocs 2020-09-02 21:26:03 +02:00
pspell Cleanup @since tags with old versions <5.3 2020-01-22 18:26:13 +01:00
pthreads Bring pthreads stub in line with pthreads v3.2.0 (#852) 2020-06-24 17:54:18 +03:00
radius use "&" for references 2020-08-23 01:03:37 +02:00
rar use "&" for references 2020-08-23 01:03:37 +02:00
rdkafka move close 2020-10-12 17:15:19 +02:00
readline Update to 8rc2 and align parameter names 2020-10-17 18:52:47 +03:00
recode Cleanup @since tags with old versions <5.3 2020-01-22 18:26:13 +01:00
redis (redis) Add COMPRESSION_LZ4 constant 2020-10-28 11:55:16 +01:00
regex Revert "Deprecations" (#939) 2020-10-29 09:24:18 +03:00
rpminfo use "&" for references 2020-08-23 01:03:37 +02:00
rrd Php docs fixes from official docs: descriptions and types 2020-11-03 14:44:09 +03:00
session Revert "Deprecations" (#939) 2020-10-29 09:24:18 +03:00
shmop Php docs fixes from official docs: more descriptions and types fixes 2020-11-03 14:44:09 +03:00
snmp Php docs fixes from official docs: more descriptions and types fixes 2020-11-03 14:44:09 +03:00
soap Stubs doc test fixed all parameters check moved ide-sqlite to tests folder 2020-11-03 14:45:15 +03:00
sockets Php docs fixes from official docs: more descriptions and types fixes 2020-11-03 14:44:09 +03:00
sodium Update to 8rc2 and align parameter names 2020-10-17 18:52:47 +03:00
solr Stubs doc test: better types comparison function, some more fixes 2020-11-03 14:45:15 +03:00
sqlite3 Php docs fixes from official docs: more descriptions and types fixes 2020-11-03 14:44:09 +03:00
sqlsrv Php docs fixes from official docs: descriptions and types 2020-11-03 14:44:09 +03:00
ssh2 [+]: try to fix some tests by adding more types 2020-09-01 14:48:25 +02:00
standard Php docs fixes from official docs: more descriptions and types fixes 2020-11-03 14:44:09 +03:00
stats use "&" for references 2020-08-23 01:03:37 +02:00
stomp Php docs fixes from official docs: descriptions and types 2020-11-03 14:44:09 +03:00
suhosin Remove whitespaces from stubs. 2020-05-13 21:13:07 +03:00
superglobals Revert "Cleanup and rules for PHPCS" 2020-06-12 14:02:01 +03:00
svm Style Fixed 2020-08-18 22:16:25 +02:00
svn Add hand-picked changes from pr553 2019-06-26 15:26:31 +03:00
sybase Merge branch 'master' into phpdoc_fixes 2020-09-01 09:45:30 +03:00
sync lowercase keywords null/true/false 2020-06-18 21:20:10 +03:00
sysvmsg Enforce the prohibition to directly create instances of new classes 2020-10-19 12:10:50 +02:00
sysvsem Enforce the prohibition to directly create instances of new classes 2020-10-19 12:10:50 +02:00
sysvshm Enforce the prohibition to directly create instances of new classes 2020-10-19 12:10:50 +02:00
tests Stubs doc test fixed all parameters check moved ide-sqlite to tests folder 2020-11-03 14:45:15 +03:00
tidy Added missing TIDY constants 2020-06-01 13:36:11 +03:00
tokenizer Annotate tokenizer functions with #[Pure] 2020-10-20 19:51:48 +02:00
uopz Php docs fixes from official docs: descriptions and types 2020-11-03 14:44:09 +03:00
uuid add / fix some phpdocs 2020-08-16 01:14:11 +02:00
uv use "&" for references 2020-08-23 01:03:37 +02:00
v8js lowercase keywords null/true/false 2020-06-18 21:20:10 +03:00
wddx [+]: review "..." usage 2020-09-01 01:06:24 +02:00
win32service Fix `false on error` returns 2020-08-07 17:53:35 +10:00
winbinder Revert "Cleanup and rules for PHPCS" 2020-06-12 14:02:01 +03:00
wincache Php docs fixes from official docs: more descriptions and types fixes 2020-11-03 14:44:09 +03:00
xcache Remove whitespaces from stubs. 2020-05-13 21:13:07 +03:00
xdebug Update to 8rc2 and align parameter names 2020-10-17 18:52:47 +03:00
xhprof Php docs fixes from official docs: descriptions and types 2020-11-03 14:44:09 +03:00
xlswriter [+]: fix some more phpdocs 2020-09-02 21:26:03 +02:00
xml Annotate xml functions with #[Pure] 2020-10-20 20:27:09 +02:00
xmlreader PHP 8 stubs 2020-07-16 18:30:50 +02:00
xmlrpc use "&" for references 2020-08-23 01:03:37 +02:00
xmlwriter Update to 8rc2 and align parameter names 2020-10-17 18:52:47 +03:00
xsl Cleanup @since tags with old versions <5.3 2020-01-22 18:26:13 +01:00
xxtea Stubs for PECL XXTEA 2019-11-06 15:01:57 +03:00
yaf Stubs doc test fixed all parameters check moved ide-sqlite to tests folder 2020-11-03 14:45:15 +03:00
yaml Fix `false on error` returns 2020-08-07 17:53:35 +10:00
yar Stubs doc test fixed all parameters check moved ide-sqlite to tests folder 2020-11-03 14:45:15 +03:00
zend Added `@removed 8.0` to more old-style constructors 2020-10-22 11:17:05 +02:00
zip Php docs fixes from official docs: more descriptions and types fixes 2020-11-03 14:44:09 +03:00
zlib Php docs fixes from official docs: more descriptions and types fixes 2020-11-03 14:44:09 +03:00
zmq Fix `false on error` returns 2020-08-07 17:53:35 +10:00
zookeeper Annotate zookeeper methods with #[Pure] 2020-11-02 09:53:44 +01:00
.gitignore Add php-cs-fixer 2020-05-28 18:12:43 +03:00
.php_cs lowercase keywords null/true/false 2020-06-18 21:20:10 +03:00
.travis.yml Merge branch 'master' into array_shapes 2020-10-13 11:55:23 +02:00
CONTRIBUTING.md update to php8 beta4 (#908) 2020-09-18 20:03:34 +03:00
Dockerfile Merged master changes Increased memory_limit 2020-11-03 14:17:31 +03:00
PhpStormStubsMap.php Added Direct IO Functions stubs https://www.php.net/manual/en/ref.dio.php 2020-11-02 09:51:39 +01:00
README.md Add --ignore-platform-reqs to composer install 2020-07-20 13:57:12 +03:00
composer.json Fix packagist update 2020-11-25 14:58:20 +01:00
docker-compose.yml Add composer to Dockerfile (#862) 2020-07-09 18:49:53 +03:00
generate-stub-map rdkafka stub fixes, use recurse for generator 2020-08-18 14:22:39 +02:00

README.md

phpstorm-stubs

official JetBrains project Build Status License Total Downloads

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.

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 php composer install -d /opt/project/phpstorm-stubs --ignore-platform-reqs
  2. Execute docker-compose -f docker-compose.yml run php /opt/project/phpstorm-stubs/vendor/bin/phpunit /opt/project/phpstorm-stubs/tests/

How to update stub map

Execute docker-compose -f docker-compose.yml run php /usr/local/bin/php /opt/project/phpstorm-stubs/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