NFe\Task\Protocolo

Complexity

Total Complexity

32

Size/Duplication

Total Lines	302
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

95.37%

Importance

Changes

0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	getChave()	0	7	2
A	setChave()	0	5	1
A	getValidacao()	0	7	2
A	setValidacao()	0	5	1
A	getNumero()	0	7	2
A	setNumero()	0	5	1
A	getMensagem()	0	7	2
A	setMensagem()	0	5	1
A	getCodigo()	0	7	2
A	setCodigo()	0	5	1
A	toArray()	0	10	1
B	fromArray()	0	35	8
A	loadNode()	0	17	2
A	getNode()	0	35	5

<?php
/**
 * MIT License
 *
 * Copyright (c) 2016 MZ Desenvolvimento de Sistemas LTDA
 *
 * @author Francimar Alves <mazinsw@gmail.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 *
 */
namespace NFe\Task;

use NFe\Core\Nota;
use NFe\Common\Util;

/**
 * Protocolo de autorização da nota, é retornado pela autorização, recibo
 * ou situação e anexado à nota
 */
class Protocolo extends Retorno
{
    /**
     * Chaves de acesso da NF-e, compostas por: UF do emitente, AAMM da emissão
     * da NFe, CNPJ do emitente, modelo, série e número da NF-e e código
     * numérico+DV.
     *
     * @var string
     */
    private $chave;

    /**
     * Digest Value da NF-e processada. Utilizado para conferir a integridade
     * da NF-e original.
     *
     * @var string
     */
    private $validacao;

    /**
     * Número do Protocolo de Status da NF-e. 1 posição (1 – Secretaria de
     * Fazenda Estadual 2 – Receita Federal); 2 - códiga da UF - 2 posições
     * ano; 10 seqüencial no ano.
     *
     * @var string
     */
    private $numero;

    /**
     * Mensagem da SEFAZ para o emissor.
     *
     * @var string
     */
    private $mensagem;

    /**
     * Código da Mensagem.
     *
     * @var string
     */
    private $codigo;

    /**
     * Constroi uma instância de Protocolo vazia
     * @param array $protocolo Array contendo dados do Protocolo
     */
    public function __construct($protocolo = [])
    {
        parent::__construct($protocolo);
    }

    /**
     * Chaves de acesso da NF-e, compostas por: UF do emitente, AAMM da emissão
     * da NFe, CNPJ do emitente, modelo, série e número da NF-e e código
     * numérico+DV.
     * @param boolean $normalize informa se a chave deve estar no formato do XML
     * @return string chave of Protocolo
     */
    public function getChave($normalize = false)
    {
        if (!$normalize) {
            return $this->chave;
        }
        return $this->chave;
    }
    
    /**
     * Altera o valor da Chave para o informado no parâmetro
     * @param mixed $chave novo valor para Chave
     * @param string $chave Novo chave para Protocolo
     * @return self A própria instância da classe
     */
    public function setChave($chave)
    {
        $this->chave = $chave;
        return $this;
    }

    /**
     * Digest Value da NF-e processada. Utilizado para conferir a integridade
     * da NF-e original.
     * @param boolean $normalize informa se a validacao deve estar no formato do XML
     * @return string validacao of Protocolo
     */
    public function getValidacao($normalize = false)
    {
        if (!$normalize) {
            return $this->validacao;
        }
        return $this->validacao;
    }
    
    /**
     * Altera o valor da Validacao para o informado no parâmetro
     * @param mixed $validacao novo valor para Validacao
     * @param string $validacao Novo validacao para Protocolo
     * @return self A própria instância da classe
     */
    public function setValidacao($validacao)
    {
        $this->validacao = $validacao;
        return $this;
    }

    /**
     * Número do Protocolo de Status da NF-e. 1 posição (1 – Secretaria de
     * Fazenda Estadual 2 – Receita Federal); 2 - códiga da UF - 2 posições
     * ano; 10 seqüencial no ano.
     * @param boolean $normalize informa se o numero deve estar no formato do XML
     * @return string numero of Protocolo
     */
    public function getNumero($normalize = false)
    {
        if (!$normalize) {
            return $this->numero;
        }
        return $this->numero;
    }
    
    /**
     * Altera o valor do Numero para o informado no parâmetro
     * @param mixed $numero novo valor para Numero
     * @param string $numero Novo numero para Protocolo
     * @return self A própria instância da classe
     */
    public function setNumero($numero)
    {
        $this->numero = $numero;
        return $this;
    }

    /**
     * Mensagem da SEFAZ para o emissor.
     * @param boolean $normalize informa se a mensagem deve estar no formato do XML
     * @return string mensagem of Protocolo
     */
    public function getMensagem($normalize = false)
    {
        if (!$normalize) {
            return $this->mensagem;
        }
        return $this->mensagem;
    }
    
    /**
     * Altera o valor da Mensagem para o informado no parâmetro
     * @param mixed $mensagem novo valor para Mensagem
     * @param string $mensagem Novo mensagem para Protocolo
     * @return self A própria instância da classe
     */
    public function setMensagem($mensagem)
    {
        $this->mensagem = $mensagem;
        return $this;
    }

    /**
     * Código da Mensagem.
     * @param boolean $normalize informa se o codigo deve estar no formato do XML
     * @return string codigo of Protocolo
     */
    public function getCodigo($normalize = false)
    {
        if (!$normalize) {
            return $this->codigo;
        }
        return $this->codigo;
    }
    
    /**
     * Altera o valor do Codigo para o informado no parâmetro
     * @param mixed $codigo novo valor para Codigo
     * @param string $codigo Novo codigo para Protocolo
     * @return self A própria instância da classe
     */
    public function setCodigo($codigo)
    {
        $this->codigo = $codigo;
        return $this;
    }

    /**
     * Converte a instância da classe para um array de campos com valores
     * @return array Array contendo todos os campos e valores da instância
     */
    public function toArray($recursive = false)
    {
        $protocolo = parent::toArray($recursive);
        $protocolo['chave'] = $this->getChave();
        $protocolo['validacao'] = $this->getValidacao();
        $protocolo['numero'] = $this->getNumero();
        $protocolo['mensagem'] = $this->getMensagem();
        $protocolo['codigo'] = $this->getCodigo();
        return $protocolo;
    }

    /**
     * Atribui os valores do array para a instância atual
     * @param mixed $protocolo Array ou instância de Protocolo, para copiar os valores
     * @return self A própria instância da classe
     */
    public function fromArray($protocolo = [])
    {
        if ($protocolo instanceof Protocolo) {
            $protocolo = $protocolo->toArray();
        } elseif (!is_array($protocolo)) {
            return $this;
        }
        parent::fromArray($protocolo);
        if (!isset($protocolo['chave'])) {
            $this->setChave(null);
        } else {
            $this->setChave($protocolo['chave']);
        }
        if (!array_key_exists('validacao', $protocolo)) {
            $this->setValidacao(null);
        } else {
            $this->setValidacao($protocolo['validacao']);
        }
        if (!array_key_exists('numero', $protocolo)) {
            $this->setNumero(null);
        } else {
            $this->setNumero($protocolo['numero']);
        }
        if (!array_key_exists('mensagem', $protocolo)) {
            $this->setMensagem(null);
        } else {
            $this->setMensagem($protocolo['mensagem']);
        }
        if (!array_key_exists('codigo', $protocolo)) {
            $this->setCodigo(null);
        } else {
            $this->setCodigo($protocolo['codigo']);
        }
        return $this;
    }

    /**
     * Carrega as informações do nó e preenche a instância da classe
     * @param DOMElement $element Nó do xml com todos as tags dos campos
     * @param string $name Nome do nó que será carregado
     * @return DOMElement Instância do nó que foi carregado
     */
    public function loadNode($element, $name = null)
    {
        $name = is_null($name) ? 'infProt' : $name;
        $element = parent::loadNode($element, $name);
        $this->setChave(
            Util::loadNode(
                $element,
                'chNFe',
                'Tag "chNFe" não encontrada no Protocolo'
            )
        );
        $this->setValidacao(Util::loadNode($element, 'digVal'));
        $this->setNumero(Util::loadNode($element, 'nProt'));
        $this->setMensagem(Util::loadNode($element, 'xMsg'));
        $this->setCodigo(Util::loadNode($element, 'cMsg'));
        return $element;
    }

    /**
     * Cria um nó XML do protocolo de acordo com o leiaute da NFe
     * @param string $name Nome do nó que será criado
     * @return DOMElement Nó que contém todos os campos da classe
     */
    public function getNode($name = null)
    {
        $old_uf = $this->getUF();
        $this->setUF(null);
        $info = parent::getNode('infProt');
        $this->setUF($old_uf);
        $dom = $info->ownerDocument;
        $element = $dom->createElement(is_null($name) ? 'protNFe' : $name);
        $versao = $dom->createAttribute('versao');
        $versao->value = Nota::VERSAO;
        $element->appendChild($versao);

        $id = $dom->createAttribute('Id');
        $id->value = 'ID' . $this->getNumero(true);
        $info->appendChild($id);

        $status = $info->getElementsByTagName('cStat')->item(0);
        Util::appendNode($info, 'nProt', $this->getNumero(true), $status);
        Util::appendNode($info, 'digVal', $this->getValidacao(true), $status);
        $nodes = $info->getElementsByTagName('dhRecbto');
        if ($nodes->length > 0) {
            $recebimento = $nodes->item(0);
        } else {
            $recebimento = $status;
        }
        Util::appendNode($info, 'chNFe', $this->getChave(true), $recebimento);
        if (!is_null($this->getCodigo())) {
            Util::appendNode($info, 'cMsg', $this->getCodigo(true));
        }
        if (!is_null($this->getMensagem())) {
            Util::appendNode($info, 'xMsg', $this->getMensagem(true));
        }
        $element->appendChild($info);
        return $element;
    }
}