Base::buildMsgH() - Code Metrics - nfephp-org/sped-esfinge - Measure and Improve Code Quality continuously with Scrutinizer

Base::buildMsgH() A
last analyzed 2020-05-19 15:10 UTC

↳ Parent: Base

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

Metric	Value
dl	0
loc	14
ccs	0
cts	12
cp	0
rs	9.7998
c	0
b	0
f	0
cc	2
nc	2
nop	2
crap	6

<?php

namespace NFePHP\Esfinge;

use InvalidArgumentException;
use NFePHP\Esfinge\Soap\CurlSoap;
use NFePHP\Esfinge\Files\FileFolders;

class Base
{
    
    protected $errors;
    /**
     * tpAmb
     * @var int
     */
    protected $tpAmb = 2;
    /**
     * ambiente
     * @var string
     */
    protected $ambiente = 'homologacao';
    /**
     * Diretorio para gravar arquivos de LOG
     * @var string
     */
    protected $pathFiles = '';
    /**
     * aConfig
     * @var array
     */
    protected $aConfig = array();
    /**
     * aProxy
     * @var array
     */
    protected $aProxy = array();
    /**
     * soapTimeout
     * @var int
     */
    protected $soapTimeout = 10;
    /**
     * oSoap
     * @var Object Class
     */
    protected $oSoap;
    /**
     * soapDebug
     * @var string
     */
    protected $soapDebug = '';
        /**
     * Header da mensagem SOAP
     * @var string
     */
    protected $header;
    /**
     * Nome do usuário do sistema
     * @var string
     */
    protected $username;
    /**
     * Password do usuário do sistema
     * @var string
     */
    protected $password;
    /**
     * Código da Unidade Gestora conforme informado pelo serviço listar
     * da tabela unidades gestoras
     * @var string
     */
    protected $codigoUnidadeGestora;
    
    /**
     * Contrutor
     * @param string $configJson
     */
    public function __construct($configJson = '', $debug = false)
    {
        if (empty($configJson)) {
            throw new InvalidArgumentException('A configuração deve ser passada.');
        }
        $config = $configJson;
        if (is_file($configJson)) {
            $config = file_get_contents($configJson);
        }
        $this->aConfig = json_decode($config, true);

        $this->username = $this->aConfig['username'];
        $this->password = $this->aConfig['password'];
        $this->codigoUnidadeGestora = $this->aConfig['codigoUnidadeGestora'];
        $this->aProxy = $this->aConfig['aProxyConf'];
        $this->setAmbiente($this->aConfig['tpAmb']);
        $this->pathFiles = $this->aConfig['pathFiles'];
        $this->loadSoapClass($debug);
        $this->buildSoapHeader();
    }
    
    /**
     * Seta o ambiente de trabalho
     * 1 - Produção
     * 2 - Homologação
     * @param int $tpAmb
     */
    public function setAmbiente($tpAmb = 2)
    {
        if ($tpAmb == 1) {
            $this->tpAmb = 1;
            $this->ambiente = 'producao';
        } else {
            $this->tpAmb = 2;
            $this->ambiente = 'homologacao';
            //sobrescreve a senha que é diferente no ambiente de teste
            $this->password = '123456';
        }
    }
    
    /**
     * Retorna o tpAmb
     * @return int
     */
    public function getAmbiente()
    {
        return $this->tpAmb;
    }
    
    /**
     * setSoapTimeOut
     * Seta um valor para timeout
     *
     * @param integer $segundos
     */
    public function setSoapTimeOut($segundos = 10)
    {
        if (! empty($segundos) && is_numeric($segundos)) {
            $this->soapTimeout = $segundos;
class Id
{
    public $id;

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

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
            $this->loadSoapClass();
        }
    }
    
    /**
     * getSoapTimeOut
     * Retorna o valor de timeout defido
     *
     * @return integer
     */
    public function getSoapTimeOut()
    {
        return $this->soapTimeout;
    }
    
    /**
     * Monta as tags com base na chave e no valor do array
     * @param array $data
     * @return string
     */
    protected function addTag($data)
    {
        $ret = '';
        foreach ($data as $key => $value) {
            if (! empty($value)) {
                $ret .= "<$key>$value</$key>";
            }
        }
        return $ret;
    }
    
    /**
     * Monta o conjunto de Body na função enviar
     * @param string $key
     * @param array $data
     * @return string
     */
    protected function buildEnviarB($key, $data)
    {
        if (count($data) > 5000) {
            throw new InvalidArgumentException('O limite de 5000 dados foi ultrapassado.');
        }
        $msg = "";
        foreach ($data as $field) {
            $msg .= "<$key>";
            $msg .= $this->addTag($field);
            $msg .= "</$key>";
        }
        $msg .= '</svc:enviar>';
        return $msg;
    }
    
    /**
     * Monta o conjunto Body da função Listar
     * @param string $pagina
     * @param array $filtros
     * @return string
     */
    protected function buildListarB($pagina = '', $filtros = [])
    {
        $msg = '<PAGINA>'.$pagina.'</PAGINA>';
        if (! empty($filtros)) {
            foreach ($filtros as $filtro) {
                $f = '<filtros>';
                $f .= $this->addTag($filtro);
                $f .= '</filtros>';
                $msg .= $f;
            };
        }
        $msg .= '</svc:listar>';
        return $msg;
    }
    
    /**
     * Monta a primeira parte de todas mensagens
     * @param string $namespace
     * @return string
     */
    protected function buildMsgH($tipo, $namespace)

    {
        $key = 'svc:enviar';
        $codug = '';
        if ($tipo == 'L') {
            $key = 'svc:listar';
            $codug = "<codigoUg>$this->codigoUnidadeGestora</codigoUg>";
        }
        $msg = "<$key>";
        $msg .= $codug;
        $msg .= "<chaveToken>$this->tokenid</chaveToken>";
class MyClass { }

$x = new MyClass();
$x->foo = true;
        $msg .= "<competencia>$this->competencia</competencia>";
class MyClass { }

$x = new MyClass();
$x->foo = true;
        return $msg;
    }
    
    /**
     * Monta o corpo de todas as mensagens
     * @param string $tipo
     * @param array $data
     * @param string $key
     * @return string
     */
    protected function buildMsgB($tipo, $data, $key = '')
    {
        if ($tipo == 'L') {
            //numerico pagina
            $pagina = $data['pagina'];
            //array filtros []['','','','']
            $filtros = $data['filtros'];
            $msg = $this->buildListarB($pagina, $filtros);
        } elseif ($tipo == 'E') {
            $msg = $this->buildEnviarB($key, $data);
        }
        return $msg;
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
    }

    /**
     * Constroi o header da mensagem SOAP
     */
    protected function buildSoapHeader()
    {
        $this->header = "<wsse:Security "
            . "xmlns:wsse=\"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd\">"
            . "<wsse:UsernameToken "
            . "xmlns:wsu=\"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd\">"
            . "<wsse:Username>"
            . $this->username
            . "</wsse:Username><wsse:Password "
            . "Type=\"http://docs.oasis-open.org/wss/2004/01/"
            . "oasis-200401-wss-username-token-profile-1.0#PasswordText\">"
            . $this->password
            . "</wsse:Password>"
            . "</wsse:UsernameToken>"
            . "</wsse:Security>";
    }
    
    /**
     * Envia a mensagem para o webservice
     * @param string $uri
     * @param string $namespace
     * @param array $data
     * @param string $method
     * @param string $met
     * @param string $retorno usado apenas para unit testes onde não desejamos acessar o SOAP
     * @return string
     */
    protected function envia($uri, $namespace, $data, $method, $met, $retorno = '')
    {
        if ($namespace !== 'http://token.ws.tce.sc.gov.br/') {
            //constroi a mensagem
            $body = $this->buildMsgH($method, $namespace);
            $body .= $this->buildMsgB($method, $data, substr($met, 0, strlen($met)-1));
        } else {
            $body = $data;
        }
        if (empty($retorno)) {
            //envia pelo curl
            $retorno = $this->oSoap->send($uri, $namespace, $this->header, $body, $met);
        }
        //processa o retorno
        if ($method == 'L') {
            $tag = 'listar';
        } elseif ($method == 'E') {
            $tag = 'enviar';
        } else {
            $tag = $met;
        }
        $resp = Response::readReturn($tag, $retorno);
        return $resp;
    }
    
    /**
     * Carrega a classe SOAP e os certificados
     */
    protected function loadSoapClass($debug = false)
    {
        $pathlog = $this->pathFiles.DIRECTORY_SEPARATOR.$this->ambiente;
        $this->oSoap = null;
        $soap = new CurlSoap(
            $pathlog,
            $this->soapTimeout,
            $this->aProxy,
            $debug
        );
        $this->oSoap = $soap;
    }
}


1		<?php
2
3		namespace NFePHP\Esfinge;
4
5		use InvalidArgumentException;
6		use NFePHP\Esfinge\Soap\CurlSoap;
7		use NFePHP\Esfinge\Files\FileFolders;
8
9		class Base
10		{
11
12		protected $errors;
13		/**
14		* tpAmb
15		* @var int
16		*/
17		protected $tpAmb = 2;
18		/**
19		* ambiente
20		* @var string
21		*/
22		protected $ambiente = 'homologacao';
23		/**
24		* Diretorio para gravar arquivos de LOG
25		* @var string
26		*/
27		protected $pathFiles = '';
28		/**
29		* aConfig
30		* @var array
31		*/
32		protected $aConfig = array();
33		/**
34		* aProxy
35		* @var array
36		*/
37		protected $aProxy = array();
38		/**
39		* soapTimeout
40		* @var int
41		*/
42		protected $soapTimeout = 10;
43		/**
44		* oSoap
45		* @var Object Class
46		*/
47		protected $oSoap;
48		/**
49		* soapDebug
50		* @var string
51		*/
52		protected $soapDebug = '';
53		/**
54		* Header da mensagem SOAP
55		* @var string
56		*/
57		protected $header;
58		/**
59		* Nome do usuário do sistema
60		* @var string
61		*/
62		protected $username;
63		/**
64		* Password do usuário do sistema
65		* @var string
66		*/
67		protected $password;
68		/**
69		* Código da Unidade Gestora conforme informado pelo serviço listar
70		* da tabela unidades gestoras
71		* @var string
72		*/
73		protected $codigoUnidadeGestora;
74
75		/**
76		* Contrutor
77		* @param string $configJson
78		*/
79	6	public function __construct($configJson = '', $debug = false)
80		{
81	6	if (empty($configJson)) {
82	3	throw new InvalidArgumentException('A configuração deve ser passada.');
83		}
84	3	$config = $configJson;
85	3	if (is_file($configJson)) {
86		$config = file_get_contents($configJson);
87		}
88	3	$this->aConfig = json_decode($config, true);
		0 ignored issues – show Documentation Bug introduced 2016-07-08 19:40 UTC by Report Bug Copy Issue Report It seems like `json_decode($config, true)` of type `*` is incompatible with the declared type `array` of property `$aConfig`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
89	3	$this->username = $this->aConfig['username'];
90	3	$this->password = $this->aConfig['password'];
91	3	$this->codigoUnidadeGestora = $this->aConfig['codigoUnidadeGestora'];
92	3	$this->aProxy = $this->aConfig['aProxyConf'];
93	3	$this->setAmbiente($this->aConfig['tpAmb']);
94	3	$this->pathFiles = $this->aConfig['pathFiles'];
95	3	$this->loadSoapClass($debug);
96	3	$this->buildSoapHeader();
97	3	}
98
99		/**
100		* Seta o ambiente de trabalho
101		* 1 - Produção
102		* 2 - Homologação
103		* @param int $tpAmb
104		*/
105	6	public function setAmbiente($tpAmb = 2)
106		{
107	6	if ($tpAmb == 1) {
108	3	$this->tpAmb = 1;
109	3	$this->ambiente = 'producao';
110	2	} else {
111	6	$this->tpAmb = 2;
112	6	$this->ambiente = 'homologacao';
113		//sobrescreve a senha que é diferente no ambiente de teste
114	6	$this->password = '123456';
115		}
116	6	}
117
118		/**
119		* Retorna o tpAmb
120		* @return int
121		*/
122	9	public function getAmbiente()
123		{
124	9	return $this->tpAmb;
125		}
126
127		/**
128		* setSoapTimeOut
129		* Seta um valor para timeout
130		*
131		* @param integer $segundos
132		*/
133	6	public function setSoapTimeOut($segundos = 10)
134		{
135	6	if (! empty($segundos) && is_numeric($segundos)) {
136	3	$this->soapTimeout = $segundos;
		0 ignored issues – show Documentation Bug introduced 2016-07-11 21:05 UTC by Report Bug Copy Issue Report It seems like `$segundos` can also be of type `double` or `string`. However, the property `$soapTimeout` is declared as type `integer`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
137	3	$this->loadSoapClass();
138	2	}
139	6	}
140
141		/**
142		* getSoapTimeOut
143		* Retorna o valor de timeout defido
144		*
145		* @return integer
146		*/
147	6	public function getSoapTimeOut()
148		{
149	6	return $this->soapTimeout;
150		}
151
152		/**
153		* Monta as tags com base na chave e no valor do array
154		* @param array $data
155		* @return string
156		*/
157		protected function addTag($data)
158		{
159		$ret = '';
160		foreach ($data as $key => $value) {
161		if (! empty($value)) {
162		$ret .= "<$key>$value</$key>";
163		}
164		}
165		return $ret;
166		}
167
168		/**
169		* Monta o conjunto de Body na função enviar
170		* @param string $key
171		* @param array $data
172		* @return string
173		*/
174		protected function buildEnviarB($key, $data)
175		{
176		if (count($data) > 5000) {
177		throw new InvalidArgumentException('O limite de 5000 dados foi ultrapassado.');
178		}
179		$msg = "";
180		foreach ($data as $field) {
181		$msg .= "<$key>";
182		$msg .= $this->addTag($field);
183		$msg .= "</$key>";
184		}
185		$msg .= '</svc:enviar>';
186		return $msg;
187		}
188
189		/**
190		* Monta o conjunto Body da função Listar
191		* @param string $pagina
192		* @param array $filtros
193		* @return string
194		*/
195		protected function buildListarB($pagina = '', $filtros = [])
196		{
197		$msg = '<PAGINA>'.$pagina.'</PAGINA>';
198		if (! empty($filtros)) {
199		foreach ($filtros as $filtro) {
200		$f = '<filtros>';
201		$f .= $this->addTag($filtro);
202		$f .= '</filtros>';
203		$msg .= $f;
204		};
205		}
206		$msg .= '</svc:listar>';
207		return $msg;
208		}
209
210		/**
211		* Monta a primeira parte de todas mensagens
212		* @param string $namespace
213		* @return string
214		*/
215		protected function buildMsgH($tipo, $namespace)
		0 ignored issues – show Unused Code introduced 2018-02-02 19:42 UTC by Report Bug Copy Issue Report The parameter `$namespace` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
216		{
217		$key = 'svc:enviar';
218		$codug = '';
219		if ($tipo == 'L') {
220		$key = 'svc:listar';
221		$codug = "<codigoUg>$this->codigoUnidadeGestora</codigoUg>";
222		}
223		$msg = "<$key>";
224		$msg .= $codug;
225		$msg .= "<chaveToken>$this->tokenid</chaveToken>";
		0 ignored issues – show Bug introduced 2016-07-10 20:25 UTC by Report Bug Copy Issue Report The property `tokenid` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
226		$msg .= "<competencia>$this->competencia</competencia>";
		0 ignored issues – show Bug introduced 2016-07-08 19:40 UTC by Report Bug Copy Issue Report The property `competencia` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
227		return $msg;
228		}
229
230		/**
231		* Monta o corpo de todas as mensagens
232		* @param string $tipo
233		* @param array $data
234		* @param string $key
235		* @return string
236		*/
237		protected function buildMsgB($tipo, $data, $key = '')
238		{
239		if ($tipo == 'L') {
240		//numerico pagina
241		$pagina = $data['pagina'];
242		//array filtros []['','','','']
243		$filtros = $data['filtros'];
244		$msg = $this->buildListarB($pagina, $filtros);
245		} elseif ($tipo == 'E') {
246		$msg = $this->buildEnviarB($key, $data);
247		}
248		return $msg;
		0 ignored issues – show Bug introduced 2016-07-08 19:40 UTC by Report Bug Copy Issue Report The variable `$msg` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
249		}
250
251		/**
252		* Constroi o header da mensagem SOAP
253		*/
254	3	protected function buildSoapHeader()
255		{
256	3	$this->header = "<wsse:Security "
257		. "xmlns:wsse=\"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd\">"
258	2	. "<wsse:UsernameToken "
259	2	. "xmlns:wsu=\"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd\">"
260	2	. "<wsse:Username>"
261	3	. $this->username
262	3	. "</wsse:Username><wsse:Password "
263	3	. "Type=\"http://docs.oasis-open.org/wss/2004/01/"
264	3	. "oasis-200401-wss-username-token-profile-1.0#PasswordText\">"
265	3	. $this->password
266	3	. "</wsse:Password>"
267	3	. "</wsse:UsernameToken>"
268	3	. "</wsse:Security>";
269	3	}
270
271		/**
272		* Envia a mensagem para o webservice
273		* @param string $uri
274		* @param string $namespace
275		* @param array $data
276		* @param string $method
277		* @param string $met
278		* @param string $retorno usado apenas para unit testes onde não desejamos acessar o SOAP
279		* @return string
280		*/
281		protected function envia($uri, $namespace, $data, $method, $met, $retorno = '')
282		{
283		if ($namespace !== 'http://token.ws.tce.sc.gov.br/') {
284		//constroi a mensagem
285		$body = $this->buildMsgH($method, $namespace);
286		$body .= $this->buildMsgB($method, $data, substr($met, 0, strlen($met)-1));
287		} else {
288		$body = $data;
289		}
290		if (empty($retorno)) {
291		//envia pelo curl
292		$retorno = $this->oSoap->send($uri, $namespace, $this->header, $body, $met);
293		}
294		//processa o retorno
295		if ($method == 'L') {
296		$tag = 'listar';
297		} elseif ($method == 'E') {
298		$tag = 'enviar';
299		} else {
300		$tag = $met;
301		}
302		$resp = Response::readReturn($tag, $retorno);
303		return $resp;
304		}
305
306		/**
307		* Carrega a classe SOAP e os certificados
308		*/
309	9	protected function loadSoapClass($debug = false)
310		{
311	9	$pathlog = $this->pathFiles.DIRECTORY_SEPARATOR.$this->ambiente;
312	9	$this->oSoap = null;
313	9	$soap = new CurlSoap(
314	9	$pathlog,
315	9	$this->soapTimeout,
316	9	$this->aProxy,
317	3	$debug
318	6	);
319	9	$this->oSoap = $soap;
320	9	}
321		}
322

nfephp-org / sped-esfinge

Base::buildMsgH() A last analyzed 2020-05-19 15:10 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like

Base::buildMsgH() A
last analyzed 2020-05-19 15:10 UTC