search

yangweijie / SublimePHPNinJaManual

Sublime中的函数手册提示，中文，其他语言的可以通过命令生成
Apache License 2.0
45 stars 6 forks source link

readme

SublimePHPNinJaManual

Sublime中的函数手册提示，中文，其他语言的可以通过命令生成

由来

自己因为sublime中没有一个好的php函数提示所苦恼。曾经在Sublime的thinkphp插件里实现过一次， 那个时候用的是netbeans 里 php提示的文件库，然后显示也不大好看。一直以为sublime 没法做到好看的ui 因为api少。

前几天发现了国人的自己做的Ctranslator tool 这不就是我想要的吗？看源码发现是用了一个开源的库 StyledPopup。 用html灵活多了。

而后，自己其实一直用的chrome 浏览器的插件，PHP NanJa Manual。支持各种语言，也有示列，就是每次写代码开浏览器太麻烦了。由于他提供一个开源库PHP doc parser，可以将php官方手册转换成json文件，自己就有了移植的想法。 所以名字就参考了他的，希望不要告侵权。 由于son文件过于大，python没有缓存机制（或许我不知道），我就用thinkphp 转成了一个sqlite db。2个表 fun、funlist fun存 函数名， funlist存 函数名和对应son数据。

安装

使用Sublime Text 3 Package Control 插件(http://wbond.net/sublime\_packages/package\_control) 按 CTRL + SHIFT + P 后 找到 Package Control: Install Package 然后回车。列表中找到PhpNinJaManual这个插件（等审核过了会有）。

或者直接 git clone 到你的 Sublime Text 3 packages 目录 (usually located at /Sublime Text 3/Packages/)。记得把SublimePHPNinJaManual 改为PhpNinJaManual。pac 安装的应该没这个问题。

使用说明

选中要查看的php函数名，然后右键会发现 “查看函数说明”菜单 ，点击后， 会弹出函数说明浮层

如果想配快捷键，只需要你自定义快捷键里 commond 写 show_php_document就行了，这个参考Sublime手册快捷键，自己定义一个就好了。比如 f1或者 其他。

关于手册其他语言的生成

拿英文 en 举例。 先到 手册解析器主页：https://github.com/martinsik/php-doc-parser 找一个目录 写上composer.json 内容：

{
    "require": {
      ...
      "martinsik/php-doc-parser": "~2.0"
    }
}

然后 composer.phar install 也可能 composer install 装好后， 当前目录vendor/bin 下会有 执行文件，然后

vendor/bin/doc-parser help parser:run 生成好这2个json文件后， 复制到，插件目录的 App/Runtime/Data里，

到时候就不是zh 而是en。 然后 命令行切换到插件目录里执行 2条命令 ：

PS：因为怕用户麻烦，我更新了中文的数据库文件和添加了英文数据库文件，英文的比较全多大概300个函数。如果想使用英文的同学 git clone最新版的插件，修改插件配置 lang->en 保存后重启插件。 就能看到如下的图：en doc support

未来特性

可能会用PHPConnector 重构下。 可能会把示列加上，不过数据库体积就更大了，而且可能显示会更长

注意点

find.html

<style>
a{
    color: #62D9EF;
}
</style>
<span class="keyword">{$fun.params.0.ret_type}</span> <a class="entity name function" href="https://github.com/yangweijie/SublimePHPNinJaManual/blob/master/{$url}">{$fun.params.0.name}</a> (<span class="comment line"><volist name="fun.params.0.list" id="i">
    [ <neq name="key" value="0">,</neq><span class="keyword">{$i.type}</span> <span class="string quoted">{$i.var}</span> ]' {$i['beh']? $i['beh']:$i['type']}  {$i.var}
</volist></span>)
<p>{$fun.long_desc}</p>
<p>参数: <br>
<volist name="fun.params.0.list" id="i">
    {$i.var} - {$i['desc']? $i['desc']: '暂无说明'} <br>
    </volist>
</p>

直接改HTML和控制器后直接调试插件的效果太他妈爽了，可惜我没有配色天赋。曾经尝试body白色，想弄个清淡的浮层，发现body外还有边距。反正大家可以自由DIY。配出适合自己主题的样式。可以告诉我，我以后，可以动态的针对不同主题调用不同样式，达到显示最优化。