Download the PHP package tongedev/rfb-document without Composer
On this page you can find all versions of the php package tongedev/rfb-document. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package rfb-document
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 algoritmo 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:
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:
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:
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.
E os demais métodos:
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:
Contribuindo
Obrigado por considerar contribuir para o RFB Document. Tudo sobre contribuições está descrito aqui.
👋 Siga o autor @devatreides no Twitter para saber das últimas novidades e conhecer outros projetos. Diga oi!
Licença
RFB Document é um software open source licenciado sob a Licença MIT.
