nxstep-si / nx-boletos
应用于面向对象结构的BoletosPHP包
Requires
- php: >=5.4.0
This package is not auto-updated.
Last update: 2024-09-23 13:36:59 UTC
README
此包基于Boletosphp-oo包(链接)创建,并提供了相同的面向对象逻辑,以便更好地在框架中使用并通过composer使用。
开发中包
此包目前处于适应阶段,并不支持原始包中所有可用银行。这些银行将逐步添加。请进行分支并贡献,帮助修复错误和添加新功能。目前,该包支持以下银行
- Itaú
- Sicredi
- Bancoob
安装
通过composer安装:配置composer使用vcs仓库
(...) "require" : { "nxstep-si/nx-boletos" : "dev-master" }, (...) "repositories" : [{ "url" : "https://github.com/nxstep-si/nx-boletos", "type" : "vcs" } ] (...)
使用
use GiordanoLima\BoletosPHP\Boletos; $boleto = new Boletos(Boletos::BOLETOSPHP_ITAU); $boleto->setData([...]); $boleto->setImageBasePath("path/to/images/"); echo $boleto->render();
常量
在实例化类时,应将生成票据的银行作为参数传递。以下为银行及其相应常量的表格
数据
票据数据应通过setData
方法以数组格式传递,格式为字段 => 值
。例如:
$boleto->setData([ "valor_boleto" => "99,00", "data_vencimento" => "01/04/2016", "nosso_numero" => 00000001, (...) ]);
所有银行的默认数据为
Itaú
此银行没有特定字段。
Sicredi
Bancoob
待办事项 描述
处于预测试阶段
图片
包中使用的图片位于包的imagens
文件夹中。应将这些图片放置在项目的公共文件夹中,并通过setImageBasePath
方法设置路径。例如:
$boleto->setImageBasePath("http://meusite.com.br/img/boletosphp/"); // Com "/" no final
渲染
render
方法将返回一个包含生成票据的相应HTML代码。
echo $boleto->render(); /* Irá imprimir um código HTML * <html> * ... * </html> */
贡献说明
以下是一些关于系统功能和如何贡献的说明
文件夹
命名空间配置为“src”文件夹。该文件夹包含应更改的文件。
src/Bancos
该文件夹中的文件是所有功能的核心。当它们被调用时,会接收包含票据信息的数组,执行一些计算,如生成数字和校验位,并渲染将要生成的票据,返回票据的设计。这些文件具有特定银行的特定功能,因为其中计算了一些数字,如我们的数字和可读行的数字序列。此外,还有生成用于打印的条形码的功能。建议作者和/或合著者注释掉包含在这些文件中的函数。
src/Boletos
“AbstractBoleto.php”文件是其他类扩展的基础类。该文件夹中每个银行都有一个文件,它扩展了类的属性。
例如,“Bancoob.php”文件扩展了AbstractBoleto()类,使其适用于BANCOOB系统的使用
src/Contracts
不要修改(待办事项)
src/includes
这里是真正的布局。这些文件生成票据的打印,组成表格和字段。修改这些文件以更改票据打印的布局。
src/Boletos.php
这是当我们将此存储库用作库时调用的基础类。通过此类的函数调用其他类。此类接收要生成的票据名称作为参数,并调用相关函数。
src/BoletosException.php
处理Boletos()类中的某些错误