laravellegends/pt-br-validator

Uma biblioteca contendo validações de formatos Brasileiros, para o Laravel

11.0.0 2024-03-18 20:18 UTC

Requires

• illuminate/support: ^6.0 || ^7.0 || ^8.0 || ^9.0 || ^10.0 || ^11.0

Requires (Dev)

• orchestra/testbench: ^4.0 || ^5.0 || ^6.0 || ^7.0 || ^8.0
• phpunit/phpunit: ^8.3 || ^9.0

MIT

• Wallace de Souza Vizerra

README

Esta biblioteca adiciona validações brasileira ao Laravel, como CPF, CNPJ, Placa de Carro, CEP, Telefone, Celular e afins.

🇧🇷🇧🇷🇧🇷

Versões

Instalação

Navegue até a pasta do seu projeto, por exemplo:

cd /etc/www/projeto

E então execute:

composer require laravellegends/pt-br-validator

Caso esteja utilizando uma versão desta biblioteca anterior a 5.2, você deve o provider em config/app.php

'providers' => [
    // ... outros pacotes
    LaravelLegends\PtBrValidator\ValidatorProvider::class
]

Agora, para utilizar a validação, basta fazer o procedimento padrão do Laravel.

A diferença é que será possível usar os seguintes métodos de validação:

Testando as validações do PtBrValidator

Com isso, é possível fazer um teste simples

$validator = \Validator::make(
    ['telefone' => '(77)9999-3333'],
    ['telefone' => 'required|telefone_com_ddd']
);

dd($validator->fails());

Você pode utilizá-lo também com a instância de Illuminate\Http\Request, através do método validate.

Veja:

use Illuminate\Http\Request;

// URL: /testando?telefone=3455-1222

Route::get('testando', function (Request $request) {

    try{

        $dados = $request->validate([
            'telefone' => 'required|telefone',
            // outras validações aqui
        ]);

    } catch (\Illuminate\Validation\ValidationException $e) {
        dd($e->errors());
    }

});

Customizando as mensagens

Todas as validações citadas acima já contam mensagens padrões de validação, porém, é possível alterar isto usando o terceiro parâmetro de Validator::make. Este parâmetro deve ser um array onde os índices sejam os nomes das validações e os valores devem ser as respectivas mensagens.

Por exemplo:

Validator::make($valor, $regras, ['celular_com_ddd' => 'O campo :attribute não é um celular'])

Ou através do método messages do seu Request criado pelo comando php artisan make:request.

public function messages() {

    return [
        'campo.telefone' => 'Telefone não válido!'
    ];
}

Acessando as Regras separadamente

Caso tenha necessidade de acessar alguma regra separadamente, você poderá ter acesso as seguintes classes:

\LaravelLegends\PtBrValidator\Rules\Celular::class
\LaravelLegends\PtBrValidator\Rules\CelularComDdd::class
\LaravelLegends\PtBrValidator\Rules\CelularComCodigo::class
\LaravelLegends\PtBrValidator\Rules\Cnh::class
\LaravelLegends\PtBrValidator\Rules\Cnpj::class
\LaravelLegends\PtBrValidator\Rules\Cpf::class
\LaravelLegends\PtBrValidator\Rules\Cns::class
\LaravelLegends\PtBrValidator\Rules\FormatoCnpj::class
\LaravelLegends\PtBrValidator\Rules\FormatoCpf::class
\LaravelLegends\PtBrValidator\Rules\Telefone::class
\LaravelLegends\PtBrValidator\Rules\TelefoneComDdd::class
\LaravelLegends\PtBrValidator\Rules\TelefoneComCodigo::class
\LaravelLegends\PtBrValidator\Rules\FormatoCep::class
\LaravelLegends\PtBrValidator\Rules\FormatoPlacaDeVeiculo::class
\LaravelLegends\PtBrValidator\Rules\FormatoPis::class
\LaravelLegends\PtBrValidator\Rules\Pis::class
\LaravelLegends\PtBrValidator\Rules\CpfOuCnpj::class
\LaravelLegends\PtBrValidator\Rules\FormatoCpfOuCnpj::class
\LaravelLegends\PtBrValidator\Rules\Uf::class

Por exemplo, se você deseja validar o formato do campo de um CPF, você pode utilizar a classe LaravelLegends\PtBrValidator\Rules\FormatoCpf da seguinte forma:

use Illuminate\Http\Request;
use LaravelLegends\PtBrValidator\Rules\FormatoCpf;

// testando?cpf=valor_invalido

Route::get('testando', function (Request $request) {

    try{

        $dados = $request->validate([
            'cpf'  => ['required', new FormatoCpf]
            // outras validações aqui
        ]);

    } catch (\Illuminate\Validation\ValidationException $e) {
        dd($e->errors());
    }

});

Changelog

• 9.1.0 - Validação cns (cartão nacional de saúde) adicionada.
• 8.0.3 - Validação uf adicionada.
• 8.0.2 - Validação cpf_ou_cnpj
• 5.2.1 - Validação cpf_ou_cnpj

Sugestões

Eloquent Filter: Essa biblioteca foi desenvolvida com o propósito de criar facilmente filtros de pesquisa para APIs REST. Com esta biblioteca, você vai economizar várias linhas de códigos, bem como manter um padrão global para filtros de pesquisa em sua aplicação escrita em Laravel.

Doações

Paypal