Umbrella\Ya\RetornoBoleto\Cnab\Cnab400\Convenio\Processor\AbstractCNAB400Processor

Complexity

Total Complexity

17

Size/Duplication

Total Lines	232
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	12

Importance

Changes	11
Bugs	1	Features	2

8 Methods

Rating	Name	Duplication	Size	Complexity
A	createHeader()	0	4	1
A	createDetail()	0	4	1
A	createTrailer()	0	4	1
B	processarHeaderArquivo()	0	36	2
A	processarDetalhe()	0	50	1
B	processarTrailerArquivo()	0	45	1
A	processCnab()	0	16	3
C	processarLinha()	0	32	7

<?php

namespace Umbrella\Ya\RetornoBoleto\Cnab\Cnab400\Convenio\Processor;

use InvalidArgumentException;
use Stringy\Stringy;
use Umbrella\Ya\RetornoBoleto\AbstractProcessor;
use Umbrella\Ya\RetornoBoleto\Cnab\Cnab400\Detail;
use Umbrella\Ya\RetornoBoleto\Cnab\Cnab400\Header;
use Umbrella\Ya\RetornoBoleto\Cnab\Cnab400\ITrailer;
use Umbrella\Ya\RetornoBoleto\Cnab\Cnab400\Trailer;
use Umbrella\Ya\RetornoBoleto\Cnab\ComposableInterface;
use Umbrella\Ya\RetornoBoleto\Exception\EmptyLineException;
use Umbrella\Ya\RetornoBoleto\Exception\InvalidPositionException;
use Umbrella\Ya\RetornoBoleto\LoteInterface;
use Umbrella\Ya\RetornoBoleto\Model\Banco;
use Umbrella\Ya\RetornoBoleto\Model\Cedente;
use Umbrella\Ya\RetornoBoleto\Model\Cobranca;
use Umbrella\Ya\RetornoBoleto\RetornoInterface;

/**
 * Classe abstrata para leitura de arquivos de retorno de cobranças no padrão CNAB400/CBR643.<br/>
 * Layout Padrão CNAB/Febraban 400 posições<br/>.
 * Baseado na documentação para "Layout de Arquivo Retorno para Convênios
 * na faixa numérica entre 000.001 a 999.999 (Convênios de até 6 posições). Versão Set/09" e
 * "Layout de Arquivo Retorno para convênios na faixa numérica entre 1.000.000 a 9.999.999
 * (Convênios de 7 posições). Versão Set/09" do Banco do Brasil
 * (arquivos Doc8826BR643Pos6.pdf e Doc2628CBR643Pos7.pdf)
 * @author Ítalo Lelis de Vietro <italolelis@gmail.com>
 */
abstract class AbstractCNAB400Processor extends AbstractProcessor
{
    /**
     * @property int HEADER_ARQUIVO Define o valor que identifica uma coluna do tipo HEADER DE ARQUIVO
     */
    const HEADER_ARQUIVO = 0;

    /**
     * @property int TRAILER_ARQUIVO Define o valor que identifica uma coluna do tipo TRAILER DE ARQUIVO
     */
    const TRAILER_ARQUIVO = 9;

    public function createHeader()
    {
        return new Header();
    }

    public function createDetail()
    {
        return new Detail();
    }

    public function createTrailer()
    {
        return new Trailer();
    }

    /**
     * Processa a linha header do arquivo
     * @param string $linha Linha do header de arquivo processado
     * @return string Retorna um vetor contendo os dados dos campos do header do arquivo.
     */
    protected function processarHeaderArquivo($linha)
    {
        $header = $this->createHeader();
        //X = ALFANUMÉRICO 9 = NUMÉRICO V = VÍRGULA DECIMAL ASSUMIDA
        $header->setRegistro($linha->substr(1, 1)->trim());

The method substr cannot be called on $linha (of type string).

        $header->setTipoOperacao($linha->substr(2, 1)->trim());

The method substr cannot be called on $linha (of type string).

        $header->setIdTipoOperacao($linha->substr(3, 7)->trim());

The method substr cannot be called on $linha (of type string).

        $header->setIdTipoServico($linha->substr(10, 2)->trim());

The method substr cannot be called on $linha (of type string).

        $header->setTipoServico($linha->substr(12, 8)->trim());

The method substr cannot be called on $linha (of type string).

        $header->addComplemento($linha->substr(20, 7)->trim());

The method substr cannot be called on $linha (of type string).

        $bancoArray = array();
        if (!preg_match('#^([\d]{3})(.+)#', $linha->substr(77, 18)->trim(), $bancoArray)) {

The method substr cannot be called on $linha (of type string).

            throw new InvalidArgumentException('Banco invalido');
        }

        $banco = new Banco();
        $banco
            ->setCod($bancoArray[1])
            ->setNome($bancoArray[2])
            ->setAgencia($linha->substr(27, 4)->trim())

The method substr cannot be called on $linha (of type string).

            ->setDvAgencia($linha->substr(31, 1)->trim())

The method substr cannot be called on $linha (of type string).

            ->setConta($linha->substr(32, 8)->trim())

The method substr cannot be called on $linha (of type string).

            ->setDvConta($linha->substr(40, 1)->trim());

The method substr cannot be called on $linha (of type string).

        $cedente = new Cedente();
        $cedente->setBanco($banco)
            ->setNome($linha->substr(47, 30)->trim());

The method substr cannot be called on $linha (of type string).

        $header->setCedente($cedente);
        $header->setDataGravacao($this->createDate($linha->substr(95, 6)->trim()));

The method substr cannot be called on $linha (of type string).

        $header->setSequencialReg($linha->substr(395, 6)->trim());

The method substr cannot be called on $linha (of type string).

        return $header;
    }

    /**
     * Processa uma linha detalhe do arquivo.
     * @param string $linha Linha detalhe do arquivo processado
     * @return string Retorna um vetor contendo os dados dos campos da linha detalhe.
     */
    protected function processarDetalhe($linha)
    {
        $detail = $this->createDetail();

        $bancoEmissor = new Banco();
        $bancoEmissor
            ->setAgencia($linha->substr(22, 1)->trim())

The method substr cannot be called on $linha (of type string).

            ->setDvAgencia($linha->substr(31, 1)->trim())

The method substr cannot be called on $linha (of type string).

            ->setConta($linha->substr(23, 8)->trim())

The method substr cannot be called on $linha (of type string).

            ->setDvConta($linha->substr(31, 1)->trim());

The method substr cannot be called on $linha (of type string).

        $bancoRecebedor = new Banco();
        $bancoRecebedor
            ->setCod($linha->substr(166, 3)->trim())

The method substr cannot be called on $linha (of type string).

            ->setAgencia($linha->substr(169, 4)->trim())

The method substr cannot be called on $linha (of type string).

            ->setDvAgencia($linha->substr(173, 1)->trim());

The method substr cannot be called on $linha (of type string).

        $detail
            ->setBancoEmissor($bancoEmissor)
            ->setBancoRecebedor($bancoRecebedor)
            ->setRegistro($linha->substr(1, 1)->trim())

The method substr cannot be called on $linha (of type string).

            ->setTaxaDesconto($this->formataNumero($linha->substr(96, 5)->trim()))

The method substr cannot be called on $linha (of type string).

            ->setTaxaIof($linha->substr(101, 5)->trim())

The method substr cannot be called on $linha (of type string).

            ->setCateira($linha->substr(107, 2)->trim())

The method substr cannot be called on $linha (of type string).

            ->setComando($linha->substr(109, 2)->trim())

The method substr cannot be called on $linha (of type string).

            ->setDataOcorrencia($this->createDate($linha->substr(111, 6)->trim()))

The method substr cannot be called on $linha (of type string).

            ->setNumTitulo($linha->substr(117, 10)->trim())

The method substr cannot be called on $linha (of type string).

            ->setDataVencimento($this->createDate($linha->substr(147, 6)->trim()))

The method substr cannot be called on $linha (of type string).

            ->setValor($this->formataNumero($linha->substr(153, 13)->trim()))

The method substr cannot be called on $linha (of type string).

            ->setEspecie($linha->substr(174, 2)->trim())

The method substr cannot be called on $linha (of type string).

            ->setDataCredito($this->createDate($linha->substr(176, 6)->trim()))

The method substr cannot be called on $linha (of type string).

            ->setValorTarifa($this->formataNumero($linha->substr(182, 7)->trim()))

The method substr cannot be called on $linha (of type string).

            ->setOutrasDespesas($this->formataNumero($linha->substr(189, 13)->trim()))

The method substr cannot be called on $linha (of type string).

            ->setJurosDesconto($this->formataNumero($linha->substr(202, 13)->trim()))

The method substr cannot be called on $linha (of type string).

            ->setIofDesconto($this->formataNumero($linha->substr(215, 13)->trim()))

The method substr cannot be called on $linha (of type string).

            ->setValorAbatimento($this->formataNumero($linha->substr(228, 13)->trim()))

The method substr cannot be called on $linha (of type string).

            ->setDescontoConcedido($this->formataNumero($linha->substr(241, 13)->trim()))

The method substr cannot be called on $linha (of type string).

            ->setValorRecebido($this->formataNumero($linha->substr(254, 13)->trim()))

The method substr cannot be called on $linha (of type string).

            ->setJurosMora($this->formataNumero($linha->substr(267, 13)->trim()))

The method substr cannot be called on $linha (of type string).

            ->setOutrosRecebimentos($this->formataNumero($linha->substr(280, 13)->trim()))

The method substr cannot be called on $linha (of type string).

            ->setAbatimentoNaoAprovado($this->formataNumero($linha->substr(293, 13)->trim()))

The method substr cannot be called on $linha (of type string).

            ->setValorLancamento($this->formataNumero($linha->substr(306, 13)->trim()))

The method substr cannot be called on $linha (of type string).

            ->setIndicativoDc($linha->substr(319, 1)->trim())

The method substr cannot be called on $linha (of type string).

            ->setIndicadorValor($linha->substr(320, 1)->trim())

The method substr cannot be called on $linha (of type string).

            ->setValorAjuste($this->formataNumero($linha->substr(321, 12)->trim()))

The method substr cannot be called on $linha (of type string).

            ->setCanalPagTitulo($linha->substr(393, 2)->trim())

The method substr cannot be called on $linha (of type string).

            ->setSequencial($linha->substr(395, 6)->trim());

The method substr cannot be called on $linha (of type string).

        return $detail;
    }

    /**
     * Processa a linha trailer do arquivo.
     * @param string $linha Linha trailer do arquivo processado
     * @return ITrailer Retorna um vetor contendo os dados dos campos da linha trailer do arquivo.
     */
    protected function processarTrailerArquivo($linha)
    {
        $trailer = $this->createTrailer();

        $banco = new Banco();
        $banco->setCod($linha->substr(5, 3)->trim());

The method substr cannot be called on $linha (of type string).

        $simples = new Cobranca();
        $simples->setQtdTitulos($linha->substr(18, 8)->trim())

The method substr cannot be called on $linha (of type string).

            ->setValorTotal($this->formataNumero($linha->substr(26, 14)->trim()))

The method substr cannot be called on $linha (of type string).

            ->setNumAviso($linha->substr(40, 8)->trim());

The method substr cannot be called on $linha (of type string).

        $vinculada = new Cobranca();
        $vinculada->setQtdTitulos($linha->substr(58, 8)->trim())

The method substr cannot be called on $linha (of type string).

            ->setValorTotal($this->formataNumero($linha->substr(66, 14)->trim()))

The method substr cannot be called on $linha (of type string).

            ->setNumAviso($linha->substr(80, 8)->trim());

The method substr cannot be called on $linha (of type string).

        $caucionada = new Cobranca();
        $caucionada->setQtdTitulos($linha->substr(98, 8)->trim())

The method substr cannot be called on $linha (of type string).

            ->setValorTotal($this->formataNumero($linha->substr(106, 14)->trim()))

The method substr cannot be called on $linha (of type string).

            ->setNumAviso($linha->substr(120, 8)->trim());

The method substr cannot be called on $linha (of type string).

        $descontada = new Cobranca();
        $descontada->setQtdTitulos($linha->substr(138, 8)->trim())

The method substr cannot be called on $linha (of type string).

            ->setValorTotal($this->formataNumero($linha->substr(146, 14)->trim()))

The method substr cannot be called on $linha (of type string).

            ->setNumAviso($linha->substr(160, 8)->trim());

The method substr cannot be called on $linha (of type string).

        $vendor = new Cobranca();
        $vendor->setQtdTitulos($linha->substr(218, 8)->trim())

The method substr cannot be called on $linha (of type string).

            ->setValorTotal($this->formataNumero($linha->substr(226, 14)->trim()))

The method substr cannot be called on $linha (of type string).

            ->setNumAviso($linha->substr(240, 8)->trim());

The method substr cannot be called on $linha (of type string).

        $trailer
            ->setBanco($banco)
            ->setRegistro($linha->substr(1, 1)->trim())

The method substr cannot be called on $linha (of type string).

            ->setRetorno($linha->substr(2, 1)->trim())

The method substr cannot be called on $linha (of type string).

            ->setTipoRegistro($linha->substr(3, 2)->trim())

The method substr cannot be called on $linha (of type string).

            ->setSimples($simples)
            ->setVinculada($vinculada)
            ->setCaucionada($caucionada)
            ->setDescontada($descontada)
            ->setVendor($vendor)
            ->setSequencial($linha->substr(395, 6)->trim());

The method substr cannot be called on $linha (of type string).

        return $trailer;
    }

    public function processCnab(RetornoInterface $retorno, ComposableInterface $composable, LoteInterface $lote = null)
    {
        switch ((int)$composable->getRegistro()->__toString()) {
            case self::HEADER_ARQUIVO:
                $retorno->setHeader($composable);

$composable of type object<Umbrella\Ya\RetornoBoleto\Cnab\ComposableInterface> is not a sub-type of object<Umbrella\Ya\RetornoBoleto\Cnab\CnabHeaderInterface>. It seems like you assume a child interface of the interface Umbrella\Ya\RetornoBoleto\Cnab\ComposableInterface to be always present.

                break;

            case self::TRAILER_ARQUIVO:
                $retorno->setTrailer($composable);

$composable of type object<Umbrella\Ya\RetornoBoleto\Cnab\ComposableInterface> is not a sub-type of object<Umbrella\Ya\RetornoBoleto\Cnab\CnabTrailerInterface>. It seems like you assume a child interface of the interface Umbrella\Ya\RetornoBoleto\Cnab\ComposableInterface to be always present.

                break;

            default:
                $lote->addDetail($composable);

$composable of type object<Umbrella\Ya\RetornoBoleto\Cnab\ComposableInterface> is not a sub-type of object<Umbrella\Ya\RetornoBoleto\Cnab\CnabDetailInterface>. It seems like you assume a child interface of the interface Umbrella\Ya\RetornoBoleto\Cnab\ComposableInterface to be always present.

It seems like $lote is not always an object, but can also be of type null. Maybe add an additional type check?

                break;
        }
    }

    /**
     * Processa uma linha do arquivo de retorno.
     * @param int $numLn Número_linha a ser processada
     * @param string $linha String contendo a linha a ser processada
     * @return IComposable Retorna um vetor associativo contendo os valores_linha processada.
     */
    public function processarLinha($numLn, Stringy $linha)
    {
        $tamLinha = 400; //total de caracteres das linhas do arquivo
        //o +2 é utilizado para contar o \r\n no final da linha
        if (strlen($linha) != $tamLinha && strlen($linha) != $tamLinha + 2) {
            throw new InvalidPositionException("A linha $numLn não tem $tamLinha posições. Possui " . strlen($linha));
        }

        if (trim($linha) == "") {
            throw new EmptyLineException("A linha $numLn está vazia.");
        }

        //é adicionado um espaço vazio no início_linha para que
        //possamos trabalhar com índices iniciando_1, no lugar_zero,
        //e assim, ter os valores_posição_campos exatamente
        //como no manual CNAB400
        $linha = $linha->insert(" ", 0);
        $tipoLn = $linha->substr(1, 1)->trim();

        $this->needToCreateLote = false;
        if ((string)$tipoLn == static::HEADER_ARQUIVO) {
            $this->needToCreateLote = true;
            $vlinha = $this->processarHeaderArquivo($linha);
        } elseif ((string)$tipoLn == static::DETALHE) {
            $vlinha = $this->processarDetalhe($linha);
        } elseif ((string)$tipoLn == static::TRAILER_ARQUIVO) {
            $vlinha = $this->processarTrailerArquivo($linha);
        } else {
            $vlinha = null;
        }
        return $vlinha;
    }
}