PHPackages nxstep-si/nx-boletos - 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. [Utility & Helpers](/categories/utility) 4. / 5. nxstep-si/nx-boletos ActiveLibrary[Utility & Helpers](/categories/utility) nxstep-si/nx-boletos ==================== Pacote BoletosPHP aplicado na estrutura Orientada a Objeto 1.0.5.1(9y ago)012MITPHPPHP >=5.4.0 Since Dec 23Pushed 9y ago5 watchersCompare [ Source](https://github.com/nxstep-si/nx-boletos)[ Packagist](https://packagist.org/packages/nxstep-si/nx-boletos)[ RSS](/packages/nxstep-si-nx-boletos/feed)WikiDiscussions master Synced 4w ago READMEChangelog (1)DependenciesVersions (11)Used By (0) BoletosPHP Orientado à Objetos ============================== [](#boletosphp-orientado-à-objetos) Esse pacote foi criado a partir do pacote Boletosphp-oo ([link](https://github.com/giordanolima/boletosphp-oo)) e fornece a mesma lógica orientada a objeto, para uma melhor aplicação em frameworks e uso através do composer. Pacote em desenvolvimento ------------------------- [](#pacote-em-desenvolvimento) Este pacote ainda encontra-se em fase de adaptação e não tem suporte a todos os bancos disponíveis no pacote original. Aos poucos estes vão sendo adicionados. Dê um fork e contribua e ajude com correções de bugs e novas features. Atualmente o pacote possui suporte aos seguintes bancos: - Itaú - Sicredi - Bancoob Install ------- [](#install) Instalação através do composer: Configure o composer para usar um repositório vcs ``` (...) "require" : { "nxstep-si/nx-boletos" : "dev-master" }, (...) "repositories" : [{ "url" : "https://github.com/nxstep-si/nx-boletos", "type" : "vcs" } ] (...) ``` Uso --- [](#uso) ``` use GiordanoLima\BoletosPHP\Boletos; $boleto = new Boletos(Boletos::BOLETOSPHP_ITAU); $boleto->setData([...]); $boleto->setImageBasePath("path/to/images/"); echo $boleto->render(); ``` Constantes ---------- [](#constantes) Ao instanciar a classe, o banco que será gerado o boleto deverá ser passado como parâmetro. Segue abaixo a tabela dos bancos e suas respectivas constantes: BancoConstanteItaúBOLETOSPHP\_ITAUSicrediBOLETOSPHP\_SICREDIBancoobBOLETOSPHP\_BANCOOBDados ----- [](#dados) Os dados dos boletos deverão ser passados através do método `setData`no formato de array, no estilo `campo => valor`. Ex.: ``` $boleto->setData([ "valor_boleto" => "99,00", "data_vencimento" => "01/04/2016", "nosso_numero" => 00000001, (...) ]); ``` Os dados padrão a todos os bancos são: CampoDescriçãoObrigatóriovalor\_boletoValor do boleto no formato de moeda brasileira.SIMdata\_vencimentoData de vencimento do boleto no formato d/m/YSIMnosso\_numeroNúmero que será usado como base para gerar o nosso númeroSIMagenciaAgência do cedenteSIMcontaConta do cedenteSIMconta\_dvDígito verificador da conta do cedenteSIMcarteiraCarteira do cedenteSIMidentificacaoNome do cedenteSIMcpf\_cnpjCPF ou CNPJ do cedenteSIMnumero\_documentoCampo "Número do Documento" do boletoNÃOdata\_documentoData do documento. Formato: d/m/YNÃOdata\_processamentoData do processamento. Formato: d/m/YNÃOsacadoNome do sacadoNÃOenderecoEndereço completo do sacado a ser mostrado no ReciboNÃOendereco1Linha 1 do endereço no corpo do boletoNÃOendereco2Linha 2 do endereço no corpo do boletoNÃOdemonstrativo1Linha 1 do demonstrativoNÃOdemonstrativo2Linha 2 do demonstrativoNÃOdemonstrativo3Linha 3 do demonstrativoNÃOinstrucoes1Linha 1 das instruçõesNÃOinstrucoes2Linha 2 das instruçõesNÃOinstrucoes3Linha 3 das instruçõesNÃOinstrucoes4Linha 4 das instruçõesNÃOquantidadeCampo quantidade do boletoNÃOvalor\_unitarioCampo valor unitário do boletoNÃOaceiteCampo aceito do boletoNÃOespecieCampo espécie do boletoNÃOespecie\_docCampo especie\_doc do boletoNÃOcidade\_ufCidade/UF do cedenteNÃOcedenteRazão Social ou Nome Completo do cedenteNÃOCada banco possui seus campos específicos, são eles, respectivamente:### Itaú [](#itaú) Não existem campos específicos para esse banco. ### Sicredi [](#sicredi) CampoDescriçãoObrigatóriopostoCódigo do posto da cooperativa de créditoSIMbyte\_idtByte de identificação do cedente do bloqueto utilizado para compor o nosso número.SIM### Bancoob [](#bancoob) TODO Descrição Em fase de pré-homologação Imagens ------- [](#imagens) As imagens utilizadas no pacote estão na pasta `imagens` do pacote. Essas imagens deverão ser colocadas em uma pasta pública do projeto e o caminho deverá ser setada pelo método `setImageBasePath`. Ex.: ``` $boleto->setImageBasePath("http://meusite.com.br/img/boletosphp/"); // Com "/" no final ``` Render ------ [](#render) O método `render` irá retornar um código HTML com o respectivo boleto gerado. ``` echo $boleto->render(); /* Irá imprimir um código HTML * * ... * */ ``` Instruções para contribuição ============================ [](#instruções-para-contribuição) Aqui estão algumas instruções sobre o funcionamento do sistema e como contribuir Pastas ------ [](#pastas) O espaço de nomes está configurado para a pasta "src" Nessa pasta estão os arquivos que deverão ser alterados. #### src/Bancos [](#srcbancos) Os arquivos nessa pasta são os motores de tudo. Quando eles chamados recebem o Array com as informações do boleto, fazem alguns cálculos, como geração de números e dígitos de verificação e renderizam o boleto que será gerado, devolvendo o desenho do boleto. Esses arquivos tem funções específicas de cada banco, pois nele são calculados alguns números como o Nosso Número e a sequência de números da linha digitável. Além disso, tem também a função que gera o código de barras para a impressão. É recomendável que as funções incluídas nesses arquivos sejam comentadas pelos autores e/ou coautores. #### src/Boletos [](#srcboletos) A arquivo "AbrstractBoleto.php" é a classe base sobre a qual as outras são extendidas. Cada banco tem um arquivo nessa pasta que extende os atributos da classe. Por exemplo, o arquivo "Bancoob.php" extende a classe AbrstractBoleto(), adequando-a ao uso para o sistema BANCOOB #### src/Contracts [](#srccontracts) Não alterar (TODO) #### src/includes [](#srcincludes) Aqui estão os layouts propriamente ditos. Esses arquivos geram a imressão dos boletos, compondo a tabelas e campos. Altere esses arquivos para modificar o layout da impressão do boleto. #### src/Boletos.php [](#srcboletosphp) Essa é a classe base que é chamada quando usamos esse repositório como biblioteca. Com as funções dessa classe, as outras classes são chamadas. Essa classe recebe como parâmetro o nome do Boleto que se deseja gerar e chama as funções pertinentes. #### src/BoletosException.php [](#srcboletosexceptionphp) Trata alguns erros na classe Boletos() ### Health Score 28 — LowBetter than 52% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity5 Limited adoption so far Community12 Small or concentrated contributor base Maturity64 Established project with proven stability Bus Factor2 2 contributors hold 50%+ of commits 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 ~66 days Recently: every ~98 days Total 7 Last Release 3448d ago ### Community Maintainers ![](https://avatars.githubusercontent.com/u/2422576?v=4)[Elias Alves](/maintainers/unixelias)[@unixelias](https://github.com/unixelias) --- Top Contributors [![giordanolima](https://avatars.githubusercontent.com/u/8314190?v=4)](https://github.com/giordanolima "giordanolima (21 commits)")[![unixelias](https://avatars.githubusercontent.com/u/2422576?v=4)](https://github.com/unixelias "unixelias (21 commits)")[![vinicius73](https://avatars.githubusercontent.com/u/1561347?v=4)](https://github.com/vinicius73 "vinicius73 (2 commits)") --- Tags boletoooboletos ### Embed Badge ![Health badge](/badges/nxstep-si-nx-boletos/health.svg) ``` [![Health](https://phpackages.com/badges/nxstep-si-nx-boletos/health.svg)](https://phpackages.com/packages/nxstep-si-nx-boletos) ``` ### Alternatives [kriansa/openboleto Biblioteca para geração de boletos bancários. 6082.2M2](/packages/kriansa-openboleto)[andersondanilo/cnab_php Projeto para criar arquivos de remessas e processar arquivos de retorno no formato CNAB 329267.9k2](/packages/andersondanilo-cnab-php) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)