word-detector - An easy-to-use vocabulary detection class for PHP

Introduction

• Simple and easy to use sensitive word detection package, and supports ignoring English case.
• PHP >= 7.0

Features

• Search for the hit shielded words and calculate the number of hits
• Replace the shield word with a custom symbol, such as '*'
• Customize invalid characters. Matching will automatically skip when these characters are encountered
• The case of English characters is ignored when matching

Installation

composer require linegg/word-detector

A Simple Example

<?php

// string to be detected
$content = 'hello a-bxx,you are a efg!';

// vocabulary array
$badWords = ['ab','efg'];

$wd = new \Linegg\WordDetector\WordDetector();

// build a trie
$wd->buildTree($badWords);

// configure negligible characters,such as' - ',' ~ '
$wd->setInvalidWords([' ','-']);

// return values includes hit times, hit words, original words and replaced strings
List($matchTime, $matchWords, $strWords, $replaceStr) = $wd->search($content, 0, true);