README

简介

WTFilter 通过使用自己的引擎提供了一种表达性和流畅的方式来过滤内容中的粗话。 WTFilter 是 Laravel 最简单的稳定粗话过滤器。

许可证

Laravel WTFilter 是开源软件，许可证为 MIT

官方文档

这是使用语言形式过滤粗话的最简单方法。您可以在 Laravel 项目中使用的每种语言上设置多语言粗话。

安装

要开始使用 WTFilter，请使用 Composer 将包添加到项目的依赖项中

composer require kaankilic/wtfilter

安装 WTFilter 库后，请在 config/app.php 配置文件中注册 Kaankilic\WTFilter\Providers\WTFilterServiceProvider

Kaankilic\WTFilter\Providers\WTFilterServiceProvider::class,

此外，将 WTFilter 门面添加到 app 配置文件中的 aliases 数组中

'WTFilter' => Kaankilic\WTFilter\Facades\WTFilter::class

最后，发布配置和语言文件。

php artisan vendor:publish --provider="Kaankilic\WTFilter\Providers\WTFilterServiceProvider"

此命令将在您的 /config 文件夹中生成配置，并在项目中生成默认的 language 文件夹。

基本用法

<?php

namespace App\Http\Controllers;

use WTFilter;

class CommentsController extends Controller
{
    /**
     * It's filtering your comments that contains profanities.
     */
    public function createComment(Request $request){
    	$contentOfComments = WTFilter::filter($request->get("content_of_comment"));
        
    }
}

模型特性用法

您可以在模型上简单地使用 FilterableTrait 来过滤粗话。

<?php 
...
use Kaankilic\WTFilter\Traits\FilterableWords;
class CustomModel extends Model{
	use FilterableWords;

	public function filterable(){
		return [
        	"sources" => ["title"], // trait gonna check this columns
        	"flag" => "has_profanity" // *optionally you can set flag to any column
    	];
    }
...

贡献

我是项目的创建者和唯一贡献者。所以，请随意贡献一些有用的东西。请使用 Github 报告错误，发表评论或建议。