1
- phpctags
2
- ========
3
- Master [ ![ Build Status] ( https://travis-ci.org/vim-php/phpctags.svg )] ( https://travis-ci.org/vim-php/phpctags?branch=master )
1
+ # phpctags
4
2
5
3
An enhanced php [ ctags] ( http://ctags.sourceforge.net/ ) index file generator
6
4
compatible with http://ctags.sourceforge.net/FORMAT .
7
5
8
6
Using [ PHP_Parser] ( https://github.com/nikic/PHP-Parser ) as PHP syntax parsing
9
7
backend, written in pure PHP. The generated ctags index file contains scope
10
- and access information about class's methods and properties.
8
+ and access information about classes' methods and properties.
11
9
12
10
This tool was originally developed to enhance the PHP syntax outline surport
13
11
for vim [ tagbar] ( http://majutsushi.github.com/tagbar/ ) plugin. The enhanced
@@ -16,26 +14,44 @@ functionality has been included into an addon plugin for tagbar as
16
14
17
15
Enjoy!
18
16
19
- Installation
20
- ------------
21
-
22
- ## Download
17
+ ## Download and installation
23
18
24
19
```
25
20
curl -Ss http://vim-php.com/phpctags/install/phpctags.phar > phpctags
26
- php ./phpctags
21
+ chmod +x phpctags
22
+ ```
23
+
24
+ Optionally one can move it into a directory on the ` $PATH ` :
25
+
26
+ ```
27
+ sudo mv phpctags /usr/local/bin/
28
+ ```
29
+
30
+ ## Usage
31
+
32
+ Single file:
33
+
34
+ ```
35
+ phpctags phpfile.php > php.tags
36
+ ```
37
+
38
+ Directory with recursive option:
39
+
40
+ ```
41
+ phpctags -R target_directory > php.tags
27
42
```
28
43
29
44
## Build
45
+
30
46
> We currently only support building PHAR executable for \* nix like platform
31
- which provides ` make ` utility. If you are interested in building an executable
32
- for other platform, especially for Windows, please help yourself out. It
33
- should be easy though (Apologize for not being able to provide any help for
34
- this, I am really not a Windows guy), it also would be great if someone could
35
- provide a patch for this.
36
-
37
- Installation is simple , make sure you have PHP's PHAR extension enabled, then
38
- just run ` make ` in the root directory of the source, you will get a ` phpctags `
47
+ > which provides ` make ` utility. If you are interested in building an executable
48
+ > for other platform, especially for Windows, please help yourself out. It
49
+ > should be easy though (Apologize for not being able to provide any help for
50
+ > this, I am really not a Windows guy), it also would be great if someone could
51
+ > provide a patch for this.
52
+
53
+ Installation is straightforward , make sure you have PHP's PHAR extension enabled,
54
+ then run ` make ` in the root directory of the source, you will get a ` phpctags `
39
55
PHAR executable, add it to your ` $PATH ` , then you can invoke ` phpctags `
40
56
directly from anywhere.
41
57
@@ -53,5 +69,6 @@ Acknowledgements
53
69
54
70
* [ Snapi] ( https://github.com/sanpii ) for composer support.
55
71
* [ DeMarko] ( https://github.com/DeMarko ) for memory limit support.
56
- * [ Sander Marechal] ( https://github.com/sandermarechal ) for improve console support
57
- * [ Mark Wu] ( https://github.com/markwu ) for building a stand-alone PHAR executable
72
+ * [ Sander Marechal] ( https://github.com/sandermarechal ) for improve console support.
73
+ * [ Mark Wu] ( https://github.com/markwu ) for building a stand-alone PHAR executable.
74
+ * [ InFog] ( https://github.com/InFog ) for maintaining the project since end of 2019.
0 commit comments