jimchen/php-dfa-sensitive

To achieve the filtering of sensitive words, based on the determination of finite automata (DFA) algorithm.

v2.0 2019-09-02 12:54 UTC

This package is auto-updated.

Last update: 2022-04-29 01:16:41 UTC


README

php实现基于确定有穷自动机算法的铭感词过滤, thanks to https://packagist.org/packages/lustre/php-dfa-sensitive

安装&使用流程

Download and install Composer:

curl -sS https://getcomposer.org/installer | php

要检查 Composer 是否正常工作,只需要通过 php 来执行 PHAR

php composer.phar

安装扩展

composer require jimchen/php-dfa-sensitive  

如果你需要手动引入

require './vendor/autoload.php';

use DfaFilter\SensitiveHelper;

获取影响因子

// 获取影响因子数组
$interferenceData = array(
    '#',
    ',',
    '~',
    '-',
    '/',
    ......
);

构建敏感词库树

场景一: 可以拿到不同(用户)词库数组

// 获取感词库索引数组
$wordData = array(
    '察象蚂',
    '拆迁灭',
    '车牌隐',
    '成人电',
    '成人卡通',
    ......
);

// get one helper
$handle = SensitiveHelper::init()->setTree($wordData);

场景二: 全站使用一套敏感词库

// 获取感词库文件路径
$wordFilePath = 'tests/data/words.txt';

// get one helper
$handle = SensitiveHelper::init()->setTreeByFile($wordFilePath);

检测是否含有敏感词

$islegal = $handle->islegal($content);

敏感词过滤

// 敏感词替换为*为例(会替换为相同字符长度的*)
$filterContent = $handle->replace($content, '*', true);

 // 或敏感词替换为***为例
 $filterContent = $handle->replace($content, '***');

标记敏感词

 $markedContent = $handle->mark($content, '<mark>', '</mark>');

获取文字中的敏感词

// 获取内容中所有的敏感词
$sensitiveWordGroup = $handle->getBadWord($content);
// 仅且获取一个敏感词
$sensitiveWordGroup = $handle->getBadWord($content, 1);

如何使用单元测试进行测试

安装PHPUnit

$ wget https://phar.phpunit.de/phpunit.phar

$ chmod +x phpunit.phar

$ mv phpunit.phar /usr/local/bin/phpunit

使用composer自动加载php命名空间

$ composer update

运行单元测试

$ phpunit tests/BaseTest.php