shixinke / php-ide-helper

Yaf、yar、yac、yaconf、Redis、Swoole、msgpack、xhprof等PHP框架或扩展在IDE下自动识别类、常量、自动补全方法名

php-ide-helper

php framework and php extension Auto Compelete for phpstorm

Yaf、Yar、Yac、Yaconf、Redis、Swoole等框架或C扩展之PhpStrom代码自动补全（屏蔽IDE undefined，全命名空间，中文详细文档，比手册更详细） 这个想法fork自phpboy（https://github.com/xudianyang/yaf.auto.complete)

原理

项目中先包含写好的相关的框架的PHP类文件(相当于本地类，因为ya*系列都是使用C语言写的PHP扩展，通过PHP将其定义出来引用)，编辑器即可在使用这些类的时候自动定位其定义的用法

目前支持的框架或扩展

1、Yaf(3.0.7)

2、Yac(2.0.3-dev)

3、Yaconf(1.0.8-dev)

4、Yar(2.0.4)

5、phpRedis(包括RedisCluster,支持phpredis 5.1.1)

6、swoole扩展(支持swoole 4.2.9)

7、SeasLog(1.8.5)

8、MsgPack(beta)

9、Xhprof

10、FastDFS(FastDFS 1.00)

使用说明

一.支持composer的项目通过composer安装

1.在项目的composer配置文件composer.json中的require-dev段添加以下内容

"require-dev": {
    "shixinke/php-ide-helper":"dev-master"
}

2.通过composer install安装包

composer install

二.不支持composer的项目安装

1、下载源文件并解压，将src文件夹下面的内容放到任意一个位置(我习惯将它放到我的phpstorm安装路径下的plugins\php\lib下面，然后建立一个vendor文件夹，如C:\Program Files (x86)\JetBrains\PhpStorm 9.0.2\plugins\php\lib\vendor)

2、打开phpstorm,选择File->Settings，打开setting控制面板

3、在setting控制面板中，选择Languages & Frameworks->PHP,点击PHP面板右侧的加号按钮，将第1步放置的类文件包含进来即可

示例

其他说明

此次php源码文档由php-document-creator 生成，它可以生成任何PHP扩展的源码文档

作者

shixinke

邮箱：[email protected]

博客：http://www.shixinke.com

php-ide-helper's Issues

比swoole-ide-helper还全！感谢作者的分享。

深深地满足了我的强迫症！
感谢！

yaf很多方法识别成 return void了

如图,在PHPstorm中会报一个警告.

增加composer支持

首先谢谢作者带来这样的好项目。

希望作者能继续完善项目，增加composer的支持。

.idea排除下

.idea
排除下

redis setex方法有错误 第二个参数传ttl

/**
*
*设置键值并设置有效期
* @example $redis->setex('key', 3600, 'value');
* @param string $key 设置的缓存键
* @param string $value 设置的缓存值
* @param int $ttl 有效期
* @return bool
*/
public function setex(string $key, string $value, int $ttl): bool
{

}

can you add it to http://packagist.org ？

Then it will more easier.

HookPHP和你这 简直是绝配啊！辛苦了！

HookPHP项目，全部使用了C扩展，你这项目 就是我的及时雨啊！找了很久 终于找到你这是最全的！
666 引用你的项目 直接完成了HookPHP IDE追踪！
谢谢 辛苦了！已经对你Star表示支持！

HookPHP理念之一：能用C扩展解决的 坚决不用Composer脚本执行！
我用了下述C扩展，如果有兴趣的话 可以Star支持下：

{
    "require": {
        "php": ">=7.3.4",
        "ext-gd": ">=2.2.5",
        "ext-spl": "*",
        "ext-xml": "*",
        "ext-dom": "*",
        "ext-amqp": ">=1.9.4",
        "ext-json": ">=1.7.0",
        "ext-date": "*",
        "ext-ctype": "*",
        "ext-bcmath": "*",
        "ext-filter": "*",
        "ext-curl": "*",
        "ext-iconv": ">=2.27",
        "ext-intl": ">=1.1",
        "ext-mbstring": ">=1.3",
        "ext-openssl": ">=1.1",
        "ext-rar": ">=4.0.0",
        "ext-zip": ">=1.15.4",
        "ext-yaf": ">=3.0.8",
        "ext-yac": ">=2.0.3",
        "ext-yaconf": ">=1.0.8",
        "ext-pdo": "*",
        "ext-pdo_mysql": "*",
        "ext-redis": ">=4.3",
        "ext-mongodb": ">=1.5.3",
        "ext-session": "*",
        "ext-msgpack": ">=2.0.3",
        "ext-igbinary": ">=3.0.1",
        "ext-simplexml": "*",
        "ext-seaslog": ">=2.0.2",
        "ext-xhprof": ">=2.1.0",
        "ext-swoole": ">=4.3.2",
        "ext-zend-opcache": "*"
    }
}

上述扩展，有些是你目前还没有支持IDE追踪的，能继续丰富扩展起来么？

src/Yar目录下有大小写两个yar.php文件

src/Yar目录下有大小写两个yar.php文件
在windows下貌似不支持同时存在两个大小写相同的文件

望补充下这些 msgpack.so amqp.so igbinary.so redis.so donkeyid.so seaslog.so

msgpack.so
amqp.so
igbinary.so
redis.so
donkeyid.so
seaslog.so