swoole / ide-helper

📘 Swoole IDE Helper

Swoole IDE Helper

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

Install

You can add this package to your project using Composer:

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:

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 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.
• 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.

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

ide-helper's Issues

public properties not generated

ex. Swoole\Server have no master_pid, manager_pid.

Include Swoole Library

Swoole library is added since 4.4.0. Please get it included in the stubs.

No TypeHinting

The docs are missing typehints in phpdoc

Like in Coroutine\Mysql -> prepare()

/** * @return \Swoole\Coroutine\MySQL\Statement */ public function prepare($query, $timeout = null) { }

Action required on packagist.org

A manual action is required to register this composer libray on packagist.org:

https://packagist.org/packages/swoole/

inconsistency between helper and documentation, Coroutine/Client::close()

HI,

first, thanks for this helper. Its really usefull.

I found one inconsisteny between helper and documentation.

In swoole documentation there is one parameter for coroutine client close function: https://www.swoole.co.uk/docs/modules/swoole-coroutine-client-close

But in ide helper this function is without parameter.

Its bug or feature? :)

what is this

swoole十天之前 swoole/library 新增COROUTINE_OPTIONS,希望尽快更新ide

https://github.com/swoole/library/blob/master/src/core/Server/Helper.php
十天之前新增，因为需要用到dns缓存配置。老版本没有。希望尽快更新ide

能不能打个版本号

通过 composer 安装不了

composer require swoole/ide-helper:dev-master

可以提交到 packagist 不？

可以对以前添加的函数、方法添加 @since 来标记起始版本号吗

鉴于 Swoole 更新频率较快，新增函数直接上文档，而文档本身只会对绝大部分后面新加的内容标注，且不易查找和区分。相反，是否可以通过 ide-helper 的 @SInCE 注解来快速判断此功能是否兼容旧版？

看起来工作量不小，但是我闲着的话应该也能帮帮忙。或者觉得有必要这样做吗？

Missing tag 4.4.8

Include Properties Added By zend_declare_property_null()

Here is the full list as of 2021-09-10:

swoole-src  (82 usages found)
    ext-src  (82 usages found)
        swoole_client.cc  (2 usages found)
            261 zend_declare_property_null(swoole_client_ce, ZEND_STRL("id"), ZEND_ACC_PUBLIC);
            262 zend_declare_property_null(swoole_client_ce, ZEND_STRL("setting"), ZEND_ACC_PUBLIC);
        swoole_client_coro.cc  (2 usages found)
            181 zend_declare_property_null(swoole_client_coro_ce, ZEND_STRL("socket"), ZEND_ACC_PRIVATE);
            183 zend_declare_property_null(swoole_client_coro_ce, ZEND_STRL("setting"), ZEND_ACC_PUBLIC);
        swoole_http2_client_coro.cc  (8 usages found)
            352 zend_declare_property_null(swoole_http2_client_coro_ce, ZEND_STRL("setting"), ZEND_ACC_PUBLIC);
            354 zend_declare_property_null(swoole_http2_client_coro_ce, ZEND_STRL("host"), ZEND_ACC_PUBLIC);
            360 zend_declare_property_null(swoole_http2_request_ce, ZEND_STRL("headers"), ZEND_ACC_PUBLIC);
            361 zend_declare_property_null(swoole_http2_request_ce, ZEND_STRL("cookies"), ZEND_ACC_PUBLIC);
            369 zend_declare_property_null(swoole_http2_response_ce, ZEND_STRL("headers"), ZEND_ACC_PUBLIC);
            370 zend_declare_property_null(swoole_http2_response_ce, ZEND_STRL("set_cookie_headers"), ZEND_ACC_PUBLIC);
            371 zend_declare_property_null(swoole_http2_response_ce, ZEND_STRL("cookies"), ZEND_ACC_PUBLIC);
            372 zend_declare_property_null(swoole_http2_response_ce, ZEND_STRL("data"), ZEND_ACC_PUBLIC);
        swoole_http_client_coro.cc  (9 usages found)
            1733 zend_declare_property_null(swoole_http_client_coro_ce, ZEND_STRL("setting"), ZEND_ACC_PUBLIC);
            1736 zend_declare_property_null(swoole_http_client_coro_ce, ZEND_STRL("requestMethod"), ZEND_ACC_PUBLIC);
            1737 zend_declare_property_null(swoole_http_client_coro_ce, ZEND_STRL("requestHeaders"), ZEND_ACC_PUBLIC);
            1738 zend_declare_property_null(swoole_http_client_coro_ce, ZEND_STRL("requestBody"), ZEND_ACC_PUBLIC);
            1740 zend_declare_property_null(swoole_http_client_coro_ce, ZEND_STRL("uploadFiles"), ZEND_ACC_PUBLIC);
            1741 zend_declare_property_null(swoole_http_client_coro_ce, ZEND_STRL("downloadFile"), ZEND_ACC_PUBLIC);
            1746 zend_declare_property_null(swoole_http_client_coro_ce, ZEND_STRL("headers"), ZEND_ACC_PUBLIC);
            1747 zend_declare_property_null(swoole_http_client_coro_ce, ZEND_STRL("set_cookie_headers"), ZEND_ACC_PUBLIC);
            1748 zend_declare_property_null(swoole_http_client_coro_ce, ZEND_STRL("cookies"), ZEND_ACC_PUBLIC);
        swoole_http_request.cc  (7 usages found)
            241 zend_declare_property_null(swoole_http_request_ce, ZEND_STRL("header"), ZEND_ACC_PUBLIC);
            242 zend_declare_property_null(swoole_http_request_ce, ZEND_STRL("server"), ZEND_ACC_PUBLIC);
            243 zend_declare_property_null(swoole_http_request_ce, ZEND_STRL("cookie"), ZEND_ACC_PUBLIC);
            244 zend_declare_property_null(swoole_http_request_ce, ZEND_STRL("get"), ZEND_ACC_PUBLIC);
            245 zend_declare_property_null(swoole_http_request_ce, ZEND_STRL("files"), ZEND_ACC_PUBLIC);
            246 zend_declare_property_null(swoole_http_request_ce, ZEND_STRL("post"), ZEND_ACC_PUBLIC);
            247 zend_declare_property_null(swoole_http_request_ce, ZEND_STRL("tmpfiles"), ZEND_ACC_PUBLIC);
        swoole_http_response.cc  (4 usages found)
            277 zend_declare_property_null(swoole_http_response_ce, ZEND_STRL("socket"), ZEND_ACC_PUBLIC);
            278 zend_declare_property_null(swoole_http_response_ce, ZEND_STRL("header"), ZEND_ACC_PUBLIC);
            279 zend_declare_property_null(swoole_http_response_ce, ZEND_STRL("cookie"), ZEND_ACC_PUBLIC);
            280 zend_declare_property_null(swoole_http_response_ce, ZEND_STRL("trailer"), ZEND_ACC_PUBLIC);
        swoole_http_server_coro.cc  (2 usages found)
            325 zend_declare_property_null(swoole_http_server_coro_ce, ZEND_STRL("host"), ZEND_ACC_PUBLIC);
            328 zend_declare_property_null(swoole_http_server_coro_ce, ZEND_STRL("settings"), ZEND_ACC_PUBLIC);
        swoole_mysql_coro.cc  (1 usage found)
            1724 zend_declare_property_null(swoole_mysql_coro_ce, ZEND_STRL("serverInfo"), ZEND_ACC_PUBLIC);
        swoole_process.cc  (6 usages found)
            273 zend_declare_property_null(swoole_process_ce, ZEND_STRL("pipe"), ZEND_ACC_PUBLIC);
            274 zend_declare_property_null(swoole_process_ce, ZEND_STRL("msgQueueId"), ZEND_ACC_PUBLIC);
            275 zend_declare_property_null(swoole_process_ce, ZEND_STRL("msgQueueKey"), ZEND_ACC_PUBLIC);
            276 zend_declare_property_null(swoole_process_ce, ZEND_STRL("pid"), ZEND_ACC_PUBLIC);
            277 zend_declare_property_null(swoole_process_ce, ZEND_STRL("id"), ZEND_ACC_PUBLIC);
            279 zend_declare_property_null(swoole_process_ce, ZEND_STRL("callback"), ZEND_ACC_PRIVATE);
        swoole_process_pool.cc  (1 usage found)
            202 zend_declare_property_null(swoole_process_pool_ce, ZEND_STRL("workers"), ZEND_ACC_PUBLIC);
        swoole_redis_coro.cc  (1 usage found)
            1907 zend_declare_property_null(swoole_redis_coro_ce, ZEND_STRL("setting"), ZEND_ACC_PUBLIC);
        swoole_server.cc  (22 usages found)
            667 zend_declare_property_null(swoole_server_task_ce, ZEND_STRL("data"), ZEND_ACC_PUBLIC);
            677 zend_declare_property_null(swoole_server_event_ce, ZEND_STRL("data"), ZEND_ACC_PUBLIC);
            683 zend_declare_property_null(swoole_server_packet_ce, ZEND_STRL("address"), ZEND_ACC_PUBLIC);
            689 zend_declare_property_null(swoole_server_pipe_message_ce, ZEND_STRL("data"), ZEND_ACC_PUBLIC);
            702 zend_declare_property_null(swoole_server_task_result_ce, ZEND_STRL("data"), ZEND_ACC_PUBLIC);
            722 zend_declare_property_null(swoole_server_ce, ZEND_STRL("onStart"), ZEND_ACC_PRIVATE);
            723 zend_declare_property_null(swoole_server_ce, ZEND_STRL("onShutdown"), ZEND_ACC_PRIVATE);
            724 zend_declare_property_null(swoole_server_ce, ZEND_STRL("onWorkerStart"), ZEND_ACC_PRIVATE);
            725 zend_declare_property_null(swoole_server_ce, ZEND_STRL("onWorkerStop"), ZEND_ACC_PRIVATE);
            726 zend_declare_property_null(swoole_server_ce, ZEND_STRL("onBeforeReload"), ZEND_ACC_PRIVATE);
            727 zend_declare_property_null(swoole_server_ce, ZEND_STRL("onAfterReload"), ZEND_ACC_PRIVATE);
            728 zend_declare_property_null(swoole_server_ce, ZEND_STRL("onWorkerExit"), ZEND_ACC_PRIVATE);
            729 zend_declare_property_null(swoole_server_ce, ZEND_STRL("onWorkerError"), ZEND_ACC_PRIVATE);
            730 zend_declare_property_null(swoole_server_ce, ZEND_STRL("onTask"), ZEND_ACC_PRIVATE);
            731 zend_declare_property_null(swoole_server_ce, ZEND_STRL("onFinish"), ZEND_ACC_PRIVATE);
            732 zend_declare_property_null(swoole_server_ce, ZEND_STRL("onManagerStart"), ZEND_ACC_PRIVATE);
            733 zend_declare_property_null(swoole_server_ce, ZEND_STRL("onManagerStop"), ZEND_ACC_PRIVATE);
            734 zend_declare_property_null(swoole_server_ce, ZEND_STRL("onPipeMessage"), ZEND_ACC_PRIVATE);
            736 zend_declare_property_null(swoole_server_ce, ZEND_STRL("setting"), ZEND_ACC_PUBLIC);
            737 zend_declare_property_null(swoole_server_ce, ZEND_STRL("connections"), ZEND_ACC_PUBLIC);
            742 zend_declare_property_null(swoole_server_ce, ZEND_STRL("ports"), ZEND_ACC_PUBLIC);
            748 zend_declare_property_null(swoole_server_ce, ZEND_STRL("stats_timer"), ZEND_ACC_PUBLIC);
        swoole_server_port.cc  (14 usages found)
            178 zend_declare_property_null(swoole_server_port_ce, ZEND_STRL("onConnect"), ZEND_ACC_PRIVATE);
            179 zend_declare_property_null(swoole_server_port_ce, ZEND_STRL("onReceive"), ZEND_ACC_PRIVATE);
            180 zend_declare_property_null(swoole_server_port_ce, ZEND_STRL("onClose"), ZEND_ACC_PRIVATE);
            181 zend_declare_property_null(swoole_server_port_ce, ZEND_STRL("onPacket"), ZEND_ACC_PRIVATE);
            182 zend_declare_property_null(swoole_server_port_ce, ZEND_STRL("onBufferFull"), ZEND_ACC_PRIVATE);
            183 zend_declare_property_null(swoole_server_port_ce, ZEND_STRL("onBufferEmpty"), ZEND_ACC_PRIVATE);
            184 zend_declare_property_null(swoole_server_port_ce, ZEND_STRL("onRequest"), ZEND_ACC_PRIVATE);
            185 zend_declare_property_null(swoole_server_port_ce, ZEND_STRL("onHandShake"), ZEND_ACC_PRIVATE);
            186 zend_declare_property_null(swoole_server_port_ce, ZEND_STRL("onOpen"), ZEND_ACC_PRIVATE);
            187 zend_declare_property_null(swoole_server_port_ce, ZEND_STRL("onMessage"), ZEND_ACC_PRIVATE);
            188 zend_declare_property_null(swoole_server_port_ce, ZEND_STRL("onDisconnect"), ZEND_ACC_PRIVATE);
            190 zend_declare_property_null(swoole_server_port_ce, ZEND_STRL("host"), ZEND_ACC_PUBLIC);
            194 zend_declare_property_null(swoole_server_port_ce, ZEND_STRL("setting"), ZEND_ACC_PUBLIC);
            196 zend_declare_property_null(swoole_server_port_ce, ZEND_STRL("connections"), ZEND_ACC_PUBLIC);
        swoole_table.cc  (2 usages found)
            233 zend_declare_property_null(swoole_table_ce, ZEND_STRL("size"), ZEND_ACC_PUBLIC);
            234 zend_declare_property_null(swoole_table_ce, ZEND_STRL("memorySize"), ZEND_ACC_PUBLIC);
        swoole_websocket_server.cc  (1 usage found)
            642 zend_declare_property_null(swoole_websocket_frame_ce, ZEND_STRL("finish"), ZEND_ACC_PUBLIC);

`tick` method is missing from Swoole\WebSocket\Server

The tick($ms, $callback) method is missing from the Swoole\WebSocket\Server class.

Add Swoole\\Coroutine\\PostgreSQL

As i see https://github.com/swoole/ext-postgresql is missing here, could you add it?

Well actually for 4.3.3 stubs it is here, but for 4.3.4 is removed, even it's still part of core as i see here - https://github.com/swoole/swoole-src/tree/v4.3.4 it's presented swoole_postgresql_coro.cc or i miss something?

nice