Merge pull request #133 from delmicio/master

Comment extractor now acepts multiple strings (v4)

Author: oscarotero

src/Extractors/PhpCode.php

@@ -14,6 +14,7 @@ class PhpCode extends Extractor implements ExtractorInterface
          // - false: to not extract comments
          // - empty string: to extract all comments
          // - non-empty string: to extract comments that start with that string
+         // - array with strings to extract comments format.
         'extractComments' => false,
 
         'constants' => [],

src/Utils/PhpFunctionsScanner.php

@@ -16,18 +16,18 @@ class PhpFunctionsScanner extends FunctionsScanner
     /**
      * If not false, comments will be extracted.
      *
-     * @var string|false
+     * @var string|false|array
      */
     protected $extractComments = false;
 
     /**
      * Enable extracting comments that start with a tag (if $tag is empty all the comments will be extracted).
      *
-     * @param string $tag
+     * @param mixed $tag
      */
     public function enableCommentsExtraction($tag = '')
     {
-        $this->extractComments = (string) $tag;
+        $this->extractComments = $tag;
     }
 
     /**
@@ -157,11 +157,20 @@ protected function parsePhpComment($value)
                 $value = substr($value, 2, -2);
             }
             $value = trim($value);
-            if ($value !== '' && ($this->extractComments === '' || strpos($value, $this->extractComments) === 0)) {
-                $result = $value;
+            if ($value !== '') {
+                if ($this->extractComments === '' || strpos($value, $this->extractComments) === 0) {
+                    $result = $value;
+                }
+                elseif (is_array($this->extractComments)) {
+                    foreach ($this->extractComments as $string) {
+                        if (strpos($value, $string) === 0) {
+                            $result = $value;
+                            break;
+                        }
+                    }        
+                }
             }
         }
-
         return $result;
     }
 }