nandodutra/openboleto

生成银行汇票的库。

v1.4 2016-07-18 13:17 UTC

This package is not auto-updated.

Last update: 2024-09-20 21:29:52 UTC


README

OpenBoleto是一个开源的银行汇票生成库,是巴西非常常见的支付方式。重点是简单易用,并且与PHP的最新特性兼容。

安装

Composer

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

"kriansa/openboleto": "dev-master"

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

"kriansa/openboleto": "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许可