README

数据清理器和 Laravel 7/8 表单请求，带有输入清理

简介

Sanitizer 提供了一种简单的方式来格式化用户输入，无论是通过提供的过滤器还是通过可以轻松添加到清理器库中的自定义过滤器。

尽管不限于 Laravel 用户，但也提供了一些为此框架提供的扩展，例如通过自定义 FormRequest 容易地进行清理用户输入以及更容易的可扩展性。

示例

给定以下格式的数据数组

    $data = [
        'first_name'    =>  'john',
        'last_name'     =>  '<strong>DOE</strong>',
        'email'         =>  '  JOHn@DoE.com',
        'birthdate'     =>  '06/25/1980',
        'jsonVar'       =>  '{"name":"value"}',
        'description'   =>  '<p>Test paragraph.</p><!-- Comment --> <a href="#fragment">Other text</a>',
        'phone'         =>  '+08(096)90-123-45q',
        'country'       =>  'GB',
        'postcode'      =>  'ab12 3de',
    ];

我们可以轻松地使用我们的清理器和清理器的某些默认过滤器来格式化它

    use \danielebuso\sanitizer\Sanitizer;

    $filters = [
        'first_name'    =>  'trim|escape|capitalize',
        'last_name'     =>  'trim|escape|capitalize',
        'email'         =>  'trim|escape|lowercase',
        'birthdate'     =>  'trim|format_date:m/d/Y, Y-m-d',
        'jsonVar'       =>  'cast:array',
        'description'   =>  'strip_tags',
        'phone'         =>  'digit',
        'country'       =>  'trim|escape|capitalize',
        'postcode'      =>  'trim|escape|uppercase|filter_if:country,GB',
    ];

    $sanitizer  = new Sanitizer($data, $filters);
    var_dump($sanitizer->sanitize());

这将产生

    [
        'first_name'    =>  'John',
        'last_name'     =>  'Doe',
        'email'         =>  'john@doe.com',
        'birthdate'     =>  '1980-06-25',
        'jsonVar'       =>  '["name" => "value"]',
        'description'   =>  'Test paragraph. Other text',
        'phone'         =>  '080969012345',
        'country'       =>  'GB',
        'postcode'      =>  'AB12 3DE',
    ];

它的用法与 Laravel 的 Validator 模块非常相似，对于已经熟悉它的人来说，尽管使用此库不需要 Laravel。

过滤器按定义在 $filters 数组中的顺序应用。对于每个属性，过滤器通过 | 分隔，选项通过在参数列表后附加逗号分隔的列表指定（见 format_date）。

可用过滤器

以下过滤器是开箱即用的

添加自定义过滤器

您可以通过将自定义过滤器数组传递给清理器构造函数的第三个参数来添加自己的过滤器。对于每个过滤器名称，必须提供闭包或实现 danielebuso\sanitizer\Contracts\Filter 接口的类的完整类路径。闭包必须始终接受两个参数：$value 和一个 $options 数组

    class RemoveStringsFilter implements danielebuso\sanitizer\Contracts\Filter
    {
        public function apply($value, $options = [])
        {
            return str_replace($options, '', $value);
        }
    }

    $customFilters = [
        'hash'   =>  function($value, $options = []) {
                return sha1($value);
            },
        'remove_strings' => RemoveStringsFilter::class,
    ];

    $filters = [
        'secret'    =>  'hash',
        'text'      =>  'remove_strings:Curse,Words,Galore',
    ];

    $sanitize = new Sanitize($data, $filters, $customFilters);

安装

要安装，只需运行

composer require danielebuso/sanitizer

然后您就完成了！如果您正在使用 Laravel，为了能够访问一些额外的功能，您必须在 config/app.php 中的 providers 数组中注册服务提供者，以及清理器外观

    'providers' => [
        ...
        danielebuso\sanitizer\Laravel\SanitizerServiceProvider::class,
    ];

    'aliases' => [
        ...
        'Sanitizer' => danielebuso\sanitizer\Laravel\Facade::class,
    ];

Laravel 精彩之处

如果您正在使用 Laravel，您可以通过外观使用清理器

    $newData = \Sanitizer::make($data, $filters)->sanitize();

您还可以通过添加自己的自定义过滤器轻松扩展清理器库，就像您在 Laravel 中扩展 Validator 库一样，通过从服务提供者调用 extend，如下所示

    \Sanitizer::extend($filterName, $closureOrClassPath);

您还可以通过使用 SanitizesInput 特性在您的 FormRequests 中进行清理输入，并添加一个返回要应用于输入的过滤器的 filters 方法。

    namespace App\Http\Requests;

    use App\Http\Requests\Request;
    use danielebuso\sanitizer\Laravel\SanitizesInput;

    class SanitizedRequest extends Request
    {
        use SanitizesInput;

        public function filters()
        {
            return [
                'name'  => 'trim|capitalize',
                'email' => 'trim',
            ];
        }

        /* ... */

要生成清理请求，只需执行包含的 Artisan 命令

php artisan make:sanitized-request TestSanitizedRequest

与 Laravel FormRequest 的唯一区别是现在您将有一个额外的 'fields' 方法，可以在其中输入您想要应用的输入过滤器，并且输入将在验证之前进行清理。

许可

清理器是开源软件，根据 MIT 许可证 许可