RFB Document é um pacote que te ajuda a lidar com números de cadastro da Receita Federal do Brasil, CPF (cadastro de pessoa física) e CNPJ (cadastro nacional de pessoa jurídica). Através dele é possível gerar números de CPF/CNPJ válidos, validar um número existente e formatá-los. Tudo de maneira simples e prática.
❗ IMPORTANTE: Este pacote não realiza nenhuma consulta na Receita Federal, portanto, não verifica a situação atual do documento ou se o mesmo está atrelado a uma pessoa ou empresa específica. Toda a checagem é baseada no algorítimo utilizado para gerar os números de cadastro.
Requisitos
Requer PHP 8.0+
Se você usa o Laravel, verifique a compatibilidade de versões:
| Laravel | RFB Document |
|---|---|
| 8.x | 1.x |
| 9.x | 1.x |
Instalação
Para instalar o pacote, basta usar o composer:
composer require tongedev/rfb-document
Em caso de aplicações Laravel, não é preciso publicar o pacote nos Providers, isso é feito de forma automática pelo auto discovery, durante a instalação.
Como usar
Classes
Uma forma de se usar o RFB Document se dá instanciando a classe correspondente ao documento desejado (CPF ou CNPJ) e então usufruindo dos recursos disponíveis:
// no caso de querer manipular CPF
$cpfClass = new Tongedev\RfbDocument\CPFDocument();
$cpf = $cpfClass->generate(); // retorno: xxxxxxxxxxx (um número de CPF aleatório)
// no caso de querer manipular CNPJ
$cnpjClass = new Tongedev\RfbDocument\CNPJDocument();
$cnpj = $cnpjClass->generate(); // retorno: xxxxxxxxxxx (um número de CNPJ aleatório)
Facades
Em aplicações Laravel, é possível tirar proveito do container IoC (inversion of control) presente no framework. Quando o pacote é instalado, suas facades são automaticamente publicadas entre os Providers, permitindo um uso mais rápido dos recursos:
$cpf = CPF::generate(); // retorno: xxxxxxxxxxx (um número de CPF aleatório)
$cnpj = CNPJ::generate(); // retorno: xxxxxxxxxxxxxx (um número de CNPJ aleatório)
Recursos
Os recursos disponíveis são: geração de um novo documento válido, sanitização, formatação e validação de um dado documento. Destacando que as chamadas dos recursos são as mesmas para CPF e CNPJ.
| Recurso | Parâmetro | Retorno |
|---|---|---|
| generate() | bool | formatted (default: false) | documento, formatado ou não (string) |
| sanitize() | string | documentNumber | documento sanitizado (string) |
| format() | string | documentNumber | documento formatado (string) |
| validate() | string | documentNumber | (bool) se documento é válido (true) ou não (false) |
Todos os exemplos abaixo funcionam para CPF e CPNJ, bastando apenas alterar a classe utilizada.
$cpf = CPF::generate(); // retorno: xxxxxxxxxxx (cpf sanitizado)
$cnpj = CNPJ::generate(); // retorno: xxxxxxxxxxxxxxx (cnpj sanitizado)
E os demais métodos:
$cpf = CPF::generate(true); // retorno: xxx.xxx.xxx-xx (cpf formatado)
$cpf = CPF::sanitized('xxx.xxx.xxx-xx'); // retorno: xxxxxxxxxxx (cpf sanitizado)
$cpf = CPF::format('xxxxxxxxxxx'); //retorno: xxx.xxx.xxx-xx (cpf formatado)
$cpf = CPF::validate('xxx.xxx.xxx-xx'); // retorno: booleano dependendo do valor passado no parâmetro
$cpf = CPF::validate('xxxxxxxxxxx'); // é possível passar documento sanitizado também para validação
Exceções
Caso as funções recebam valores ou cadeias de caracteres que não correspondem a um conjunto de dígitos esperado de um dos documentos, uma exceção é lançada:
$cpf = CPF::format('123456ASasdfas'); // esse código irá gerar uma exceção do tipo `RfbDocumentException`.
Contribuindo
Obrigado por considerar contribuir para o RFB Document. Tudo sobre contribuições está descrito aqui.
Licença
RFB Document é um software open source licenciado sob a Licença MIT.
1 Oct 19, 2022
0 Jan 15, 2022
1 Nov 27, 2021
139 Dec 15, 2022
371 Nov 24, 2022
1.5k Jan 3, 2023
4 Feb 7, 2022
3.9k Jan 1, 2023
1.4k Dec 29, 2022
75 Dec 20, 2022
27 Nov 24, 2022
2 Nov 3, 2022
25 Aug 24, 2022
128 Oct 27, 2022
10.7k Jun 13, 2022
5 Oct 5, 2022
368 Dec 27, 2022
955 Dec 25, 2022
5 Oct 5, 2022
10 Aug 12, 2022
4 Oct 16, 2021
2 Mar 18, 2022
153 Jan 2, 2023
767 Jan 2, 2023
451 Dec 27, 2022
246 Jan 5, 2023
20 Nov 13, 2022
48 Apr 10, 2022