umbrella / retorno-boleto
Biblioteca em PHP para leitura de arquivos de retorno de títulos de cobrança de bancos brasileiros.
Installs: 20 744
Dependents: 2
Suggesters: 0
Security: 0
Stars: 26
Watchers: 13
Forks: 12
Open Issues: 2
Requires
- php: >=5.3.3
- danielstjules/stringy: ~1.7
- easyframework/collections: ~3.1
- symfony/event-dispatcher: ~2.5
Requires (Dev)
- phpunit/phpunit: ~4.2
README
O que é?
Biblioteca em PHP para leitura de arquivos de retorno de títulos de cobrança de bancos brasileiros.
Arquivos suportados:
Instalação
# Install Composer curl -sS https://getcomposer.org/installer | php # Adicionando YA Retorno Boleto como dependencia php composer.phar require umbrella/retorno-boleto:~1.2
Após a instalação, é necessário carregar o autoloader do composer:
require 'vendor/autoload.php';
Uso
Para lermos um arquivo de retorno, utilizamos uma factory que nos dirao tipo correto do arquivo e passaremos ele para um processador que irá lhe retornar o objeto do arquivo de retorno.
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();
Eventos
O retorno-boleto tem suporte a eventos utilizando o componente EventDispatcher do 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; });
Atualmente temos os seguintes eventos:
Demo
A aplicação de demonstração está no repositório Ya Boleto Demo
Documentação
Mais informações podem ser encontradas na documentação on-line em http://ya-retorno-boleto.readthedocs.org/pt_BR/latest/.