Merge branch 'release/0.5'

Author: weynhamz

ChangeLog.md

@@ -1,3 +1,14 @@
+Version 0.5
+-----------
+
+* Add trait support
+  thanks to Mark Wu
+* Add inherits support
+  thanks to Mark Wu
+* Add namespace support
+  thanks to Mark Wu
+* Add instruction to enable phar extension in README
+
 Version 0.4.2
 -------------
 

PHPCtags.class.php

@@ -1,20 +1,22 @@
 <?php
 class PHPCtags
 {
-    const VERSION = '0.4.2';
+    const VERSION = '0.5';
 
     private $mFile;
 
     private $mFiles;
 
     private static $mKinds = array(
+        't' => 'trait',
         'c' => 'class',
         'm' => 'method',
         'f' => 'function',
         'p' => 'property',
         'd' => 'constant',
         'v' => 'variable',
         'i' => 'interface',
+        'n' => 'namespace',
     );
 
     private $mParser;
@@ -111,7 +113,8 @@ private function struct($node, $reset=FALSE, $parent=array())
             $structs = array();
         }
 
-        $kind = $name = $line = $access = '';
+        $kind = $name = $line = $access = $extends = '';
+        $implements = array();
 
         if (!empty($parent)) array_push($scope, $parent);
 
@@ -122,6 +125,8 @@ private function struct($node, $reset=FALSE, $parent=array())
         } elseif ($node instanceof PHPParser_Node_Stmt_Class) {
             $kind = 'c';
             $name = $node->name;
+            $extends = $node->extends;
+            $implements = $node->implements;
             $line = $node->getLine();
             foreach ($node as $subNode) {
                 $this->struct($subNode, FALSE, array('class' => $name));
@@ -181,10 +186,19 @@ private function struct($node, $reset=FALSE, $parent=array())
             foreach ($node as $subNode) {
                 $this->struct($subNode, FALSE, array('interface' => $name));
             }
+        } elseif ($node instanceof PHPParser_Node_Stmt_Trait ) {
+            $kind = 't';
+            $name = $node->name;
+            $line = $node->getLine();
+            foreach ($node as $subNode) {
+                $this->struct($subNode, FALSE, array('trait' => $name));
+            }
         } elseif ($node instanceof PHPParser_Node_Stmt_Namespace) {
-            //@todo
+            $kind = 'n';
+            $name = $node->name;
+            $line = $node->getLine();
             foreach ($node as $subNode) {
-                $this->struct($subNode);
+                $this->struct($subNode, FALSE, array('namespace' => $name));
             }
         } elseif ($node instanceof PHPParser_Node_Expr_Assign) {
             if (is_string($node->var->name)) {
@@ -218,6 +232,8 @@ private function struct($node, $reset=FALSE, $parent=array())
                 'file' => $this->mFile,
                 'kind' => $kind,
                 'name' => $name,
+                'extends' => $extends,
+                'implements' => $implements,
                 'line' => $line,
                 'scope' => $scope,
                 'access' => $access,
@@ -283,19 +299,54 @@ private function render()
 
             #field=s
             if (in_array('s', $this->mOptions['fields']) && !empty($struct['scope'])) {
+                // $scope, $type, $name are current scope variables
                 $scope = array_pop($struct['scope']);
                 list($type, $name) = each($scope);
                 switch ($type) {
+                    case 'class':
+                        // n_* stuffs are namespace related scope variables
+                        // current > class > namespace
+                        $n_scope = array_pop($struct['scope']);
+                        if(!empty($n_scope)) {
+                            list($n_type, $n_name) = each($n_scope);
+                            $s_str = 'class:' . $n_name . '\\' . $name;
+                        } else {
+                            $s_str = 'class:' . $name;
+                        }
+                        break;
                     case 'method':
-                        $scope = array_pop($struct['scope']);
-                        list($p_type, $p_name) = each($scope);
-                        $scope = 'method:' . $p_name . '::' . $name;
+                        // c_* stuffs are class related scope variables
+                        // current > method > class > namespace
+                        $c_scope = array_pop($struct['scope']);
+                        list($c_type, $c_name) = each($c_scope);
+                        $n_scope = array_pop($struct['scope']);
+                        if(!empty($n_scope)) {
+                            list($n_type, $n_name) = each($n_scope);
+                            $s_str = 'method:' . $n_name . '\\' . $c_name . '::' . $name;
+                        } else {
+                            $s_str = 'method:' . $c_name . '::' . $name;
+                        }
                         break;
                     default:
-                        $scope = $type . ':' . $name;
+                        $s_str = $type . ':' . $name;
                         break;
                 }
-                $str .= "\t" . $scope;
+                $str .= "\t" . $s_str;
+            }
+
+            #field=i
+            if(in_array('i', $this->mOptions['fields'])) {
+                $inherits = array();
+                if(!empty($struct['extends'])) {
+                    $inherits[] = $struct['extends']->toString();
+                }
+                if(!empty($struct['implements'])) {
+                    foreach($struct['implements'] as $interface) {
+                        $inherits[] = $interface->toString();
+                    }
+                }
+                if(!empty($inherits))
+                    $str .= "\t" . 'inherits:' . implode(',', $inherits);
             }
 
             #field=a

README.md

@@ -25,9 +25,10 @@ should be easy though (Apologize for not being able to provide any help for
 this, I am really not a Windows guy), it also would be great if someone could
 provide a patch for this.
 
-Installation is simple, just run `make` in the root directory of the source,
-you will get a `phpctags` PHAR executable, add it to your `$PATH`, then you
-can invoke `phpcatgs` directly from anywhere.
+Installation is simple, make sure you have PHP's PHAR extension enabled, then
+just run `make` in the root directory of the source, you will get a `phpctags`
+PHAR executable, add it to your `$PATH`, then you can invoke `phpcatgs`
+directly from anywhere.
 
 See [phpctags on packagist](http://packagist.org/packages/techlivezheng/phpctags)
 for more details.

bootstrap.php

@@ -142,7 +142,7 @@
 if (!isset($options['memory']))
     $options['memory'] = '128M';
 if (!isset($options['fields'])) {
-    $options['fields'] = array('n', 'k', 's', 'a');
+    $options['fields'] = array('n', 'k', 's', 'a','i');
 } else {
     $options['fields'] = str_split($options['fields']);
 }