Base::getSoapTimeOut() - Code Metrics - Inspection of "Merge pull request #12 from robmachado/master" - nfephp-org/sped-esfinge - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( e55be9...5d6262 )

by Roberto

created 2016-07-11 13:37 UTC

Base::getSoapTimeOut() A

↳ Parent: Base

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	4
ccs	0
cts	2
cp	0
rs	10
cc	1
eloc	2
nc	1
nop	0
crap	2

<?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 = '')
    {
        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();
        $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';
        }
    }
    
    /**
     * setSoapTimeOut
     * Seta um valor para timeout
     *
     * @param integer $segundos
     */
    public function setSoapTimeOut($segundos = 10)
    {
        if (! empty($segundos)) {
            $this->soapTimeout = $segundos;
            $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 .= '</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>';
        foreach ($filtros as $filtro) {
            $f = '<filtros>';
            $f .= $this->addTag($filtro);
            $f .= '</filtros>';
            $msg .= $f;
        };
        $msg .= '</listar>';
        return $msg;
    }
    
    /**
     * Monta a primeira parte de todas mensagens
     * @param string $namespace
     * @return string
     */
    protected function buildMsgH($tipo, $namespace)
    {
        $key = 'enviar';
        $codug = '';
        if ($tipo == 'L') {
            $key = 'listar';
            $codug = "<codigoUg>$this->codigoUnidadeGestora</codigoUg>";
        }
        $msg = "<$key xmlns=\"$namespace\">";
        $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
     * @return string
     */
    protected function buildMsgB($tipo, $data)
    {
        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 $urlService
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @param strting $body
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @param string $method
     * @return string
     */
    protected function envia($uri, $namespace, $data, $method, $met)
    {
        //constroi a mensagem
        $body = $this->buildMsgH($method, $namespace);
        $body .= $this->buildMsgB($method, $data);
        //envia pelo curl
        $retorno = $this->oSoap->send($uri, $namespace, $this->header, $body, $method);
        //processa o retorno
        $resp = Response::readReturn($met, $retorno);
        //salvar os arquivos para LOG
        return $resp;
    }
    
    /**
     * Carrega a classe SOAP e os certificados
     */
    protected function loadSoapClass()
    {
        $pathlog = $this->pathFiles.DIRECTORY_SEPARATOR.$this->ambiente;
        $this->oSoap = null;
        $soap = new CurlSoap(
            $pathlog,    
            $this->soapTimeout,
            $this->aProxy
        );
        $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			public function __construct($configJson = '')
80			{
81			if (empty($configJson)) {
82			throw new InvalidArgumentException('A configuração deve ser passada.');
83			}
84			$config = $configJson;
85			if (is_file($configJson)) {
86			$config = file_get_contents($configJson);
87			}
88			$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
90			$this->username = $this->aConfig['username'];
91			$this->password = $this->aConfig['password'];
92			$this->codigoUnidadeGestora = $this->aConfig['codigoUnidadeGestora'];
93			$this->aProxy = $this->aConfig['aProxyConf'];
94			$this->setAmbiente($this->aConfig['tpAmb']);
95			$this->pathFiles = $this->aConfig['pathFiles'];
96			$this->loadSoapClass();
97			$this->buildSoapHeader();
98			}
99
100			/**
101			* Seta o ambiente de trabalho
102			* 1 - Produção
103			* 2 - Homologação
104			* @param int $tpAmb
105			*/
106			public function setAmbiente($tpAmb = 2)
107			{
108			if ($tpAmb == 1) {
109			$this->tpAmb = 1;
110			$this->ambiente = 'producao';
111			} else {
112			$this->tpAmb = 2;
113			$this->ambiente = 'homologacao';
114			//sobrescreve a senha que é diferente no ambiente de teste
115			$this->password = '123456';
116			}
117			}
118
119			/**
120			* setSoapTimeOut
121			* Seta um valor para timeout
122			*
123			* @param integer $segundos
124			*/
125			public function setSoapTimeOut($segundos = 10)
126			{
127			if (! empty($segundos)) {
128			$this->soapTimeout = $segundos;
129			$this->loadSoapClass();
130			}
131			}
132
133			/**
134			* getSoapTimeOut
135			* Retorna o valor de timeout defido
136			*
137			* @return integer
138			*/
139			public function getSoapTimeOut()
140			{
141			return $this->soapTimeout;
142			}
143
144			/**
145			* Monta as tags com base na chave e no valor do array
146			* @param array $data
147			* @return string
148			*/
149			protected function addTag($data)
150			{
151			$ret = '';
152			foreach ($data as $key => $value) {
153			if (! empty($value)) {
154			$ret .= "<$key>$value</$key>";
155			}
156			}
157			return $ret;
158			}
159
160			/**
161			* Monta o conjunto de Body na função enviar
162			* @param string $key
163			* @param array $data
164			* @return string
165			*/
166			protected function buildEnviarB($key, $data)
167			{
168			if (count($data) > 5000) {
169			throw new InvalidArgumentException('O limite de 5000 dados foi ultrapassado.');
170			}
171			$msg = '';
172			foreach ($data as $field) {
173			$msg .= "<$key>";
174			$msg .= $this->addTag($field);
175			$msg .= "</$key>";
176			}
177			$msg .= '</enviar>';
178			return $msg;
179			}
180
181			/**
182			* Monta o conjunto Body da função Listar
183			* @param string $pagina
184			* @param array $filtros
185			* @return string
186			*/
187			protected function buildListarB($pagina = '', $filtros = [])
188			{
189			$msg = '<PAGINA>'.$pagina.'</PAGINA>';
190			foreach ($filtros as $filtro) {
191			$f = '<filtros>';
192			$f .= $this->addTag($filtro);
193			$f .= '</filtros>';
194			$msg .= $f;
195			};
196			$msg .= '</listar>';
197			return $msg;
198			}
199
200			/**
201			* Monta a primeira parte de todas mensagens
202			* @param string $namespace
203			* @return string
204			*/
205			protected function buildMsgH($tipo, $namespace)
206			{
207			$key = 'enviar';
208			$codug = '';
209			if ($tipo == 'L') {
210			$key = 'listar';
211			$codug = "<codigoUg>$this->codigoUnidadeGestora</codigoUg>";
212			}
213			$msg = "<$key xmlns=\"$namespace\">";
214			$msg .= $codug;
215			$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...
216			$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...
217			return $msg;
218			}
219
220			/**
221			* Monta o corpo de todas as mensagens
222			* @param string $tipo
223			* @param array $data
224			* @return string
225			*/
226			protected function buildMsgB($tipo, $data)
227			{
228			if ($tipo == 'L') {
229			//numerico pagina
230			$pagina = $data['pagina'];
231			//array filtros []['','','','']
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-07-10 20:25 UTC by Report Bug Copy Issue Report `80%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
232			$filtros = $data['filtros'];
233			$msg = $this->buildListarB($pagina, $filtros);
234			} elseif ($tipo == 'E') {
235			$msg = $this->buildEnviarB($key, $data);
			0 ignored issues – show Bug introduced 2016-07-08 19:40 UTC by Report Bug Copy Issue Report The variable `$key` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history...
236			}
237			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...
238			}
239
240			/**
241			* Constroi o header da mensagem SOAP
242			*/
243			protected function buildSoapHeader()
244			{
245			$this->header = "<wsse:Security "
246			. "xmlns:wsse=\"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd\">"
247			. "<wsse:UsernameToken "
248			. "xmlns:wsu=\"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd\">"
249			. "<wsse:Username>"
250			. $this->username
251			. "</wsse:Username><wsse:Password "
252			. "Type=\"http://docs.oasis-open.org/wss/2004/01/"
253			. "oasis-200401-wss-username-token-profile-1.0#PasswordText\">"
254			. $this->password
255			. "</wsse:Password>"
256			. "</wsse:UsernameToken>"
257			. "</wsse:Security>";
258			}
259
260			/**
261			* Envia a mensagem para o webservice
262			* @param string $urlService
			0 ignored issues – show Bug introduced 2016-07-08 21:20 UTC by Report Bug Copy Issue Report There is no parameter named `$urlService`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
263			* @param strting $body
			0 ignored issues – show Bug introduced 2016-07-08 21:20 UTC by Report Bug Copy Issue Report There is no parameter named `$body`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
264			* @param string $method
265			* @return string
266			*/
267			protected function envia($uri, $namespace, $data, $method, $met)
268			{
269			//constroi a mensagem
270			$body = $this->buildMsgH($method, $namespace);
271			$body .= $this->buildMsgB($method, $data);
272			//envia pelo curl
273			$retorno = $this->oSoap->send($uri, $namespace, $this->header, $body, $method);
274			//processa o retorno
275			$resp = Response::readReturn($met, $retorno);
276			//salvar os arquivos para LOG
277			return $resp;
278			}
279
280			/**
281			* Carrega a classe SOAP e os certificados
282			*/
283			protected function loadSoapClass()
284			{
285			$pathlog = $this->pathFiles.DIRECTORY_SEPARATOR.$this->ambiente;
286			$this->oSoap = null;
287			$soap = new CurlSoap(
288			$pathlog,
289			$this->soapTimeout,
290			$this->aProxy
291			);
292			$this->oSoap = $soap;
293			}
294			}
295

nfephp-org / sped-esfinge

Push — master ( e55be9...5d6262 )

Base::getSoapTimeOut() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like