Protocolo::setMensagem() - Code Metrics - Inspection of "Adicionado mensagem e código da sefaz no protocolo" - mazinsw/nfe-api - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 4c1910...711493 )

by Francimar

created 2020-01-24 15:50 UTC

Protocolo::setMensagem() A

↳ Parent: Protocolo

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	5
ccs	3
cts	3
cp	1
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1
crap	1

<?php
/**
 * MIT License
 *
 * Copyright (c) 2016 MZ Desenvolvimento de Sistemas LTDA
 *
 * @author Francimar Alves <[email protected]>
 *
 * 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;
    }
}


1		<?php
2		/**
3		* MIT License
4		*
5		* Copyright (c) 2016 MZ Desenvolvimento de Sistemas LTDA
6		*
7		* @author Francimar Alves <[email protected]>
8		*
9		* Permission is hereby granted, free of charge, to any person obtaining a copy
10		* of this software and associated documentation files (the "Software"), to deal
11		* in the Software without restriction, including without limitation the rights
12		* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13		* copies of the Software, and to permit persons to whom the Software is
14		* furnished to do so, subject to the following conditions:
15		*
16		* The above copyright notice and this permission notice shall be included in all
17		* copies or substantial portions of the Software.
18		*
19		* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20		* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21		* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22		* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23		* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24		* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
25		* SOFTWARE.
26		*
27		*/
28		namespace NFe\Task;
29
30		use NFe\Core\Nota;
31		use NFe\Common\Util;
32
33		/**
34		* Protocolo de autorização da nota, é retornado pela autorização, recibo
35		* ou situação e anexado à nota
36		*/
37		class Protocolo extends Retorno
38		{
39		/**
40		* Chaves de acesso da NF-e, compostas por: UF do emitente, AAMM da emissão
41		* da NFe, CNPJ do emitente, modelo, série e número da NF-e e código
42		* numérico+DV.
43		*
44		* @var string
45		*/
46		private $chave;
47
48		/**
49		* Digest Value da NF-e processada. Utilizado para conferir a integridade
50		* da NF-e original.
51		*
52		* @var string
53		*/
54		private $validacao;
55
56		/**
57		* Número do Protocolo de Status da NF-e. 1 posição (1 – Secretaria de
58		* Fazenda Estadual 2 – Receita Federal); 2 - códiga da UF - 2 posições
59		* ano; 10 seqüencial no ano.
60		*
61		* @var string
62		*/
63		private $numero;
64
65		/**
66		* Mensagem da SEFAZ para o emissor.
67		*
68		* @var string
69		*/
70		private $mensagem;
71
72		/**
73		* Código da Mensagem.
74		*
75		* @var string
76		*/
77		private $codigo;
78
79		/**
80		* Constroi uma instância de Protocolo vazia
81		* @param array $protocolo Array contendo dados do Protocolo
82		*/
83	9	public function __construct($protocolo = [])
84		{
85	9	parent::__construct($protocolo);
86	9	}
87
88		/**
89		* Chaves de acesso da NF-e, compostas por: UF do emitente, AAMM da emissão
90		* da NFe, CNPJ do emitente, modelo, série e número da NF-e e código
91		* numérico+DV.
92		* @param boolean $normalize informa se a chave deve estar no formato do XML
93		* @return string chave of Protocolo
94		*/
95	8	public function getChave($normalize = false)
96		{
97	8	if (!$normalize) {
98	7	return $this->chave;
99		}
100	3	return $this->chave;
101		}
102
103		/**
104		* Altera o valor da Chave para o informado no parâmetro
105		* @param mixed $chave novo valor para Chave
106		* @param string $chave Novo chave para Protocolo
107		* @return self A própria instância da classe
108		*/
109	9	public function setChave($chave)
110		{
111	9	$this->chave = $chave;
112	9	return $this;
113		}
114
115		/**
116		* Digest Value da NF-e processada. Utilizado para conferir a integridade
117		* da NF-e original.
118		* @param boolean $normalize informa se a validacao deve estar no formato do XML
119		* @return string validacao of Protocolo
120		*/
121	4	public function getValidacao($normalize = false)
122		{
123	4	if (!$normalize) {
124	3	return $this->validacao;
125		}
126	3	return $this->validacao;
127		}
128
129		/**
130		* Altera o valor da Validacao para o informado no parâmetro
131		* @param mixed $validacao novo valor para Validacao
132		* @param string $validacao Novo validacao para Protocolo
133		* @return self A própria instância da classe
134		*/
135	9	public function setValidacao($validacao)
136		{
137	9	$this->validacao = $validacao;
138	9	return $this;
139		}
140
141		/**
142		* Número do Protocolo de Status da NF-e. 1 posição (1 – Secretaria de
143		* Fazenda Estadual 2 – Receita Federal); 2 - códiga da UF - 2 posições
144		* ano; 10 seqüencial no ano.
145		* @param boolean $normalize informa se o numero deve estar no formato do XML
146		* @return string numero of Protocolo
147		*/
148	4	public function getNumero($normalize = false)
149		{
150	4	if (!$normalize) {
151	4	return $this->numero;
152		}
153	3	return $this->numero;
154		}
155
156		/**
157		* Altera o valor do Numero para o informado no parâmetro
158		* @param mixed $numero novo valor para Numero
159		* @param string $numero Novo numero para Protocolo
160		* @return self A própria instância da classe
161		*/
162	9	public function setNumero($numero)
163		{
164	9	$this->numero = $numero;
165	9	return $this;
166		}
167
168		/**
169		* Mensagem da SEFAZ para o emissor.
170		* @param boolean $normalize informa se a mensagem deve estar no formato do XML
171		* @return string mensagem of Protocolo
172		*/
173	4	public function getMensagem($normalize = false)
174		{
175	4	if (!$normalize) {
176	4	return $this->mensagem;
177		}
178		return $this->mensagem;
179		}
180
181		/**
182		* Altera o valor da Mensagem para o informado no parâmetro
183		* @param mixed $mensagem novo valor para Mensagem
184		* @param string $mensagem Novo mensagem para Protocolo
185		* @return self A própria instância da classe
186		*/
187	9	public function setMensagem($mensagem)
188		{
189	9	$this->mensagem = $mensagem;
190	9	return $this;
191		}
192
193		/**
194		* Código da Mensagem.
195		* @param boolean $normalize informa se o codigo deve estar no formato do XML
196		* @return string codigo of Protocolo
197		*/
198	4	public function getCodigo($normalize = false)
199		{
200	4	if (!$normalize) {
201	4	return $this->codigo;
202		}
203		return $this->codigo;
204		}
205
206		/**
207		* Altera o valor do Codigo para o informado no parâmetro
208		* @param mixed $codigo novo valor para Codigo
209		* @param string $codigo Novo codigo para Protocolo
210		* @return self A própria instância da classe
211		*/
212	9	public function setCodigo($codigo)
213		{
214	9	$this->codigo = $codigo;
215	9	return $this;
216		}
217
218		/**
219		* Converte a instância da classe para um array de campos com valores
220		* @return array Array contendo todos os campos e valores da instância
221		*/
222	3	public function toArray($recursive = false)
223		{
224	3	$protocolo = parent::toArray($recursive);
225	3	$protocolo['chave'] = $this->getChave();
226	3	$protocolo['validacao'] = $this->getValidacao();
227	3	$protocolo['numero'] = $this->getNumero();
228	3	$protocolo['mensagem'] = $this->getMensagem();
229	3	$protocolo['codigo'] = $this->getCodigo();
230	3	return $protocolo;
231		}
232
233		/**
234		* Atribui os valores do array para a instância atual
235		* @param mixed $protocolo Array ou instância de Protocolo, para copiar os valores
236		* @return self A própria instância da classe
237		*/
238	9	public function fromArray($protocolo = [])
239		{
240	9	if ($protocolo instanceof Protocolo) {
241	2	$protocolo = $protocolo->toArray();
242	9	} elseif (!is_array($protocolo)) {
243	2	return $this;
244		}
245	9	parent::fromArray($protocolo);
246	9	if (!isset($protocolo['chave'])) {
247	9	$this->setChave(null);
248		} else {
249	2	$this->setChave($protocolo['chave']);
250		}
251	9	if (!array_key_exists('validacao', $protocolo)) {
252	9	$this->setValidacao(null);
253		} else {
254	2	$this->setValidacao($protocolo['validacao']);
255		}
256	9	if (!array_key_exists('numero', $protocolo)) {
257	9	$this->setNumero(null);
258		} else {
259	2	$this->setNumero($protocolo['numero']);
260		}
261	9	if (!array_key_exists('mensagem', $protocolo)) {
262	9	$this->setMensagem(null);
263		} else {
264	2	$this->setMensagem($protocolo['mensagem']);
265		}
266	9	if (!array_key_exists('codigo', $protocolo)) {
267	9	$this->setCodigo(null);
268		} else {
269	2	$this->setCodigo($protocolo['codigo']);
270		}
271	9	return $this;
272		}
273
274		/**
275		* Carrega as informações do nó e preenche a instância da classe
276		* @param DOMElement $element Nó do xml com todos as tags dos campos
277		* @param string $name Nome do nó que será carregado
278		* @return DOMElement Instância do nó que foi carregado
279		*/
280	9	public function loadNode($element, $name = null)
281		{
282	9	$name = is_null($name) ? 'infProt' : $name;
283	9	$element = parent::loadNode($element, $name);
284	9	$this->setChave(
285	9	Util::loadNode(
286	9	$element,
287	9	'chNFe',
288	9	'Tag "chNFe" não encontrada no Protocolo'
289		)
290		);
291	9	$this->setValidacao(Util::loadNode($element, 'digVal'));
292	9	$this->setNumero(Util::loadNode($element, 'nProt'));
293	9	$this->setMensagem(Util::loadNode($element, 'xMsg'));
294	9	$this->setCodigo(Util::loadNode($element, 'cMsg'));
295	9	return $element;
296		}
297
298		/**
299		* Cria um nó XML do protocolo de acordo com o leiaute da NFe
300		* @param string $name Nome do nó que será criado
301		* @return DOMElement Nó que contém todos os campos da classe
302		*/
303	3	public function getNode($name = null)
304		{
305	3	$old_uf = $this->getUF();
306	3	$this->setUF(null);
307	3	$info = parent::getNode('infProt');
308	3	$this->setUF($old_uf);
309	3	$dom = $info->ownerDocument;
310	3	$element = $dom->createElement(is_null($name) ? 'protNFe' : $name);
311	3	$versao = $dom->createAttribute('versao');
312	3	$versao->value = Nota::VERSAO;
313	3	$element->appendChild($versao);
314
315	3	$id = $dom->createAttribute('Id');
316	3	$id->value = 'ID' . $this->getNumero(true);
317	3	$info->appendChild($id);
318
319	3	$status = $info->getElementsByTagName('cStat')->item(0);
320	3	Util::appendNode($info, 'nProt', $this->getNumero(true), $status);
321	3	Util::appendNode($info, 'digVal', $this->getValidacao(true), $status);
322	3	$nodes = $info->getElementsByTagName('dhRecbto');
323	3	if ($nodes->length > 0) {
324	3	$recebimento = $nodes->item(0);
325		} else {
326		$recebimento = $status;
327		}
328	3	Util::appendNode($info, 'chNFe', $this->getChave(true), $recebimento);
329	3	if (!is_null($this->getCodigo())) {
330		Util::appendNode($info, 'cMsg', $this->getCodigo(true));
331		}
332	3	if (!is_null($this->getMensagem())) {
333		Util::appendNode($info, 'xMsg', $this->getMensagem(true));
334		}
335	3	$element->appendChild($info);
336	3	return $element;
337		}
338		}
339

mazinsw / nfe-api

Push — master ( 4c1910...711493 )

Protocolo::setMensagem() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like