swoole/ide-helper

IDE help files for Swoole.

4.4.17 2020-04-02 14:36 UTC

This package is auto-updated.

Last update: 2020-04-02 14:36:39 UTC


README

Build Status Latest Stable Version License

This package contains IDE help files for Swoole. You may use it in your IDE to provide accurate autocompletion.

Install

You may add this package to your project using Composer:

composer require swoole/ide-helper:@dev
# or you may install a specific version, like:
composer require swoole/ide-helper:~4.4.7

It's better to install this package on only development systems by adding the --dev flag to your Composer commands:

composer require --dev swoole/ide-helper:@dev
# or you may install a specific version, like:
composer require --dev swoole/ide-helper:~4.4.7

Alternatives

The stubs are created by reverse-engineering the Swoole extensions directly; thus there is no documentation included, and type hinting is missing in many places. The Swoole team has tried its best to keep the stubs up to date, and we do want to add inline documentation and type hinting in the future; however, due to limited resources we don't know when it will be ready.

Here are some alternatives you can consider:

Generate IDE Help Files

Have Docker running first, then use script ./bin/generator.sh to generate IDE help files and put them under folder output/ with commands like following:

./bin/generator.sh 4.4.16
./bin/generator.sh 4.4.16 master
./bin/generator.sh 4.4.16 4.4.16
./bin/generator.sh 4.4.16 b5c9cede8c6150feba50d0e28d56de355fa69d16
#

The first parameter specifies a stable release of Swoole. The second parameter is optional; it is to specify which version of Swoole library to be integrated with (by default it will have the latest Swoole library included).