PHPackages                             shixinke/php-ide-helper - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. shixinke/php-ide-helper

ActiveLibrary[Utility & Helpers](/categories/utility)

shixinke/php-ide-helper
=======================

a tool that provides auto-completion for php frameworks and extensions

2191.4k541PHP

Since Apr 22Pushed 6y ago13 watchersCompare

[ Source](https://github.com/shixinke/php-ide-helper)[ Packagist](https://packagist.org/packages/shixinke/php-ide-helper)[ RSS](/packages/shixinke-php-ide-helper/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependenciesVersions (2)Used By (1)

php-ide-helper
==============

[](#php-ide-helper)

php framework and php extension Auto Compelete for phpstorm

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

原理
--

[](#原理)

项目中先包含写好的相关的框架的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安装

[](#一支持composer的项目通过composer安装)

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

[](#1在项目的composer配置文件composerjson中的require-dev段添加以下内容)

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

```

##### 2.通过composer install安装包

[](#2通过composer-install安装包)

```
composer install

```

#### 二.不支持composer的项目安装

[](#二不支持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控制面板

[![phpstorm设置第一步](https://github.com/shixinke/phpstorm-for-php-framework/raw/master/static/images/step1.png)](https://github.com/shixinke/phpstorm-for-php-framework/blob/master/static/images/step1.png)

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

[![phpstorm设置第二步](https://github.com/shixinke/phpstorm-for-php-framework/raw/master/static/images/step2.png)](https://github.com/shixinke/phpstorm-for-php-framework/blob/master/static/images/step2.png)

示例
--

[](#示例)

[![phpstorm自动补全效果](https://github.com/shixinke/phpstorm-for-php-framework/raw/master/static/images/yaf.auto.complete.png)](https://github.com/shixinke/phpstorm-for-php-framework/blob/master/static/images/yaf.auto.complete.png)

其他说明
----

[](#其他说明)

此次php源码文档由[php-document-creator](http://github.com/shixinke/php-document-creator) 生成，它可以生成任何PHP扩展的源码文档

作者
--

[](#作者)

shixinke

邮箱：

博客：

###  Health Score

30

—

LowBetter than 64% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity37

Limited adoption so far

Community23

Small or concentrated contributor base

Maturity36

Early-stage or recently created project

 Bus Factor1

Top contributor holds 96.8% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://www.gravatar.com/avatar/af0b3b3b7c6d494861ea002649dccd189869478f47cc40ff8bb7999e8fff962b?d=identicon)[shixinke](/maintainers/shixinke)

---

Top Contributors

[![shixinke](https://avatars.githubusercontent.com/u/9602010?v=4)](https://github.com/shixinke "shixinke (61 commits)")[![bombless](https://avatars.githubusercontent.com/u/1296393?v=4)](https://github.com/bombless "bombless (1 commits)")[![mowangjuanzi](https://avatars.githubusercontent.com/u/13846040?v=4)](https://github.com/mowangjuanzi "mowangjuanzi (1 commits)")

---

Tags

ide-helperphp-framework-ide-helperphpstormphpstorm-helperswoole-ide-helperyaf-ide-helper

### Embed Badge

![Health badge](/badges/shixinke-php-ide-helper/health.svg)

```
[![Health](https://phpackages.com/badges/shixinke-php-ide-helper/health.svg)](https://phpackages.com/packages/shixinke-php-ide-helper)
```

###  Alternatives

[paquettg/string-encode

Facilitating the process of altering string encoding in PHP.

698.7M43](/packages/paquettg-string-encode)[jbtronics/settings-bundle

A symfony bundle to easily create typesafe, user-configurable settings for symfony applications

9546.7k2](/packages/jbtronics-settings-bundle)[ibrand/laravel-shopping-cart

Shopping cart for Laravel Application.

385.6k1](/packages/ibrand-laravel-shopping-cart)[bolt/bolt-extension-starter

103.3k](/packages/bolt-bolt-extension-starter)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)