NFePHP\Esfinge\Tools

Complexity

Total Complexity

32

Size/Duplication

Total Lines	298
Duplicated Lines	33.22 %

Coupling/Cohesion

Components	2
Dependencies	2

Test Coverage

Coverage

9.85%

Importance

Changes	8
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	setCompetencia()	0	11	4
A	getCompetencia()	0	4	1
D	token()	62	129	18
A	obterTokenIniciarTransferencia()	0	11	4
A	servidor()	10	10	1
A	situacaoServidorFolhaPagamento()	9	9	1
A	componentesFolhaPagamento()	9	9	1
A	folhaPagamento()	9	9	1

<?php

namespace NFePHP\Esfinge;

use InvalidArgumentException;
use RuntimeException;
use NFePHP\Esfinge\Response;
use NFePHP\Esfinge\Base;

class Tools extends Base
{
    const TK_Obtem = 'O';
    const TK_Inicia = 'I';
    const TK_Finaliza = 'F';
    const TK_Cancela = 'C';
    const TK_Status = 'S';
    
    /**
     * Endereços principais dos webservices
     * @var array
     */
    protected $url = [
        '1' => 'https://esfingews.tce.sc.gov.br',
        '2' => 'https://desenv2.tce.sc.gov.br:7443',
    ];
    /**
     * Competência bimestral no formato: AAAABB, onde:
     * AAAA = ano a ser enviado os dados
     * BB = bimestre de 01 até 06
     * @var string
     */
    protected $competencia;
    /**
     * Token de segurança e queue
     * hash com 36 caracteres aleatórios
     * @var string
     */
    protected $tokenid;
    /**
     * Flag iniciar tranferencia
     * @var bool
     */
    protected $flagIniciar = false;
    /**
     * Datahora da ultima solicitação da situação do token
     * @var timestramp
     */
    protected $tsLastSitToken;
    
    /**
     * Construtor
     * @param string $configJson
     */
    public function __construct($configJson = '')
    {
        parent::__construct($configJson);
    }
    
    /**
     * Define o período de competência das informações
     * formado AAAABB sendo BB o bimestre de 01 até 06
     * @param string $valor

There is no parameter named $valor. Was it maybe removed?

     */
    public function setCompetencia($aaaabb)
    {
        if (!is_numeric($aaaabb)) {
            throw new InvalidArgumentException('O periodo de competência é uma informação APENAS numérica.');
        }
        $bm = intval(substr($aaaabb, -2));
        if ($bm > 6 || $bm <= 0) {
            throw new InvalidArgumentException('O bimestre pode ser de 01 até 06 APENAS.');
        }
        $this->competencia = $aaaabb;

It seems like $aaaabb can also be of type integer or double. However, the property $competencia is declared as type string. Maybe add an additional type check?

    }
    
    /**
     * Retorna o período de competência informado
     * @return string
     */
    public function getCompetencia()
    {
        return $this->competencia;
    }
    
    /**
     * Operações com token
     * O método pode ser:
     *   C - cancela a transferencia
     *   F - finaliza a transferencia
     *   I - inica a transferencia
     *   O - Obtem o token para realizar as operações
     *   S - Verifica a situação do token
     * @param string $method
     */
    public function token($method = self::TK_Obtem)
    {
        $uri = $this->url[$this->tpAmb].'/esfinge/services/tokenWS';
        $namespace = 'http://token.ws.tce.sc.gov.br/';
        
        switch ($method) {
            case self::TK_Cancela:

This code seems to be duplicated across your project.

                //cancela as operações realizadas com um determinado token
                //se OK o token é removido e todas as operações com ele
                //realizadas são descartadas
                if ($this->flagIniciar === false) {
                    //não está iniciada a tranferencia então não dá para cancelar
                    throw new RuntimeException('A tranferencia não foi iniciada, então não pode ser cancelada');
                }
                $met = 'cancelarTransferencia';
                $body = "<svc:cancelarTransferencia>"
                    . "<chaveToken>$this->tokenid</chaveToken>"
                    . "</svc:cancelarTransferencia>";
                $retorno = $this->oSoap->send($uri, $namespace, $this->header, $body, $met);
                $resp =  Response::readReturn($met, $retorno);
                if ($resp['bStat']) {
                    //cancelamento aceito
                    $this->tokenid = '';
                    $this->flagIniciar = false;
                }
                break;
            case self::TK_Finaliza:

This code seems to be duplicated across your project.

                //Ao final da transferência caso queria confirmar todos os elementos inseridos
                //(que não retornaram erro) nesta sessão, ou seja todos os elementos ligados a
                //determinado token passado para o serviço. Uma vez executado este serviço
                //o token atual será descartado.
                if ($this->flagIniciar === false) {
                    //não está iniciada a tranferencia então não dá para finalizar
                    throw new RuntimeException('A tranferencia não foi iniciada, então não pode ser finalizada');
                }
                $met = 'finalizarTransferencia';
                $body = "<svc:finalizarTransferencia>"
                    . "<chaveToken>$this->tokenid</chaveToken>"
                    . "</svc:finalizarTransferencia>";
                $retorno = $this->oSoap->send($uri, $namespace, $this->header, $body, $met);
                $resp =  Response::readReturn($met, $retorno);
                if ($resp['bStat']) {
                    //finalização aceita
                    $this->tokenid = '';
                    $this->flagIniciar = false;
                }
                break;
            case self::TK_Inicia:
                //Antes de iniciar a transferência dos dados propriamente dita, será necessário executar
                //o serviço iniciarTransferencia
                if ($this->tokenid == '') {
                    //não é possivel iniciar sem um token valido
                    throw new RuntimeException('Não é possivel iniciar a tranferência sem um token valido');
                    //$this->token(self::TK_O);

78% of this comment could be valid code. Did you maybe forget this after debugging?

                }
                if ($this->flagIniciar === true) {
                    $resp = [
                        'bStat' => true,
                        'message' => 'Início de transferência liberado',
                        'status' => 'OK'
                    ];
                    break;
                }
                $met = 'iniciarTransferencia';
                $body = "<svc:iniciarTransferencia>"
                    . "<chaveToken>$this->tokenid</chaveToken>"
                    . "</svc:iniciarTransferencia>";
                $retorno = $this->oSoap->send($uri, $namespace, $this->header, $body, $met);
                $resp =  Response::readReturn($met, $retorno);
                if ($resp['bStat']) {
                    $this->flagIniciar = true;
                }
                break;
            case self::TK_Obtem:
                //Retorna um token para a unidade gestora poder usar o serviço do TCE.
                //Permite somente um token por unidade gestora.
                if ($this->tokenid != '') {

This code seems to be duplicated across your project.

                    $resp = [
                        'bStat' => true,
                        'message' => 'Token criado com sucesso',
                        'status' => 'OK',
                        'chaveToken' => $this->tokenid,
                        'posicao' => 2,
                        'situacao' => 'Pronto para envio ou consulta'
                    ];
                    break;
                }
                $met = 'obterToken';
                $body = "<svc:obterToken>"
                    . "<codigoUg>$this->codigoUnidadeGestora</codigoUg>"
                    . "</svc:obterToken>";
                $retorno = $this->oSoap->send($uri, $namespace, $this->header, $body, $met);
                $resp =  Response::readReturn($met, $retorno);
                if ($resp['bStat'] && $resp['chaveToken'] != '') {
                    $this->tokenid = $resp['chaveToken'];
                }
                break;
            case self::TK_Status:
                //Retorna a situação do token passado como parâmetro. Para evitar solicitações
                //indefinidas a este serviço o sistema punirá com a remoção do token da fila
                //sempre que for feita duas chamadas seguidas do serviço obterSituacaoToken
                //em menos de cinco segundos.
                if ($this->tokenid == '') {
                    //não é possivel verificar o token
                    throw new RuntimeException('Não existe um token aberto.');
                }
                //se tentativa de verificação ocorrer em menos de 2 seg
                //retorna como OK
                if ((time()-$this->tsLastSitToken) <= 2) {

This code seems to be duplicated across your project.

                    $resp = [
                        'bStat' => true,
                        'message' => 'Situação token obtida com sucesso',
                        'status' => 'OK',
                        'posicao' => 1,
                        'situacao' => 'Pronto para envio ou consulta'
                    ];
                    break;
                }
                $met = 'obterSituacaoToken';
                $body = "<svc:obterSituacaoToken>"
                    . "<chaveToken>$this->tokenid</chaveToken>"
                    . "</svc:obterSituacaoToken>";
                $retorno = $this->oSoap->send($uri, $namespace, $this->header, $body, $met);
                $resp =  Response::readReturn($met, $retorno);
                $this->tsLastSitToken = time();

It seems like time() of type integer is incompatible with the declared type object<NFePHP\Esfinge\timestramp> of property $tsLastSitToken.

                break;
        }
        return $resp;

The variable $resp does not seem to be defined for all execution paths leading up to this point.

    }
    
    /**
     * Inicia o processo de tranferência de dados
     * @param array $data
     * @throws InvalidArgumentException
     * @throws RuntimeException
     */
    protected function obterTokenIniciarTransferencia($data = array())
    {
        if (empty($data)) {
            throw new InvalidArgumentException('Não foram passados dados para o método');
        }
        $this->token(self::TK_Obtem);
        $this->token(self::TK_Inicia);
        if ($this->tokenid == '' || $this->flagIniciar === false) {
            throw new RuntimeException("Falha token:$this->tokenid , Iniciar: $this->flagIniciar");
        }
    }

    /**
     * Servidor
     * @param array $data
     * @param string $method
     * @return array
     */
    public function servidor($data = array(), $method = 'L')

This method seems to be duplicated in your project.

    {
        $this->obterTokenIniciarTransferencia($data);
        $uri = $this->url[$this->tpAmb].'/esfinge/services/servidorWS';
        $namespace = 'http://servidor.ws.tce.sc.gov.br/';
        $met = 'servidor'.$method;
        //envia a mensagem via cURL
        $resp = $this->envia($uri, $namespace, $data, $method, $met);
        return $resp;
    }
    
    /**
     * Situação Servidor Folha Pagamento
     * @param array $data
     * @param string $method
     * @return array
     */
    public function situacaoServidorFolhaPagamento($data = array(), $method = 'L')

This method seems to be duplicated in your project.

    {
        $this->obterTokenIniciarTransferencia($data);
        $uri = $this->url[$this->tpAmb].'/esfinge/services/situacaoServidorFolhaPagamentoWS';
        $namespace = 'http://situacaoservidorfolhapagamento.ws.tce.sc.gov.br/';
        $met = 'situacaoServidorFolhaPagamento'.$method;
        $resp = $this->envia($uri, $namespace, $data, $method, $met);
        return $resp;
    }

    /**
     * Componentes Folha Pagamento
     * @param array $data
     * @param string $method
     * @return array
     */
    public function componentesFolhaPagamento($data = array(), $method = 'L')

This method seems to be duplicated in your project.

    {
        $this->obterTokenIniciarTransferencia($data);
        $uri = $this->url[$this->tpAmb].'/esfinge/services/componentesFolhaPagamentoWS';
        $namespace = 'http://componentesfolhapagamento.ws.tce.sc.gov.br/';
        $met = 'componentesFolhaPagamento'.$method;
        $resp = $this->envia($uri, $namespace, $data, $method, $met);
        return $resp;
    }

    /**
     * Folha Pagamento
     * @param array $data
     * @param string $method
     * @return array
     */
    public function folhaPagamento($data = array(), $method = 'L')

This method seems to be duplicated in your project.

    {
        $this->obterTokenIniciarTransferencia($data);
        $uri = $this->url[$this->tpAmb].'/esfinge/services/folhaPagamentoWS';
        $namespace = 'http://folhapagamento.ws.tce.sc.gov.br/';
        $met = 'folhaPagamento'.$method;
        $resp = $this->envia($uri, $namespace, $data, $method, $met);
        return $resp;
    }
}