ggwebdev/openboleto

银行汇票生成库。

dev-master 2017-02-28 13:45 UTC

This package is not auto-updated.

Last update: 2024-09-18 20:43:59 UTC


README

OpenBoleto 是一个用于生成银行汇票的开源代码库,这是巴西非常常见的支付方式。其重点是简单易用,并兼容 PHP 最现代的功能。

安装

Composer

如果您已经熟悉 Composer(强烈推荐),只需将以下依赖项添加到您的 composer.json 文件中的 "require" 指令。

"ggwebdev/boleto": "dev-master"

或者,如果您想使用 v1.0 版本(2013年12月8日)

"ggwebdev/boleto": "v1.0"

### PSR-0 自动加载器 由于几乎任何框架都使用此标准,因此您应该 下载 OpenBoleto,将其放置在特定的文件夹中(通常是 libvendor),并在框架文档中查找以使自动加载器将命名空间 OpenBoleto 指向 OpenBoleto 的 src 文件夹。

### 独立库 如果您只想下载并包含它,这也很简单。首先 下载(或克隆仓库),然后将其放置在特定的文件夹中。然后,包含 autoloader.php 文件即可!

生成汇票

这是最有趣的部分。它很简单,看看以下基本示例

use OpenBoleto\Banco\BancoDoBrasil;
use OpenBoleto\Agente;
 
$sacado = new Agente('Fernando Maia', '023.434.234-34', 'ABC 302 Bloco N', '72000-000', 'Brasília', 'DF');
$cedente = new Agente('Empresa de cosméticos LTDA', '02.123.123/0001-11', 'CLS 403 Lj 23', '71000-000', 'Brasília', 'DF');
 
$boleto = new BancoDoBrasil(array(
    // Parâmetros obrigatórios
    'dataVencimento' => new DateTime('2013-01-24'),
    'valor' => 23.00,
    'sequencial' => 1234567, // Para gerar o nosso número
    'sacado' => $sacado,
    'cedente' => $cedente,
    'agencia' => 1724, // Até 4 dígitos
    'carteira' => 18,
    'conta' => 10403005, // Até 8 dígitos
    'convenio' => 1234, // 4, 6 ou 7 dígitos
));
 
echo $boleto->getOutput();

是的,就这么多!请记住,每个银行都有一些特定的要求,但通常这些参数是必须的。在 samples 文件夹中,每个银行都有一个功能示例,您可以检查哪些是每个银行必需的参数。

支持的银行

目前 OpenBoleto 支持以下银行

  • 巴西利亚银行 (BRB)
  • 巴西银行
  • 布拉德斯科
  • 圣保罗银行(SIGCB)
  • 伊塔乌
  • 桑坦德
  • 优尼克里德

任何贡献都受欢迎。如果您想将 OpenBoleto 适配到其他银行,请随意探索代码,了解如何轻松地将任何银行集成到库中。

许可证

  • MIT 许可证