boletosPHP – Biblioteca PHP para tratar informações de boletos bancários

A biblioteca PHP boletosPHP foi desenvolvida no intuito de facilitar o desenvolvimento de aplicações que emitem ou tratam com boletos bancários. Com o uso dela é possível converter dados e extrair informações a partir do código de barras ou linha digitável, ou então montar o código de barras a partir das informações do boleto.

 

Uso

Para usar a biblioteca faça o download AQUI. Descompacte os arquivos e copie a pasta lib para o diretório raiz do seu projeto PHP. Depois, no arquivo PHP onde você deseja usar a biblioteca faça o seguinte:

Pronto, a partir dai o seu objeto boletosPHP está criado e você tem acesso aos métodos da classe. Veja abaixo os métodos.

setIpte(string $ipte)

Este método serve para inserir o valor da linha digitável, quando você já a possui.

setBarras(string $codigoDeBarras)

O método setBarras serve para inserir o código de barras no objeto, quando você já possuí o código. Pode ser usado quando você possuí o código em números, mas deseja imprimir as barras.

setCodBanco(string $codBanco)

Este método pode ser usado para inserir o código do banco no objeto quando você já possui tal código.Cada instituição bancária possui um código único identificador. Veja aqui a lista.

setCodMoeda(integer $codMoeda)

Como os bancos cada moeda tem seu código identificador, no caso do Real (R$) é o número 9. Este método serve para incluir o código da moeda no objeto.

setCodVerificador(integer $codVerificador)

O código verificador é usado para validar o código de barras ou a linha digitável, aqui no Clube dos Geeks já falamos sobre ele e ensinamos a calculá-lo.
Veja: Calculando dígito verificador de código de barras de boleto bancário com PHP
O método setCodVerificador() deve ser usado quando você já tem o código verificador.

setDtVencimento(string $dtVencimento)

Este método é usado para inserir a data de vencimento do boleto. A data deve ser informada no formato d/m/Y.

setFatorVencimento(integer $fatorVencimento)

A fator de vencimento é resultante da diferença de dias entre 07/10/1997 e a data de vencimento do boleto. Esta variável está obrigatoriamente presente no código de barras do boleto.

setValorDocumento(double $valorDocumento)

Este método serve para inserir o valor do boleto. O valor deve ser informado no formato double, ou string com a seguinte formatação 0,000.00.

setNossoNumero(string $nossoNumero)

Este método deve ser usado para informar o Nosso Número, outra variável indispensável ao código de barras.

setCarteira(string $carteira)

Método usado para inserir o número da carteira da empresa que está emitindo o boleto.

getIpte(): string

Este método retorna a linha digitável do boleto, também conhecido como ipte. Ele só deve ser usado quando o ipte ou o código de barras já tenham sido informados, ou então quando houverem informações suficientes para que o ipte seja gerado.

getBarras(): string

Este método retorna os números do código de barras.

getCodBanco(): string

Este método retorna o código do banco.

getCodMoeda(): string

Este método retorna o código da moeda utilizada no boleto.

getCodVerificador() :integer

Este método retorna o dígito verificador do código de barras.

getDtVencimento(string $formato): string

Este método retorna a data de vencimento do boleto, você pode passar o formato por parâmetro seguindo os padrões do PHP, como por exemplo: d/m/Y, Y-m-d, etc. Se não for passado nada por parâmetro o formato padrão será d/m/Y.

getFatorVencimento(): integer

Este método retorna o fator de vencimento do boleto, que é o número que representa a diferença de dias entre 07/10/1997 e a data de vencimento do boleto.

getValorDocumento(string $centavos, string $milhar)

O método getValorDocumento() retorna o valor do boleto com formatação padrão #,###.##. A formatação pode ser mudada usando os parâmetros centavos (divisor para os centavos) e milhar (divisor para o milhar).

getNossoNumero(): string

O método a cima retorna o nosso número do boleto.

getCarteira(): integer

Este método retorna o número da carteira.

desenhaBarras()

Este método desenha as barras do código de barras no documento html pronta para ser impressa e lida por qualquer dispositivo.

Untitled-2.fw

Qualquer dúvida deixe um comentário.

Pax et bonum

Sobre o autor:

Graduado em Análise e Desenvolvimento de Sistemas - FLS; Desenvolvedor Full-stack na UniLeão; Revisor de conteúdo do site Clube dos Geeks, católico, gosto de ler e escrever.

Postagens relacionadas:

7 respostas

  1. Márcio Mazzucato

    Parabéns, Jayr! Sua classe foi extremamente útil para mim, eu estava precisando gerar o código de barras a partir da linha digitável.

    Valeu, um abraço!

    Responder
  2. Leonardo Matos

    Como fazer nos casos de boleto de contas de consumo (água, luz, telefone, gás, etc…)? Os blocos da linha digitável são diferentes. Como interpretar uma linha digitável, neste caso?

    Responder

Deixe uma resposta

Seu e-mail não será publicado.