Skip to content

Commit

Permalink
melhore o README.md, apoie o projeto
Browse files Browse the repository at this point in the history
  • Loading branch information
@geekcom
geekcom committed May 3, 2021
1 parent 8618ec7 commit 0c60643
Showing 1 changed file with 35 additions and 33 deletions.
68 changes: 35 additions & 33 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,19 +1,23 @@
# LaraValidator Docs - Brasil

_Validação de documentos do Brasil usando **Laravel**_
# Validator Docs - Brasil
_Biblioteca PHP para validação de documentos do Brasil usando **Laravel**_

[![Build Status](https://travis-ci.com/geekcom/validator-docs.svg?branch=master)](https://travis-ci.com/geekcom/validator-docs)
[![Coverage Status](https://coveralls.io/repos/github/geekcom/validator-docs/badge.svg?branch=master)](https://coveralls.io/github/geekcom/validator-docs?branch=master)
[![PHPStan](https://img.shields.io/badge/PHPStan-enabled-brightgreen.svg?style=flat)](https://github.com/phpstan/phpstan)
[![Total Downloads](https://poser.pugx.org/geekcom/validator-docs/downloads)](https://packagist.org/packages/geekcom/validator-docs)
[![License](https://poser.pugx.org/geekcom/validator-docs/license)](https://packagist.org/packages/geekcom/validator-docs)

> Para a versão compatível com Laravel 5 consulte o branch https://github.com/geekcom/validator-docs/tree/5.x.x
> ### Por favor, considere **[fazer uma doação](https://nubank.com.br/pagar/518o5/zVBzxd00Sb)**, apoie nossas atividades
Biblioteca Laravel para validação de CPF, CNPJ, CPF/CNPJ (quando salvos no mesmo atributo), CNH, PIS/PASEP/NIT/NIS, Inscrição Estadual, Título de Eleitor, Cartão Nacional de Saúde(CNS) e Certidões(nascimento/casamento/óbito).
> Para a versão legada compatível com Laravel 5 consulte o branch https://github.com/geekcom/validator-docs/tree/5.x.x
## Instalação
## Recursos
- Validar qualquer documento do Brasil;
- Código testado e confiável;
- Open Source;
- Usado por milhares de sistemas.

## Instalação
No arquivo `composer.json`, adicione validator-docs como dependência do seu projeto:

```
Expand All @@ -36,139 +40,138 @@ composer require geekcom/validator-docs

----------------------------------------------------------------------------------------------------------------------------

## Como usar - Validações disponíveis
## Como usar
Agora que os métodos de validação validator-docs Brasil estão disponíveis, será possível usar da seguinte forma:

Agora, você terá os métodos de validação validator docs Brasil disponíveis.

* **cpf** - Verifica se um CPF é valido.
* **cpf** - Verifica se um CPF é valido;

```php
$this->validate($request, [
'cpf' => 'required|cpf',
]);
```

* **cnpj** - Verifica se um CNPJ é valido.
* **cnpj** - Verifica se um CNPJ é valido;

```php
$this->validate($request, [
'cnpj' => 'required|cnpj',
]);
```

* **cnh** - Verifica se uma CNH (Carteira Nacional de Habilitação) é válida.
* **cnh** - Verifica se uma CNH (Carteira Nacional de Habilitação) é válida;

```php
$this->validate($request, [
'cnh' => 'required|cnh',
]);
```

* **titulo_eleitor** - Verifica se um Título de Eleitor é válido.
* **titulo_eleitor** - Verifica se um Título de Eleitor é válido;

```php
$this->validate($request, [
'titulo_eleitor' => 'required|titulo_eleitor',
]);
```

* **cpf_cnpj** - Verifica se um CPF ou CNPJ é válido.
* **cpf_cnpj** - Verifica se um CPF ou CNPJ é válido;

```php
$this->validate($request, [
'cpf_cnpj' => 'required|cpf_cnpj',
]);
```

* **inscricao_estadual** - Verifica se uma Inscrição Estadual é valida para uma unidade federarativa (UF).
* **inscricao_estadual** - Verifica se uma Inscrição Estadual é valida para uma Unidade Federativa(UF)/Estado;

```php
$this->validate($request, [
'inscricao_estadual' => 'required|inscricao_estadual:BA',
'inscricao_estadual:UF' => 'required|inscricao_estadual:UF',
]);
```

* **nis** - Verifica se um PIS/PASEP/NIT/NIS é válido.
* **nis** - Verifica se um PIS/PASEP/NIT/NIS é válido;

```php
$this->validate($request, [
'nis' => 'required|nis',
]);
```

* **cns** - Verifica se um Cartão Nciona de Saúde (CNS) é válido.
* **cns** - Verifica se um Cartão Nacional de Saúde (CNS) é válido;

```php
$this->validate($request, [
'cns' => 'required|cns',
]);
```

* **certidao** - Verifica se uma certidão de nascimento/casamento/óbito é válida.
* **certidao** - Verifica se uma certidão de nascimento/casamento/óbito é válida;

```php
$this->validate($request, [
'certidao' => 'required|certidao',
]);
```

* **renavam** - Verifica se o RENAVAM é válido
* **renavam** - Verifica se um Registro Nacional de Veículos Automotores (RENAVAM) é válido;

```php
$this->validate($request, [
'renavam' => 'required|renavam',
]);
```

* **placa** - Verifica se a PLACA é válida
* **placa** - Verifica se a PLACA de um veículo é válida;

```php
$this->validate($request, [
'placa' => 'required|placa',
]);
```

* **ddd** - Verifica se a DDD é válida
* **ddd** - Verifica se um número de DDD é válido;

```php
$this->validate($request, [
'ddd' => 'required|ddd',
]);
```

* **formato_cnpj** - Verifica se o formato de um CNPJ é válida. ( 99.999.999/9999-99 )
* **formato_cnpj** - Verifica se o formato`(99.999.999/9999-99)` de um CNPJ é válido;

```php
$this->validate($request, [
'formato_cnpj' => 'required|formato_cnpj',
]);
```

* **formato_cpf** - Verifica se o formato de um CPF é válido. ( 999.999.999-99 )
* **formato_cpf** - Verifica se o formato(`999.999.999-99`) de um CPF é válido;

```php
$this->validate($request, [
'formato_cpf' => 'required|formato_cpf',
]);
```

* **formato_cpf_cnpj** - Verifica se o formato de um CPF ou um CNPJ é válido. ( 999.999.999-99 ) ou ( 99.999.999/9999-99 )
* **formato_cpf_cnpj** - Verifica se o formato de um CPF ou de um CNPJ é válido;

```php
$this->validate($request, [
'formato_cpf_cnpj' => 'required|formato_cpf_cnpj',
]);
```

* **formato_nis** - Verifica se o formato de um PIS/PASEP/NIT/NIS é válido. ( 999.99999-99.9 )
* **formato_nis** - Verifica se o formato(`999.99999-99.9`) de um PIS/PASEP/NIT/NIS é válido;

```php
$this->validate($request, [
'formato_nis' => 'required|formato_nis',
]);
```

* **formato_certidao** - Verifica se o formato de uma certidão é válida. ( 99999.99.99.9999.9.99999.999.9999999-99 ou 99999 99 99 9999 9 99999 999 9999999 99)
* **formato_certidao** - Verifica se o formato(`99999.99.99.9999.9.99999.999.9999999-99` ou `99999 99 99 9999 9 99999 999 9999999 99`), de uma certidão é válida.

```php
$this->validate($request, [
Expand All @@ -178,7 +181,6 @@ $this->validate($request, [
----------------------------------------------------------------------------------------------------------------------------

## Combinando validação e formato

No exemplo abaixo, fazemos um teste onde verificamos a formatação e a validade de um CPF ou CNPJ, para os casos onde a informação deve ser salva em um mesmo atributo:

```php
Expand All @@ -190,7 +192,6 @@ $this->validate($request, [
----------------------------------------------------------------------------------------------------------------------------

## Exemplo de uso em um controller

Método de validação de exemplo em um controller com todas as possibilidades de validação

```php
Expand All @@ -207,17 +208,18 @@ public function store(Request $request)
'cns' => 'required|cns',
'renavam' => 'required|renavam',
'placa' => 'required|placa',
'ddd' => 'required|ddd',
'certidao' => 'required|certidao',
'inscricao_estadual:UF' => 'required|inscricao_estadual:UF',
]);

dd($data);
}
```
**Observe que para validar uma inscrição estadual é necessário informar a [UF](https://pt.wikipedia.org/wiki/Unidades_federativas_do_Brasil)**

----------------------------------------------------------------------------------------------------------------------------

## Geradores de documentos para testes

* **CNH** - http://4devs.com.br/gerador_de_cnh
* **TÍTULO ELEITORAL** - http://4devs.com.br/gerador_de_titulo_de_eleitor
* **CNPJ** - http://www.geradorcnpj.com/
Expand All @@ -228,11 +230,11 @@ public function store(Request $request)
* **INSCRIÇÃO ESTADUAL** - https://www.4devs.com.br/gerador_de_inscricao_estadual
* **RENAVAM** - https://www.4devs.com.br/gerador_de_renavam
* **PLACA** - https://www.4devs.com.br/gerador_de_placa_automoveis
* **INSCRIÇÃO ESTADUAL** - https://www.4devs.com.br/gerador_de_inscricao_estadual

Fique a vontade para contribuir fazendo um fork.
Fique a vontade para contribuir de qualquer forma.

Caso tenha alguma dúvida ou encontre algum bug, abra uma [issue](https://github.com/geekcom/validator-docs/issues) ou pesquise por issues antigas.

## [Contribuidores](https://github.com/geekcom/validator-docs/graphs/contributors)

Contribuições de qualquer tipo são bem-vindas!

0 comments on commit 0c60643

Please sign in to comment.