修改错误注释，支持获取规定数量的敏感感词

Author: FireLustre

src/DfaFilter/SensitiveHelper.php

@@ -98,10 +98,11 @@ public function setTree($sensitiveWords = null)
      * 检测文字中的敏感词
      *
      * @param string   $content    待检测内容
-     * @param int      $matchType  匹配类型【1获取首个敏感词】
+     * @param int      $matchType  匹配类型 [默认为最小匹配规则]
+     * @param int      $wordNum    需要获取的敏感词数量 [默认获取全部]
      * @return array
      */
-    public function getBadWord($content, $matchType = 1)
+    public function getBadWord($content, $matchType = 1, $wordNum = 0)
     {
         $this->contentLength = mb_strlen($content, 'utf-8');
         $badWordList = array();
@@ -147,8 +148,14 @@ public function getBadWord($content, $matchType = 1)
             if ($matchFlag <= 0) {
                 continue;
             }
+
             $badWordList[] = mb_substr($content, $length, $matchFlag, 'utf-8');
 
+            // 有返回数量限制
+            if ($wordNum > 0 && count($badWordList) == $wordNum) {
+                return $badWordList;
+            }
+
             // 需匹配内容标志位往后移
             $length = $length + $matchFlag - 1;
         }

tests/BaseTest.php

@@ -23,14 +23,20 @@ public function setUp()
 
     public function testGetBadWord()
     {
-        $content = '这是一段测试语句，请忽略赌球网';
+        $content = '这是一段测试语句，请忽略赌球网, 第二个敏感词是三级片';
 
         // 过滤,其中【赌球网】在词库中
         $filterContent = SensitiveHelper::init()
             ->setTree($this->wordData)
             ->getBadWord($content);
 
-        $this->assertEquals('赌球网',$filterContent[0]);
+        // 返回规定数量的敏感词,其中【赌球网,三级片】在词库中
+        $badWords = SensitiveHelper::init()
+            ->setTree($this->wordData)
+            ->getBadWord($content, 1, 2);
+
+        $this->assertEquals('赌球网', $filterContent[0]);
+        $this->assertEquals('三级片', $badWords[1]);
     }
 
     public function testFilterWord()

tests/ProTest.php

@@ -23,14 +23,20 @@ public function setUp()
 
     public function testGetBadWord()
     {
-        $content = '这是一段测试语句，请忽略赌球网';
+        $content = '这是一段测试语句，请忽略赌球网, 第二个敏感词是三级片';
 
         // 过滤,其中【赌球网】在词库中
         $filterContent = SensitiveHelper::init()
             ->setTreeByFile($this->wordPoolPath)
             ->getBadWord($content);
 
+        // 返回规定数量的敏感词,其中【赌球网,三级片】在词库中
+        $badWords = SensitiveHelper::init()
+            ->setTreeByFile($this->wordPoolPath)
+            ->getBadWord($content, 1, 2);
+
         $this->assertEquals('赌球网', $filterContent[0]);
+        $this->assertEquals('三级片', $badWords[1]);
     }
 
     public function testFilterWord()