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

💪 IDE helper for Swoft and Swoole
https://github.com/swoft-cloud/swoole-ide-helper

ide-helpers swoft swoole

Last synced: 2 months ago
JSON representation

💪 IDE helper for Swoft and Swoole

• Host: GitHub
• URL: https://github.com/swoft-cloud/swoole-ide-helper
• Owner: swoft-cloud
• License: apache-2.0
• Created: 2018-01-26T20:18:57.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2020-03-18T02:13:54.000Z (almost 5 years ago)
• Last Synced: 2024-10-29T21:10:46.751Z (3 months ago)
• Topics: ide-helpers, swoft, swoole
• Language: PHP
• Homepage: https://packagist.org/packages/swoft/swoole-ide-helper
• Size: 302 KB
• Stars: 42
• Watchers: 5
• Forks: 12
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Swoole IDE Helper

[![Latest Stable Version](http://img.shields.io/packagist/v/swoft/swoole-ide-helper.svg)](https://packagist.org/packages/swoft/swoole-ide-helper)

[![Packagist](https://img.shields.io/packagist/dt/swoft/swoole-ide-helper)](https://packagist.org/packages/swoft/swoole-ide-helper)

[![License](https://img.shields.io/hexpm/l/plug.svg?maxAge=2592000)](https://github.com/swoft-cloud/swoole-ide-helper/blob/master/LICENSE)

Add IDE helper for the **swoole** extension, forked from [swoole/ide-helper](https://github.com/swoole/ide-helper)

> `swoft/swoole-ide-helper` keep the same version of **swoole**

## Diff With swoole/ide-helper

Different from the source repository: variable types are added to most method parameters for easy reference. 

Old：

```php

/**

 * @param $fd

 * @param $data

 * @param $opcode

 * @param $finish

 * @return mixed

 */

public function push($fd, $data, $opcode = null, $finish = null){}

```

**Now**:

```php

/**

 * @param int $fd

 * @param mixed $data

 * @param int $opcode

 * @param bool $finish

 * @return mixed

 */

public function push(int $fd, $data, int $opcode = null, bool $finish = null){}

```

## Install

The [Swoft](https://github.com/swoft-cloud/swoft) use it as default.

You can add it by `composer`:

```bash

composer require --dev swoft/swoole-ide-helper

# use latest code

composer require --dev swoft/swoole-ide-helper@dev-master

# for specific version

composer require --dev swoft/swoole-ide-helper:~4.4.2

```

## Build

You can regenerate it locally.

Of course, you must ensure that the `swoole` extension is already installed.

```bash

cd /path/to/swoole-ide-helper

php dump.php

```

By docker:

```bash

docker run -ti --rm -v /path/to/swoole-ide-helper:/var/www/swoft swoft/swoft bash

php dump.php

```

## LICENSE

See [LICENSE](LICENSE)