README

RFB Document 是一个帮助你处理巴西联邦税务局的注册号，包括个人身份证号码（CPF）和公司注册号（CNPJ）的包。通过它，你可以生成有效的CPF/CNPJ号码，验证现有号码，并格式化它们。这一切都简单方便。

❗ 重要：此包不与巴西联邦税务局进行任何查询，因此不会验证文档的当前状态或是否与特定个人或公司相关。所有检查都基于用于生成注册号的算法。

要求

需要 PHP 8.0+

如果你使用 Laravel，请检查版本兼容性

安装

要安装此包，只需使用 composer

composer require tongedev/rfb-document

对于 Laravel 应用程序，不需要在 Providers 中发布包，这将在安装过程中通过自动发现自动完成。

如何使用

类

使用 RFB Document 的方法之一是实例化对应所需文档（CPF 或 CNPJ）的类，然后使用可用的资源

// 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)

外观

在 Laravel 应用程序中，可以利用框架中存在的 IoC（控制反转）容器。安装包时，其外观将自动在 Providers 中发布，从而可以更快地使用资源

$cpf = CPF::generate(); // retorno: xxxxxxxxxxx (um número de CPF aleatório)

$cnpj = CNPJ::generate(); // retorno: xxxxxxxxxxxxxx (um número de CNPJ aleatório)

资源

可用的资源包括：生成新的有效文档，清理，格式化和验证文档。需要注意的是，对资源的调用对于 CPF 和 CNPJ 是相同的。

以下所有示例均适用于 CPF 和 CPNJ，只需更改所使用的类即可。

$cpf = CPF::generate(); // retorno: xxxxxxxxxxx (cpf sanitizado)

$cnpj = CNPJ::generate(); // retorno: xxxxxxxxxxxxxxx (cnpj sanitizado)

以及其他方法

$cpf = CPF::generate(true); // retorno: xxx.xxx.xxx-xx (cpf formatado)

$cpf = CPF::sanitize('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

异常

如果函数接收到的值或字符串不符合文档预期的数字集合，将抛出异常

$cpf = CPF::format('123456ASasdfas'); // esse código irá gerar uma exceção do tipo `RfbDocumentException`.

贡献

感谢您考虑为 RFB Document 贡献。有关贡献的所有信息都描述在 这里。

👋 在 Twitter 上关注作者 @devatreides 以获取最新消息并了解其他项目。你好！

许可证

RFB Document 是一个开源软件，根据 MIT 许可证 许可。