README

Retorno-BoletoPHP

Biblioteca de classes em PHP para leitura de arquivos de retorno de títulos de cobrança
de bancos brasileiros.

O projeto utiliza Design Patterns para permitir a fácil extensão, para adição
de novos padrões de arquivos de retorno.

Toda a documentação das classes está disponível em HTML, no diretório doc. O arquivo
principal é o index.html

Um diagrama de classes para a ferramenta case Umbrello (nativa de sistemas GNU Linux) está disponível no arquivo diagramas-uml.umbrello.xmi
Uma imagem do diagrama pode ser vista em class_diagram.png

Um script sh para sistemas GNU Linux, para geração/atualização
da documentação em HTML está disponível no arquivo gerardoc.sh
Edite o arquivo para incluir os caminhos corretos dos diretórios
do projeto no seu computador.

Um arquivo de retorno de exemplo está disponível em retorno.ret
Um exemplo de uso para leitura de tal arquivo pode ser acessado
pelo arquivo exemplo.php

O projeto é disponibilizado como está e não é fornecida
nenhuma garantia para quem o utilizar. O(s) desenvolvedor(es) não
se responsabiliza(m) por nenhum dano ou prejuízo que você venha
a ter por utilizar o projeto, ficando completamente isento
de qualquer responsabilidade. Tais garantias só são dadas
a clientes que paguem pelo serviço de suporte.

Observações

Apenas o padrão CNAB400 foi testado.