sublimephp方法,SublimePHPNinJaManual

软件简介

SublimePHPNinJaManual 是 Sublime 中的函数手册提示&＃xff0c;中文&＃xff0c;其他语言的可以通过命令生成

由来

自己因为sublime中没有一个好的php函数提示所苦恼。曾经在Sublime的thinkphp插件里实现过一次&＃xff0c;那个时候用的是netbeans 里

php提示的文件库&＃xff0c;然后显示也不大好看。一直以为sublime 没法做到好看的ui 因为api少。

这不就是我想要的吗&＃xff1f;看源码发现是用了一个开源的库 StyledPopup。

用html灵活多了。

而后&＃xff0c;自己其实一直用的chrome 浏览器的插件&＃xff0c;PHP NanJa

Manual。支持各种语言&＃xff0c;也有示列&＃xff0c;就是每次写代码开浏览器太麻烦了。由于他提供一个开源库PHP doc

parser&＃xff0c;可以将php官方手册转换成json文件&＃xff0c;自己就有了移植的想法。

所以名字就参考了他的&＃xff0c;希望不要告侵权。 由于son文件过于大&＃xff0c;python没有缓存机制(或许我不知道)&＃xff0c;我就用thinkphp 转成了一个db。2个表

fun、funlist fun存 函数名&＃xff0c; funlist存 函数名和对应son数据。

安装

使用Sublime Text 3 Package Control

插件(http://wbond.net/sublime\_packages/package\_control)

按 CTRL &＃43; SHIFT &＃43; P 后 找到 Package Control: Install Package 然后回车。列表中找到

PhpNinJaManual 这个插件(等审核过了会有)。

或者直接 git clone 到你的 Sublime Text 3 packages 目录 (usually located at /Sublime

Text 3/Packages/)。记得把SublimePHPNinJaManual 改为PhpNinJaManual。pac 安装的应该没这个问题。

使用说明

选中要查看的php函数名&＃xff0c;然后右键会发现

“查看函数说明”菜单

&＃xff0c;点击后&＃xff0c; 会弹出函数说明浮层

如果想配快捷键&＃xff0c;只需要你自定义快捷键里 commond 写

show_php_document就行了&＃xff0c;这个参考Sublime手册快捷键&＃xff0c;自己定义一个就好了。比如 f1或者 其他。

关于手册其他语言的生成

拿英文 en 举例。 先到 手册解析器主页&＃xff1a;https://github.com/martinsik/php-doc-parser 找一个目录

写上composer.json 内容&＃xff1a;

{

"require": {

...

"martinsik/php-doc-parser": "~2.0"

}

}

然后 composer.phar install 也可能 composer install 装好后&＃xff0c; 当前目录vendor/bin

下会有

执行文件&＃xff0c;然后

vendor/bin/doc-parser help parser:run

生成好这2个json文件后&＃xff0c; 复制到&＃xff0c;插件目录的

App/Runtime/Data里&＃xff0c;

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

会提示多少函数导入了。我没生成英文的&＃xff0c;所以是0。

未来特性

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

注意点

有的函数因为返回了&$count 这类Sublime插件语言中的关键字导致解析不了向后的html字符串

。暂时不知道怎么修复 已经被作者告知了方法&＃xff0c;已修复。PHP返回那边转义了’&’符号 √

由于那个浮层组件不支持设定宽高&＃xff0c;目前长内容会出现滚动条&＃xff0c;只能等作者解决了&＃xff0c;我会向他提Issue的。 作者也告知了有个宽度的参数 &＃xff0c;我改了下插件&＃xff0c;设了700 以后提供配置吧。反正我用str_replace函数测试足够了。√

解析手册用的是PHP&＃xff0c;需要你们的 命令行里php 可用&＃xff0c;所有&＃xff0c; 最好检查下自己的系统环境变量或者聪明的里 php -v 能不能用

参数解释前添加了 返回类型显示和高亮&＃xff0c;另外函数名可以点击 去PHP官网查看。

如果你想定义输出的格式&＃xff0c;和样式可以去看插件目录里的app Doc控制器的find方法。和find.html 模板。

find.html

a{

color: #62D9EF;

}

{$fun.params.0.ret_type} {$fun.params.0.name} (

[ ,{$i.type} {$i.var} ]&＃39; {$i[&＃39;beh&＃39;]? $i[&＃39;beh&＃39;]:$i[&＃39;type&＃39;]}  {$i.var}

)

{$fun.long_desc}

参数: 

{$i.var} - {$i[&＃39;desc&＃39;]? $i[&＃39;desc&＃39;]: &＃39;暂无说明&＃39;} 

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