faresmts/safewords

一个用于从字符串中过滤不良词语的 PHP 库

维护者

详细信息

github.com/faresmts/safewords

源代码

问题

安装次数: 948

依赖项: 0

建议者: 0

安全: 0

星标: 8

关注者: 1

分支: 0

开放问题: 0

v0.1.1 2023-01-03 00:17 UTC

Requires

  • php: >=8.0

Requires (Dev)

MIT b897fcf4d22eda204f8af11b43540abedd70766f

  • matheus fares <matheusfares.woop@alu.ufc.br>

This package is auto-updated.

Last update: 2024-09-06 16:10:44 UTC

README

Safewords 是一个可以在任何 PHP 框架中使用的包，通过调用静态方法，返回被审查的文本或布尔值以判断其安全性。

支持我，通过 star 这个仓库或者通过 linkedin 与我联系

安装

您可以通过 composer 安装此包

composer require faresmts/safewords

使用方法

这是调用 safewords 检查器的最简单方法

$isSafe = SafeWords::filter($text)
            ->isSafe()
            ->get();

这是调用 safewords 审查器的方法

$censoredText = SafeWords::filter($text)
                   ->replace()
                   ->get();

两种方法都可以通过 useDictionary() 函数调用以添加需要屏蔽的新词

$isSafe = SafeWords::filter($text)
            ->useDictionary(['foo', 'bar'])
            ->isSafe()
            ->get();

$censoredText = SafeWords::filter($text)
                    ->useDictionary(['foo', 'bar'])
                    ->replace()
                    ->get();

函数

  • filter(string $text): 添加您想要检查的文本。

  • useDictionary(array $userBadWords): 添加您想要在 SafeWords 检查器中屏蔽的词。

  • isSafe(): 评估文本是否安全的函数。

  • replace(string $replace = '*'): 将不良词中的每个字符替换为 $string 中的变量。默认为 '*'。

  • get(): 获取所选方法的结果。

异常

  • 当同时调用 isSafe() 和 replace() 方法时，将抛出异常。

  • useDictionary() 方法必须在 isSafe() 或 replace() 之后调用。它必须在之前调用。