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',
    ];

我们可以很容易地使用我们的清理器和清理器的某些默认过滤器对其进行格式化

    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）。

可用过滤器

以下过滤器是开箱即用的

添加自定义过滤器

您可以通过将自定义过滤器数组传递给清理器构造函数作为第三个参数来添加自己的过滤器。对于每个过滤器名称，必须提供一个闭包或实现 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 数组中注册服务提供程序以及清理器外观。

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

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

Laravel 优点

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

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

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

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

您还可以在您的 FormRequests 中使用 SanitizesInput 特性来清理输入，并添加一个返回您想要应用到输入中的过滤器的 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 许可证