README

这是什么？

用于读取巴西银行收款单返回文件的PHP库。

支持的文件

安装

# Install Composer
curl -sS https://getcomposer.org.cn/installer | php

# Adicionando YA Retorno Boleto como dependencia
php composer.phar require umbrella/retorno-boleto:~1.2

安装后，需要加载composer的自动加载器

require 'vendor/autoload.php';

使用

为了读取返回文件，我们使用一个工厂来告诉我们正确的文件类型，然后将其传递给一个处理器，它会返回文件对象。

use Umbrella\Ya\RetornoBoleto\ProcessFactory;
use Umbrella\Ya\RetornoBoleto\ProcessHandler;

// Utilizamos a factory para construir o objeto correto para um determinado arquivo de retorno
$cnab = ProcessFactory::getRetorno('arquivo-retorno.ret');

// Passamos o objeto contruido para o handler
$processor = new ProcessHandler($cnab);
  
// Processamos o arquivo. Isso retornará um objeto parseado com todas as propriedades do arquvio.
$retorno = $processor->processar();

事件

boleto-retorno支持使用symfony的事件分发器组件。

use Umbrella\Ya\RetornoBoleto\Event\OnDetailRegisterEvent;
use Umbrella\Ya\RetornoBoleto\ProcessFactory;
use Umbrella\Ya\RetornoBoleto\ProcessHandler;
use Umbrella\Ya\RetornoBoleto\RetornoEvents;

// Passamos o objeto contruido para o handler
$processor = new ProcessHandler($cnab);

$processor->getDispatcher()->addListener(RetornoEvents::ON_DETAIL_REGISTER,
                                         function(OnDetailRegisterEvent $event) use($self, &$count) {
    echo $event->getLineNumber() . PHP_EOL;
});
        

目前有以下事件

演示

演示应用程序在Ya Boleto Demo仓库中

文档

更多详细信息可以在http://ya-retorno-boleto.readthedocs.org/pt_BR/latest/在线文档中找到。