README

清理器

简介

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

示例

给定以下格式的数据数组

    $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 BinaryCats\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的验证器模块非常相似，对于那些已经熟悉它的人来说，尽管使用此库不需要Laravel。

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

可用的过滤器

以下过滤器是开箱即用的

添加自定义过滤器

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

use BinaryCats\Sanitizer\Contracts\Filter;

class RemoveStringsFilter implements Filter
{
    /**
     * Apply filter
     *
     * @param  mixed $value
     * @param  array  $options
     * @return string
     */
    public function apply($value, $options = [])
    {
        return str_replace($options, '', $value);
    }
}

闭包必须始终接受两个参数：$value和一个$options数组

$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 binary-cats/sanitizer

然后您就完成了！如果您正在使用Laravel，您的应用程序将自动注册服务提供程序以及清理器外观

如果您更喜欢手动操作，您需要将值添加到您的config/app.php

    'providers' => [
        ...
        BinaryCats\Sanitizer\Laravel\SanitizerServiceProvider::class,
    ];

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

Laravel功能

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

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

您还可以通过在服务提供程序中调用extend轻松扩展清理器库，就像您在Laravel中扩展验证器库一样

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

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

    namespace App\Http\Requests;

    use App\Http\Requests\Request;
    use BinaryCats\Sanitizer\Laravel\SanitizesInput;

    class SanitizedRequest extends Request
    {
        use SanitizesInput;

        public function filters()
        {
            return [
                'name'  => 'trim|capitalize',
                'email' => 'trim',
                'text'  => 'remove_strings:Curse,Words,Galore',
            ];
        }

        public function customFilters()
        {
            return [
                'remove_strings' => RemoveStringsFilter::class,
            ];
        }

        /* ... */

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

php artisan make:sanitized-request TestSanitizedRequest

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

许可证

清理器是开源软件，许可协议为MIT许可证

感谢

非常感谢原始的WAAVI清理器，这是本存储库的来源。不幸的是，它似乎不再维护。