README

关于WAAVI

WAAVI是一家西班牙网络开发和产品咨询公司，自2013年以来一直与初创公司和其他在线企业合作。需要在Laravel或PHP中完成工作？请通过waavi.com联系我们。

简介

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

尽管不仅限于Laravel 5用户，但为此框架提供了一些扩展，例如通过自定义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',
    ];

我们可以很容易地使用我们的Sanitizer和一些Sanitizer的默认过滤器来格式化它

    use \Waavi\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）。

可用过滤器

以下过滤器是默认可用的

添加自定义过滤器

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

    class RemoveStringsFilter implements Waavi\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 waavi/sanitizer ~1.0

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

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

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

Laravel插件

如果您正在使用Laravel，您可以通过Facade使用Sanitizer

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

您还可以通过像扩展Laravel中的Validator库一样，通过调用从ServiceProvider中扩展来轻松扩展Sanitizer库

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

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

    namespace App\Http\Requests;

    use App\Http\Requests\Request;
    use Waavi\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'方法，可以在此处输入您希望应用的输入过滤器，并且输入将在验证之前被清理。

许可

WAAVI Sanitizer是开源软件，受MIT许可证许可。