README

Esse pacote foi criado a partir do pacote BoletosPHP original (link) e fornece a mesma lógica, porém orientado a objeto, para uma melhor aplicação em frameworks e uso através do composer.

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

Install

Instalação através do composer:

composer require giordanolima/boletosphp-oo

Uso

use GiordanoLima\BoletosPHP\Boletos;
$boleto = new Boletos(Boletos::BOLETOSPHP_ITAU);
$boleto->setData([...]);
$boleto->setImageBasePath("path/to/images/");
echo $boleto->render();

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:

Dados

Os dados dos boletos deverão ser passados através do método setDatano 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:

Itaú

Não existem campos específicos para esse banco.

Sicredi

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

O método render irá retornar um código HTML com o respectivo boleto gerado.

echo $boleto->render();
/* Irá imprimir um código HTML
 * <html>
 * ...
 * </html>
*/

giordanolima / boletosphp-oo

Maintainers

Details