https://github.com/swoole/ide-helper

📘 Swoole IDE Helper
https://github.com/swoole/ide-helper

autocompletion ide-helpers php swoole typehinting

Last synced: 3 months ago
JSON representation

📘 Swoole IDE Helper

• Host: GitHub
• URL: https://github.com/swoole/ide-helper
• Owner: swoole
• License: apache-2.0
• Created: 2016-11-21T03:54:48.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2024-09-03T04:39:36.000Z (6 months ago)
• Last Synced: 2024-10-29T23:19:13.703Z (4 months ago)
• Topics: autocompletion, ide-helpers, php, swoole, typehinting
• Language: PHP
• Homepage:
• Size: 940 KB
• Stars: 490
• Watchers: 33
• Forks: 69
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-swoole - swoole/ide-helper - IDE help files to provide accurate autocompletion for Swoole. (Development Environment)

README

        
# Swoole IDE Helper

[![Twitter](https://badgen.net/badge/icon/twitter?icon=twitter&label)](https://twitter.com/phpswoole)

[![Discord](https://badgen.net/badge/icon/discord?icon=discord&label)](https://discord.swoole.dev)

[![Latest Stable Version](https://poser.pugx.org/swoole/ide-helper/v/stable.svg)](https://packagist.org/packages/swoole/ide-helper)

[![License](https://poser.pugx.org/swoole/ide-helper/license)](LICENSE)

This package contains IDE help files for [Swoole](https://github.com/swoole/swoole-src). You may use it in your IDE to provide accurate autocompletion. 

## Install

You can add this package to your project using [Composer](https://getcomposer.org):

```bash

composer require swoole/ide-helper:~5.0.0

# or

composer require --dev swoole/ide-helper:~5.0.0

```

To use the latest stubs from the `master` branch:

```bash

composer require swoole/ide-helper:@dev

# or

composer require --dev swoole/ide-helper:@dev

```

## PHP Configuration Settings

* `swoole.display_errors`: Boolean. Default `On`. Display/hide error information from Swoole.

* `swoole.enable_coroutine`: Boolean. Default `On`. Turn on/off coroutine support.

* `swoole.enable_library`: Boolean. Default `On`. Load the source code from [Swoole Library](https://github.com/swoole/library) or not.

* `swoole.enable_preemptive_scheduler`: Boolean. Default `Off`. Enable preemptive scheduler or not. To understand how it works, please check examples under section "CPU-intensive job scheduling" of repository [deminy/swoole-by-examples](https://github.com/deminy/swoole-by-examples).

* `swoole.unixsock_buffer_size`: Integer (in bytes). By default, it's 256 KiB on Macintosh or FreeBSD, otherwise 8 MiB. The total buffer sizes for the socket connections between the master process and the worker processes in Swoole.

* `swoole.use_shortname`: Boolean. Default `On`. Support short names or not. Short names are all the aliases listed in file [src/swoole/shortnames.php](src/swoole/shortnames.php).

All the directives can be set anywhere except `swoole.use_shortname`, which can only be set in `php.ini` files.