Tarefa::setID() - Code Metrics - Inspection of "Corrigido compatibilidade do regex" - mazinsw/nfe-api - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 43458c...ac6f10 )

by Francimar

created 2018-06-11 23:39 UTC

Tarefa::setID() A

↳ Parent: Tarefa

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

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	9.4285
c	0
b	0
f	0
cc	1
eloc	3
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;

class Tarefa

{

    /**
     * Ação a ser realizada sobre o objeto ou recibo
     */
    const ACAO_CONSULTAR = 'consultar';
    const ACAO_INUTILIZAR = 'inutilizar';
    const ACAO_CANCELAR = 'cancelar';

    private $id;
    private $acao;
    private $nota;
    private $documento;
    private $agente;
    private $resposta;

    public function __construct($tarefa = [])
    {
        $this->fromArray($tarefa);
    }

    /**
     * Código aleatório e opcional que identifica a tarefa
     */
    public function getID()
    {
        return $this->id;
    }

    public function setID($id)
    {
        $this->id = $id;
        return $this;
    }

    /**
     * Ação a ser realizada sobre o objeto ou recibo
     */
    public function getAcao()
    {
        return $this->acao;
    }

    public function setAcao($acao)
    {
        $this->acao = $acao;
        return $this;
    }

    /**
     * Nota que será processada se informado
     */
    public function getNota()
    {
        return $this->nota;
    }

    public function setNota($nota)
    {
        $this->nota = $nota;
        return $this;
    }

    /**
     * Informa o XML do objeto, quando não informado o XML é gerado a partir do
     * objeto
     */
    public function getDocumento()
    {
        return $this->documento;
    }

    public function setDocumento($documento)
    {
        $this->documento = $documento;
        return $this;
    }

    /**
     * Agente que obteve ou vai obter a resposta, podendo ser: pedido de
     * inutilização(NF\Inutilizacao), recibo(NF\Recibo) ou pedido de
     * cancelamento(NF\Evento)
     */
    public function getAgente()
    {
        return $this->agente;
    }

    public function setAgente($agente)
    {
        $this->agente = $agente;
        return $this;
    }

    /**
     * Resposta da tarefa após ser executada
     */
    public function getResposta()
    {
        return $this->resposta;
    }

    public function setResposta($resposta)
    {
        $this->resposta = $resposta;
        return $this;
    }

    public function toArray($recursive = false)
    {
        $tarefa = [];
        $tarefa['id'] = $this->getID();
        $tarefa['acao'] = $this->getAcao();
        if (!is_null($this->getNota()) && $recursive) {
            $tarefa['nota'] = $this->getNota()->toArray($recursive);
        } else {
            $tarefa['nota'] = $this->getNota();
        }
        if (!is_null($this->getDocumento()) && $recursive) {
            $tarefa['documento'] = $this->getDocumento()->saveXML();
        } else {
            $tarefa['documento'] = $this->getDocumento();
        }
        if (!is_null($this->getAgente()) && $recursive) {
            $tarefa['agente'] = $this->getAgente()->toArray($recursive);
        } else {
            $tarefa['agente'] = $this->getAgente();
        }
        if (!is_null($this->getResposta()) && $recursive) {
            $tarefa['resposta'] = $this->getResposta()->toArray($recursive);
        } else {
            $tarefa['resposta'] = $this->getResposta();
        }
        return $tarefa;
    }

    public function fromArray($tarefa = [])
    {
        if ($tarefa instanceof Tarefa) {
            $tarefa = $tarefa->toArray();
        } elseif (!is_array($tarefa)) {
            return $this;
        }
        if (isset($tarefa['id'])) {
            $this->setID($tarefa['id']);
        } else {
            $this->setID(null);
        }
        if (isset($tarefa['acao'])) {
            $this->setAcao($tarefa['acao']);
        } else {
            $this->setAcao(null);
        }
        if (isset($tarefa['nota'])) {
            $this->setNota($tarefa['nota']);
        } else {
            $this->setNota(null);
        }
        if (isset($tarefa['documento'])) {
            $this->setDocumento($tarefa['documento']);
        } else {
            $this->setDocumento(null);
        }
        if (isset($tarefa['agente'])) {
            $this->setAgente($tarefa['agente']);
        } else {
            $this->setAgente(null);
        }
        if (isset($tarefa['resposta'])) {
            $this->setResposta($tarefa['resposta']);
        } else {
            $this->setResposta(null);
        }
        return $this;
    }

    /**
     * Resposta da tarefa após ser executada
     */
    public function executa()
    {
        if (is_null($this->getID())) {
            $this->setID(Status::genLote());
        }
        $retorno = null;
        switch ($this->getAcao()) {
            case self::ACAO_CANCELAR:
                $retorno = $this->cancela();
                break;
            case self::ACAO_INUTILIZAR:
                $retorno = $this->inutiliza();
                break;
            case self::ACAO_CONSULTAR:
                $retorno = $this->consulta();
                break;
        }
        $this->setResposta($retorno);
        return $this->getResposta();
    }

    private function cancela()
    {
        $nota = $this->getNota();
        $evento = $this->getAgente();
        if (is_null($evento)) {
            if (is_null($nota)) {
                throw new \Exception('A nota não foi informada na tarefa de cancelamento "'.$this->getID().'"', 404);
            }
            if (is_null($nota->getProtocolo())) {
                throw new \Exception('A nota não possui protocolo de autorização para o cancelamento "'.
                    $this->getID().'"', 404);
            }
            $evento = new Evento();
            $evento->setData(time());
            $evento->setOrgao($nota->getEmitente()->getEndereco()->
                getMunicipio()->getEstado()->getUF());
            $evento->setJustificativa($nota->getJustificativa());
            $this->setAgente($evento);
        } elseif (!($evento instanceof Evento)) {
            throw new \Exception('O agente informado não é um evento', 500);
        }
        if (!is_null($nota)) {
            $evento->setAmbiente($nota->getAmbiente());
            $evento->setModelo($nota->getModelo());
            $evento->setIdentificador($nota->getEmitente()->getCNPJ());
            if (!is_null($nota->getProtocolo())) {
                $evento->setNumero($nota->getProtocolo()->getNumero());
            }
            $evento->setChave($nota->getID());
        }
        $dom = $evento->getNode()->ownerDocument;
        $dom = $evento->assinar($dom);
        $retorno = $evento->envia($dom);
        if ($retorno->isCancelado()) {
            $dom = $evento->addInformacao($dom);
            $this->setDocumento($dom);
        }
        return $retorno;
    }
    
    private function inutiliza()
    {
        $nota = $this->getNota();
        $inutilizacao = $this->getAgente();
        if (is_null($inutilizacao)) {
            if (is_null($nota)) {
                throw new \Exception('A nota não foi informada na tarefa de inutilização "'.$this->getID().'"', 404);
            }
            $inutilizacao = new Inutilizacao();
            $inutilizacao->setAno(date('Y'));
            $inutilizacao->setJustificativa($nota->getJustificativa());
            $this->setAgente($inutilizacao);
        } elseif (!($inutilizacao instanceof Inutilizacao)) {
            throw new \Exception('O agente informado não é uma inutilização', 500);
        }
        if (!is_null($nota)) {
            $inutilizacao->setCNPJ($nota->getEmitente()->getCNPJ());
            $inutilizacao->setSerie($nota->getSerie());
            $inutilizacao->setInicio($nota->getNumero());
            $inutilizacao->setFinal($nota->getNumero());
            $inutilizacao->setUF($nota->getEmitente()->getEndereco()->
                getMunicipio()->getEstado()->getUF());
            $inutilizacao->setAmbiente($nota->getAmbiente());
            $inutilizacao->setModelo($nota->getModelo());
        }
        $dom = $inutilizacao->getNode()->ownerDocument;
        $dom = $inutilizacao->assinar($dom);
        $dom = $inutilizacao->envia($dom);
        $this->setDocumento($dom);
        return $inutilizacao;
    }
    
    private function consulta()
    {
        $nota = $this->getNota();
        $agente = $this->getAgente();
        if (is_null($agente)) {
            if (is_null($nota)) {
                throw new \Exception('A nota não foi informada na tarefa de consulta "'.$this->getID().'"', 404);
            }
            $agente = new Situacao();
            $agente->setChave($nota->getID());
            $this->setAgente($agente);
        } elseif (!($agente instanceof Situacao) && !($agente instanceof Recibo)) {
            throw new \Exception('O agente informado não é uma consulta de situação e nem um recibo', 500);
        }
        if (!is_null($nota)) {
            $agente->setAmbiente($nota->getAmbiente());
            $agente->setModelo($nota->getModelo());
        }
        $retorno = $agente->consulta($this->getNota());
        if ($agente->isCancelado()) {
            // TODO: carregar assinatura do XML para evitar usar outro certificado
            $dom = $retorno->assinar();
            $dom = $retorno->validar($dom);
            // $dom = $retorno->getNode()->ownerDocument; // descomentar essa linha quando implementar
            // TODO: Fim do problema de assinatura
            $dom = $retorno->addInformacao($dom);
            $this->setDocumento($dom);
            $retorno = $retorno->getInformacao();
        }
        return $retorno;
    }
}


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		class Tarefa
		0 ignored issues – show Complexity introduced 2017-03-10 10:50 UTC by Report Bug Copy Issue Report This class has a complexity of 56 which exceeds the configured maximum of 50. The class complexity is the sum of the complexity of all methods. A very high value is usually an indication that your class does not follow the single reponsibility principle and does more than one job. Some resources for further reading: Single Reponsibility Principle Open/Closed Principle You can also find more detailed suggestions for refactoring in the “Code” section of your repository. Loading history...
31		{
32
33		/**
34		* Ação a ser realizada sobre o objeto ou recibo
35		*/
36		const ACAO_CONSULTAR = 'consultar';
37		const ACAO_INUTILIZAR = 'inutilizar';
38		const ACAO_CANCELAR = 'cancelar';
39
40		private $id;
41		private $acao;
42		private $nota;
43		private $documento;
44		private $agente;
45		private $resposta;
46
47	15	public function __construct($tarefa = [])
48		{
49	15	$this->fromArray($tarefa);
50	15	}
51
52		/**
53		* Código aleatório e opcional que identifica a tarefa
54		*/
55	14	public function getID()
56		{
57	14	return $this->id;
58		}
59
60	15	public function setID($id)
61		{
62	15	$this->id = $id;
63	15	return $this;
64		}
65
66		/**
67		* Ação a ser realizada sobre o objeto ou recibo
68		*/
69	14	public function getAcao()
70		{
71	14	return $this->acao;
72		}
73
74	15	public function setAcao($acao)
75		{
76	15	$this->acao = $acao;
77	15	return $this;
78		}
79
80		/**
81		* Nota que será processada se informado
82		*/
83	14	public function getNota()
84		{
85	14	return $this->nota;
86		}
87
88	15	public function setNota($nota)
89		{
90	15	$this->nota = $nota;
91	15	return $this;
92		}
93
94		/**
95		* Informa o XML do objeto, quando não informado o XML é gerado a partir do
96		* objeto
97		*/
98	6	public function getDocumento()
99		{
100	6	return $this->documento;
101		}
102
103	15	public function setDocumento($documento)
104		{
105	15	$this->documento = $documento;
106	15	return $this;
107		}
108
109		/**
110		* Agente que obteve ou vai obter a resposta, podendo ser: pedido de
111		* inutilização(NF\Inutilizacao), recibo(NF\Recibo) ou pedido de
112		* cancelamento(NF\Evento)
113		*/
114	14	public function getAgente()
115		{
116	14	return $this->agente;
117		}
118
119	15	public function setAgente($agente)
120		{
121	15	$this->agente = $agente;
122	15	return $this;
123		}
124
125		/**
126		* Resposta da tarefa após ser executada
127		*/
128	6	public function getResposta()
129		{
130	6	return $this->resposta;
131		}
132
133	15	public function setResposta($resposta)
134		{
135	15	$this->resposta = $resposta;
136	15	return $this;
137		}
138
139	2	public function toArray($recursive = false)
140		{
141	2	$tarefa = [];
142	2	$tarefa['id'] = $this->getID();
143	2	$tarefa['acao'] = $this->getAcao();
144	2	if (!is_null($this->getNota()) && $recursive) {
145	1	$tarefa['nota'] = $this->getNota()->toArray($recursive);
146		} else {
147	1	$tarefa['nota'] = $this->getNota();
148		}
149	2	if (!is_null($this->getDocumento()) && $recursive) {
150		$tarefa['documento'] = $this->getDocumento()->saveXML();
151		} else {
152	2	$tarefa['documento'] = $this->getDocumento();
153		}
154	2	if (!is_null($this->getAgente()) && $recursive) {
155	1	$tarefa['agente'] = $this->getAgente()->toArray($recursive);
156		} else {
157	1	$tarefa['agente'] = $this->getAgente();
158		}
159	2	if (!is_null($this->getResposta()) && $recursive) {
160	1	$tarefa['resposta'] = $this->getResposta()->toArray($recursive);
161		} else {
162	1	$tarefa['resposta'] = $this->getResposta();
163		}
164	2	return $tarefa;
165		}
166
167	15	public function fromArray($tarefa = [])
168		{
169	15	if ($tarefa instanceof Tarefa) {
170	1	$tarefa = $tarefa->toArray();
171	15	} elseif (!is_array($tarefa)) {
172	1	return $this;
173		}
174	15	if (isset($tarefa['id'])) {
175	1	$this->setID($tarefa['id']);
176		} else {
177	15	$this->setID(null);
178		}
179	15	if (isset($tarefa['acao'])) {
180	1	$this->setAcao($tarefa['acao']);
181		} else {
182	15	$this->setAcao(null);
183		}
184	15	if (isset($tarefa['nota'])) {
185	1	$this->setNota($tarefa['nota']);
186		} else {
187	15	$this->setNota(null);
188		}
189	15	if (isset($tarefa['documento'])) {
190	1	$this->setDocumento($tarefa['documento']);
191		} else {
192	15	$this->setDocumento(null);
193		}
194	15	if (isset($tarefa['agente'])) {
195	1	$this->setAgente($tarefa['agente']);
196		} else {
197	15	$this->setAgente(null);
198		}
199	15	if (isset($tarefa['resposta'])) {
200	1	$this->setResposta($tarefa['resposta']);
201		} else {
202	15	$this->setResposta(null);
203		}
204	15	return $this;
205		}
206
207		/**
208		* Resposta da tarefa após ser executada
209		*/
210	14	public function executa()
211		{
212	14	if (is_null($this->getID())) {
213	14	$this->setID(Status::genLote());
214		}
215	14	$retorno = null;
216	14	switch ($this->getAcao()) {
217	14	case self::ACAO_CANCELAR:
218	4	$retorno = $this->cancela();
219	1	break;
220	10	case self::ACAO_INUTILIZAR:
221	5	$retorno = $this->inutiliza();
222	2	break;
223	5	case self::ACAO_CONSULTAR:
224	5	$retorno = $this->consulta();
225	3	break;
226		}
227	6	$this->setResposta($retorno);
228	6	return $this->getResposta();
229		}
230
231	4	private function cancela()
232		{
233	4	$nota = $this->getNota();
234	4	$evento = $this->getAgente();
235	4	if (is_null($evento)) {
236	3	if (is_null($nota)) {
237	1	throw new \Exception('A nota não foi informada na tarefa de cancelamento "'.$this->getID().'"', 404);
238		}
239	2	if (is_null($nota->getProtocolo())) {
240	1	throw new \Exception('A nota não possui protocolo de autorização para o cancelamento "'.
241	1	$this->getID().'"', 404);
242		}
243	1	$evento = new Evento();
244	1	$evento->setData(time());
245	1	$evento->setOrgao($nota->getEmitente()->getEndereco()->
246	1	getMunicipio()->getEstado()->getUF());
247	1	$evento->setJustificativa($nota->getJustificativa());
248	1	$this->setAgente($evento);
249	1	} elseif (!($evento instanceof Evento)) {
250	1	throw new \Exception('O agente informado não é um evento', 500);
251		}
252	1	if (!is_null($nota)) {
253	1	$evento->setAmbiente($nota->getAmbiente());
254	1	$evento->setModelo($nota->getModelo());
255	1	$evento->setIdentificador($nota->getEmitente()->getCNPJ());
256	1	if (!is_null($nota->getProtocolo())) {
257	1	$evento->setNumero($nota->getProtocolo()->getNumero());
258		}
259	1	$evento->setChave($nota->getID());
260		}
261	1	$dom = $evento->getNode()->ownerDocument;
262	1	$dom = $evento->assinar($dom);
263	1	$retorno = $evento->envia($dom);
264	1	if ($retorno->isCancelado()) {
265	1	$dom = $evento->addInformacao($dom);
266	1	$this->setDocumento($dom);
267		}
268	1	return $retorno;
269		}
270
271	5	private function inutiliza()
272		{
273	5	$nota = $this->getNota();
274	5	$inutilizacao = $this->getAgente();
275	5	if (is_null($inutilizacao)) {
276	1	if (is_null($nota)) {
277	1	throw new \Exception('A nota não foi informada na tarefa de inutilização "'.$this->getID().'"', 404);
278		}
279		$inutilizacao = new Inutilizacao();
280		$inutilizacao->setAno(date('Y'));
281		$inutilizacao->setJustificativa($nota->getJustificativa());
282		$this->setAgente($inutilizacao);
283	4	} elseif (!($inutilizacao instanceof Inutilizacao)) {
284	1	throw new \Exception('O agente informado não é uma inutilização', 500);
285		}
286	3	if (!is_null($nota)) {
287	1	$inutilizacao->setCNPJ($nota->getEmitente()->getCNPJ());
288	1	$inutilizacao->setSerie($nota->getSerie());
289	1	$inutilizacao->setInicio($nota->getNumero());
290	1	$inutilizacao->setFinal($nota->getNumero());
291	1	$inutilizacao->setUF($nota->getEmitente()->getEndereco()->
292	1	getMunicipio()->getEstado()->getUF());
293	1	$inutilizacao->setAmbiente($nota->getAmbiente());
294	1	$inutilizacao->setModelo($nota->getModelo());
295		}
296	3	$dom = $inutilizacao->getNode()->ownerDocument;
297	2	$dom = $inutilizacao->assinar($dom);
298	2	$dom = $inutilizacao->envia($dom);
299	2	$this->setDocumento($dom);
300	2	return $inutilizacao;
301		}
302
303	5	private function consulta()
304		{
305	5	$nota = $this->getNota();
306	5	$agente = $this->getAgente();
307	5	if (is_null($agente)) {
308	3	if (is_null($nota)) {
309	1	throw new \Exception('A nota não foi informada na tarefa de consulta "'.$this->getID().'"', 404);
310		}
311	2	$agente = new Situacao();
312	2	$agente->setChave($nota->getID());
313	2	$this->setAgente($agente);
314	2	} elseif (!($agente instanceof Situacao) && !($agente instanceof Recibo)) {
315	1	throw new \Exception('O agente informado não é uma consulta de situação e nem um recibo', 500);
316		}
317	3	if (!is_null($nota)) {
318	3	$agente->setAmbiente($nota->getAmbiente());
319	3	$agente->setModelo($nota->getModelo());
320		}
321	3	$retorno = $agente->consulta($this->getNota());
322	3	if ($agente->isCancelado()) {
323		// TODO: carregar assinatura do XML para evitar usar outro certificado
324	1	$dom = $retorno->assinar();
325	1	$dom = $retorno->validar($dom);
326		// $dom = $retorno->getNode()->ownerDocument; // descomentar essa linha quando implementar
327		// TODO: Fim do problema de assinatura
328	1	$dom = $retorno->addInformacao($dom);
329	1	$this->setDocumento($dom);
330	1	$retorno = $retorno->getInformacao();
331		}
332	3	return $retorno;
333		}
334		}
335

mazinsw / nfe-api

Push — master ( 43458c...ac6f10 )

Tarefa::setID() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like