PHPackages umbrella/retorno-boleto - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Framework](/categories/framework) 4. / 5. umbrella/retorno-boleto ActiveLibrary[Framework](/categories/framework) umbrella/retorno-boleto ======================= Biblioteca em PHP para leitura de arquivos de retorno de títulos de cobrança de bancos brasileiros. 1.3.5(10y ago)2920.9k10[2 issues](https://github.com/umbrellaTech/ya-retorno-boleto/issues)MITPHPPHP >=5.3.3 Since Jul 10Pushed 3y ago13 watchersCompare [ Source](https://github.com/umbrellaTech/ya-retorno-boleto)[ Packagist](https://packagist.org/packages/umbrella/retorno-boleto)[ RSS](/packages/umbrella-retorno-boleto/feed)WikiDiscussions master Synced today READMEChangelog (10)Dependencies (4)Versions (12)Used By (0) Ya Retorno Boleto ================= [](#ya-retorno-boleto) [![Build Status](https://camo.githubusercontent.com/5e289c3dddfef2ad26bd3061f80d30668186f8bc6068c7076bfc6957ba1c246b/687474703a2f2f696d672e736869656c64732e696f2f7472617669732f756d6272656c6c61546563682f79612d7265746f726e6f2d626f6c65746f2e7376673f7374796c653d666c61742d737175617265)](https://travis-ci.org/umbrellaTech/ya-retorno-boleto)[![Scrutinizer Code Quality](https://camo.githubusercontent.com/ab8a407f2f22b46901c492238464ec1f834a8e8ee3a28d2c7c725f39e9fe2dd5/687474703a2f2f696d672e736869656c64732e696f2f7363727574696e697a65722f672f756d6272656c6c61546563682f79612d7265746f726e6f2d626f6c65746f2e7376673f7374796c653d666c61742d737175617265)](https://scrutinizer-ci.com/g/umbrellaTech/ya-retorno-boleto/)[![Code Coverage](https://camo.githubusercontent.com/d052858191ff2d5fb84b20acc7237417077d4227b1701f53117e46a0b782fea4/687474703a2f2f696d672e736869656c64732e696f2f7363727574696e697a65722f636f7665726167652f672f756d6272656c6c61546563682f79612d7265746f726e6f2d626f6c65746f2e7376673f7374796c653d666c61742d737175617265)](https://scrutinizer-ci.com/g/umbrellaTech/ya-retorno-boleto/)[![Latest Stable Version](https://camo.githubusercontent.com/e679ea099a1add4dc7ad79136bb5cb06ebb23cb946e053dc669b284c6da6ce7b/687474703a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f756d6272656c6c612f7265746f726e6f2d626f6c65746f2e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/umbrella/retorno-boleto)[![Downloads](https://camo.githubusercontent.com/83e128d65ab5f84395376b90b92c2138692950d878b44e0a8740ad5f0ae32c3a/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f756d6272656c6c612f7265746f726e6f2d626f6c65746f2e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/umbrella/retorno-boleto) [![SensioLabsInsight](https://camo.githubusercontent.com/fb44d40f7576cde46beda078d49ca4c08f0b0e10540a6c8d7cdeb6386e4a2a98/68747470733a2f2f696e73696768742e73656e73696f6c6162732e636f6d2f70726f6a656374732f65663665393333312d613261642d346132322d626334332d3164643763323861653038362f736d616c6c2e706e67)](https://insight.sensiolabs.com/projects/ef6e9331-a2ad-4a22-bc43-1dd7c28ae086) O que é? -------- [](#o-que-é) Biblioteca em PHP para leitura de arquivos de retorno de títulos de cobrança de bancos brasileiros. Arquivos suportados: **Banco****CNAB****Implementado****Testado****Banco do Brasil**150, 240,400SimSim**Bradesco**400 - personalizadoNãoNão**Caixa Economica**150, 240SimSim**HSBC**150, 240,400SimSim**Itau**150, 240,400SimSim**Santander**150, 240,400SimSimInstalação ---------- [](#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 --- [](#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 ------- [](#eventos) O retorno-boleto tem suporte a eventos utilizando o componente [EventDispatcher](http://symfony.com/doc/current/components/event_dispatcher/introduction.html) 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: **Evento****Event Class****Descrição****ON\_DETAIL\_REGISTER**OnDetailRegisterEventLançado sempre que um registro é iteradoDemo ---- [](#demo) A aplicação de demonstração está no repositório [Ya Boleto Demo](https://github.com/umbrellaTech/ya-boleto-demo) Documentação ------------ [](#documentação) Mais informações podem ser encontradas na documentação on-line em [http://ya-retorno-boleto.readthedocs.org/pt\_BR/latest/](http://ya-retorno-boleto.readthedocs.org/pt_BR/latest/). ### Health Score 38 — LowBetter than 83% of packages Maintenance19 Infrequent updates — may be unmaintained Popularity34 Limited adoption so far Community21 Small or concentrated contributor base Maturity65 Established project with proven stability Bus Factor1 Top contributor holds 68% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~59 days Recently: every ~93 days Total 11 Last Release 3779d ago ### Community Maintainers ![](https://avatars.githubusercontent.com/u/1108049?v=4)[Ítalo Vietro](/maintainers/italolelis)[@italolelis](https://github.com/italolelis) ![](https://www.gravatar.com/avatar/ee69ed5c4858c474fd4ce588122674ddbe55509a5bddcb5650fb32beffc5f321?d=identicon)[AyrtonRicardo](/maintainers/AyrtonRicardo) --- Top Contributors [![italolelis](https://avatars.githubusercontent.com/u/1108049?v=4)](https://github.com/italolelis "italolelis (17 commits)")[![kbca](https://avatars.githubusercontent.com/u/7707738?v=4)](https://github.com/kbca "kbca (4 commits)")[![AyrtonRicardo](https://avatars.githubusercontent.com/u/3937889?v=4)](https://github.com/AyrtonRicardo "AyrtonRicardo (2 commits)")[![mikhailcavalcanti](https://avatars.githubusercontent.com/u/5747855?v=4)](https://github.com/mikhailcavalcanti "mikhailcavalcanti (1 commits)")[![scrutinizer-auto-fixer](https://avatars.githubusercontent.com/u/6253494?v=4)](https://github.com/scrutinizer-auto-fixer "scrutinizer-auto-fixer (1 commits)") --- Tags frameworkboletoyavoxarquivo-retorno ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/umbrella-retorno-boleto/health.svg) ``` [![Health](https://phpackages.com/badges/umbrella-retorno-boleto/health.svg)](https://phpackages.com/packages/umbrella-retorno-boleto) ``` ### Alternatives [symfony/framework-bundle Provides a tight integration between Symfony components and the Symfony full-stack framework 3.6k251.7M11.5k](/packages/symfony-framework-bundle)[shopware/platform The Shopware e-commerce core 3.4k1.5M3](/packages/shopware-platform)[matomo/matomo Matomo is the leading Free/Libre open analytics platform 21.7k38.9k](/packages/matomo-matomo)[silverstripe/framework The SilverStripe framework 7313.7M2.8k](/packages/silverstripe-framework)[drupal/core Drupal is an open source content management platform powering millions of websites and applications. 21866.0M1.7k](/packages/drupal-core)[drupal/core-recommended Locked core dependencies; require this project INSTEAD OF drupal/core. 6942.5M419](/packages/drupal-core-recommended) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)