Sanitizer
Sanitizer é um package para higienizar os dados de sua aplicação em uma camada separada., (*1)
Muitas vezes é necessário uma camada intermediária na aplicação, com o objetivo de realizar a higienização de dados,
estes geralmente provenientes de formulários do usuário. Por exemplo, você deseja realizar a limpeza dos espaços em
branco dos campos do formulário antes de enviar os dados para o banco de dados., (*2)
Este pacote tem como base a excelente aula do Jeffrey Way sobre Sanitizers.
https://github.com/laracasts/Sanitizers-and-PHPSpec, (*3)
Instalação
O pacote pode ser instalado através do composer.
Para que o package seja adicionado automaticamente ao seu arquivo composer.json execute o seguinte comando:, (*4)
composer require lukzgois/sanitizer
ou se preferir, adicione o seguinte trecho manualmente:, (*5)
{
"require": {
"lukzgois/sanitizer" : "0.2.x"
}
}
Utilização
Criar uma classe extendendo Lukzgois\Sanitizer\Sanitizer, (*6)
<?php
use Lukzgois\Sanitizer\Sanitizer;
class SanitizeRequest extends Sanitizer {
public function rules()
{
return [
'first_name' => 'trim|ucword',
'last_name' => 'trim|ucwords'
];
}
}
Utilizar o método sanitize com o array de dados a ser validado:, (*7)
<?php
$data = ['name' => ' john doe '];
$sanitizer = new SanitizeRequest();
$sanitizedData = $sanitizer->sanitize($data);
var_dump($sanitizedData); // ['name' => 'John Doe']
Você pode sobrescrever as regras de higienização passando um array como segundo parâmetro da função sanitize():, (*8)
$sanitizer->sanitize($data, ['name' => 'strtoupper']);
Para utilizar métodos personalizados na classe basta criá-los com o prefixo "sanitize":, (*9)
<?php
use Lukzgois\Sanitizer\Sanitizer;
class SanitizeRequest extends Sanitizer {
public function rules()
{
return [
'phone' => 'phone',
];
}
public function sanitizePhone($value)
{
return str_replace('-','', $value);
}
}
Você tambem pode utilizar outras classes para realizar a higienização, basta para isso indicar o caminho completo para essa classe. Por padrão o package irá procurar pela função sanitize() nessa classe. Para utilizar outra função basta indicar com um @ após o nome da classe:, (*10)
<?php
use Lukzgois\Sanitizer\Sanitizer;
class SanitizeRequest extends Sanitizer {
public function rules()
{
return [
'first_name' => '\App\Sanitizers\NameSanitizer', // sanitize()
'last_name' => '\App\Sanitizers\NameSanitizer@lastName' // lastName()
];
}
}
Também é possível passar argumentos para as funções personalizadas da seguinte maneira:, (*11)
<?php
use Lukzgois\Sanitizer\Sanitizer;
class SanitizeRequest extends Sanitizer {
public function rules()
{
return [
'first_name' => '\App\Sanitizers\MinValueSanitizer:100', // sanitize()
];
}
}
class \App\Sanitizers\MinValueSanitizer {
public function sanitize($value, $min)
{
return $value < $min ? $min : $value;
}
}
obs: Você também pode passar argumentos para os métodos personalizados., (*12)
Por padrão, o package conta com uma função customizada, a função default, que serve para definir um valor padrão para um campo caso este venha nulo ou vazio, por exemplo:, (*13)
<?php
use Lukzgois\Sanitizer\Sanitizer;
class SanitizeRequest extends Sanitizer {
public function rules()
{
return [
'name' => 'trim|ucwords',
'company' => 'default:1'
];
}
}
<?php
$data = ['name' => ' john doe '];
$sanitizer = new SanitizeRequest();
$sanitizedData = $sanitizer->sanitize($data);
var_dump($sanitizedData); // ['name' => 'John Doe', 'company' => 1]
Cast Sanitizer
O higienizador "cast" permite transformar o tipo de uma variável, por exemplo, um valor recebido como string pode ser transformado em um inteiro. São suportados os tipos: string, integer, boolean e float., (*14)
<?php
use Lukzgois\Sanitizer\Sanitizer;
class SanitizeRequest extends Sanitizer {
public function rules()
{
return [
'age' => 'cast:integer',
];
}
}
<?php
$data = ['age' => '25'];
$sanitizer = new SanitizeRequest();
$sanitizedData = $sanitizer->sanitize($data);
var_dump($sanitizedData); // ['age' => (int)25]
Por padrão este higienizador é executado mesmo que o valor enviado seja null. Caso você deseje que ele ignore os valores null basta definir o terceiro argumento como false., (*15)
public function rules()
{
return [
'age' => 'cast:integer:false',
];
}
Generator para Laravel 5
Caso você esteja utilizando Laravel 5 pode utilizar a ferramenta artisan para criar o sanitizer automaticamente., (*16)
Para isso basta adicionar no arquivo app/config/app.php na seção de providers a seguinte linha:, (*17)
'Lukzgois\Sanitizer\Laravel\SanitizerServiceProvider',
Feito isso basta utilizar o comando da seguinte maneira:, (*18)
php artisan make:sanitizer CreateUserSanitizer
Um novo sanitizer será criado na pasta app/Sanitizers com o seguinte conteúdo:, (*19)
<?php namespace App\Sanitizers;
use Lukzgois\Sanitizer\Sanitizer;
class CreateUserSanitizer extends Sanitizer {
public function rules()
{
return [
];
}
}
Wallogit.com
