README

PHP BAD WORDS 是一个PHP包，当在文本中找到不良词时返回TRUE或FALSE。

酷的地方是你可以为字典中的每个词设置规则。

说明

1. 单独：如果文本是 你是个混蛋，并且字典中包含不良词 array( '混蛋' ); 它不会匹配，因为单词 混蛋 必须单独出现。
2. 词组：同样的文本 你是个混蛋 和同样的单词，但现在是一个包含规则的数组 array( array('混蛋','词组') );，现在它匹配了，因为规则 词组。它将通过单词 混蛋 查找文本中的每个单词，并且单词 混蛋 包含单词 混蛋，明白了吗？

安装

要安装，请将其包含在项目的 composer.json 文件中。

"expalmer/php-bad-words": "dev-master",

此包不需要任何其他依赖项即可工作。

用法

  /* Using Composer */
  require_once 'vendor/autoload.php';
  use \Expalmer\PhpBadWords\PhpBadWords as BadWords;

  $myDictionary = array(
    array("ass","among"),
    "anal",
    "butt"
  );

  $myText = "You are an asshole";

  $badwords = new BadWords();
  $badwords->setDictionaryFromArray( $myDictionary )
           ->setText( $myText );

  var_dump( $badwords->check() );
  // output: TRUE.
  // Because the dictionary has a word `ass` with `among` rule.

  var_dump( $badwords->checkAlone() );
  // output: FALSE.
  // Because now it verified by word `ass` alone, and it does not exist alone.
  // ( It ignores dictionary word rules )

  var_dump( $badwords->checkAmong() );
  // output: TRUE.
  // Again, it verified by `ass` among each word in the text.
  // ( It ignores dictionary word rules )

  // WITH THE WORD `anal`

  $myAnotherText = "She is not a research analyst";

  $badwords->setText( myAnotherText );

  var_dump( $badwords->check() );
  // output: FALSE.

  var_dump( $badwords->checkAlone() );
  // output: FALSE.

  var_dump( $badwords->checkAmong() );
  // output: TRUE.

设置字典

字典的样子。

  array(
    array("ass","among"), // rule: among
    "anal",               // rule: alone
    "beastiality",        // rule: alone
    "fart",               // rule: alone
    array("vag","among")  // rule: among
  );

数组形式

  $myDictionary = array(
    array("ass","among"),
    "butt"
  );
  $bad = new PhpBadWords();
  $obj->setDictionaryFromArray( $myDictionary );

文件形式

  /*
  // dictionary.php
  <?php
    return array(
      array("ass","among"),
      "anal",
      "butt"
    );
  */
  $bad = new PhpBadWords();
  $obj->setDictionaryFromFile( __DIR__ . "/dictionary.php" );

测试

要运行此包的单元测试，只需从包目录运行 vendor/bin/phpunit。