Completed
Push — master ( 840670...3a4b3b )
by Roberto
15:29 queued 12:55
created

Tools::getTransferencia()   A

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 0
Metric Value
c 0
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
1
<?php
2
3
namespace NFePHP\Esfinge;
4
5
use InvalidArgumentException;
6
use RuntimeException;
7
use NFePHP\Esfinge\Response;
8
use NFePHP\Esfinge\Base;
9
10
class Tools extends Base
11
{
12
    const TK_OBTEM = 'O';
13
    const TK_INICIA = 'I';
14
    const TK_FINALIZA = 'F';
15
    const TK_CANCELA = 'C';
16
    const TK_STATUS = 'S';
17
    
18
    /**
19
     * Endereços principais dos webservices
20
     * @var array
21
     */
22
    protected $url = [
23
        '1' => 'https://esfingews.tce.sc.gov.br',
24
        '2' => 'https://desenv2.tce.sc.gov.br:7443',
25
    ];
26
    /**
27
     * Competência bimestral no formato: AAAABB, onde:
28
     * AAAA = ano a ser enviado os dados
29
     * BB = bimestre de 01 até 06
30
     * @var string
31
     */
32
    protected $competencia = ''; 
33
    /**
34
     * Token de segurança e queue
35
     * hash com 36 caracteres aleatórios
36
     * @var string
37
     */
38
    protected $tokenid = '';
39
    /**
40
     * Flag iniciar tranferencia
41
     * @var bool
42
     */
43
    protected $flagIniciar = false;
44
    /**
45
     * Datahora da ultima solicitação da situação do token
46
     * @var timestramp
47
     */
48
    protected $tsLastSitToken;
49
    
50
    /**
51
     * Construtor
52
     * @param string $configJson
53
     */
54 6
    public function __construct($configJson = '')
55
    {
56 6
        parent::__construct($configJson);
57 3
    }
58
    
59
    /**
60
     * Define o período de competência das informações
61
     * formado AAAABB sendo BB o bimestre de 01 até 06
62
     * @param string $valor
0 ignored issues
show
Bug introduced by
There is no parameter named $valor. 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...
63
     */
64 9
    public function setCompetencia($aaaabb)
65
    {
66 9
        if (!is_numeric($aaaabb)) {
67 3
            throw new InvalidArgumentException('O periodo de competência é uma informação APENAS numérica.');
68
        }
69 6
        $bm = intval(substr($aaaabb, -2));
70 6
        if ($bm > 6 || $bm <= 0) {
71 3
            throw new InvalidArgumentException('O bimestre pode ser de 01 até 06 APENAS.');
72
        }
73 3
        $this->competencia = $aaaabb;
0 ignored issues
show
Documentation Bug introduced by
It seems like $aaaabb can also be of type integer or double. However, the property $competencia is declared as type string. 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...
74 3
    }
75
    
76
    /**
77
     * Retorna o período de competência informado
78
     * @return string
79
     */
80 3
    public function getCompetencia()
81
    {
82 3
        return $this->competencia;
83
    }
84
    
85
    /**
86
     * Retorna no token ativo
87
     * @return string
88
     */
89 3
    public function getToken()
90
    {
91 3
        return $this->tokenid;
92
    }
93
    
94
    /**
95
     * Retorna o status de inicio de transferencia
96
     * @return bool
97
     */
98
    public function getTransferencia()
99
    {
100
        return $this->flagIniciar;
101
    }
102
    
103
    /**
104
     * Operações com token
105
     * O método pode ser:
106
     *   C - cancela a transferencia
107
     *   F - finaliza a transferencia
108
     *   I - inica a transferencia
109
     *   O - Obtem o token para realizar as operações
110
     *   S - Verifica a situação do token
111
     * @param string $method
112
     */
113
    public function token($method = self::TK_OBTEM)
114
    {
115
        $uri = $this->url[$this->tpAmb].'/esfinge/services/tokenWS';
116
        $namespace = 'http://token.ws.tce.sc.gov.br/';
117
        
118
        switch ($method) {
119 View Code Duplication
            case self::TK_CANCELA:
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
120
                //cancela as operações realizadas com um determinado token
121
                //se OK o token é removido e todas as operações com ele
122
                //realizadas são descartadas
123
                if ($this->flagIniciar === false) {
124
                    //não está iniciada a tranferencia então não dá para cancelar
125
                    throw new RuntimeException('A tranferencia não foi iniciada, então não pode ser cancelada');
126
                }
127
                $met = 'cancelarTransferencia';
128
                $body = "<svc:cancelarTransferencia>"
129
                    . "<chaveToken>$this->tokenid</chaveToken>"
130
                    . "</svc:cancelarTransferencia>";
131
                $resp = $this->envia($uri, $namespace, $body, '', $met);
132
                if ($resp['bStat'] && $resp['status'] == 'OK') {
133
                    //cancelamento aceito
134
                    $this->tokenid = '';
135
                    $this->flagIniciar = false;
136
                }
137
                break;
138 View Code Duplication
            case self::TK_FINALIZA:
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
139
                //Ao final da transferência caso queria confirmar todos os elementos inseridos
140
                //(que não retornaram erro) nesta sessão, ou seja todos os elementos ligados a
141
                //determinado token passado para o serviço. Uma vez executado este serviço
142
                //o token atual será descartado.
143
                if ($this->flagIniciar === false) {
144
                    //não está iniciada a tranferencia então não dá para finalizar
145
                    throw new RuntimeException('A tranferencia não foi iniciada, então não pode ser finalizada');
146
                }
147
                $met = 'finalizarTransferencia';
148
                $body = "<svc:finalizarTransferencia>"
149
                    . "<chaveToken>$this->tokenid</chaveToken>"
150
                    . "</svc:finalizarTransferencia>";
151
                $resp = $this->envia($uri, $namespace, $body, '', $met);
152
                if ($resp['bStat'] && $resp['status'] == 'OK') {
153
                    //finalização aceita
154
                    $this->tokenid = '';
155
                    $this->flagIniciar = false;
156
                }
157
                break;
158
            case self::TK_INICIA:
159
                //Antes de iniciar a transferência dos dados propriamente dita, será necessário executar
160
                //o serviço iniciarTransferencia
161
                if ($this->tokenid == '') {
162
                    //não é possivel iniciar sem um token valido
163
                    throw new RuntimeException('Não é possivel iniciar a tranferência sem um token valido');
164
                    //$this->token(self::TK_O);
0 ignored issues
show
Unused Code Comprehensibility introduced by
78% 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...
165
                }
166
                if ($this->flagIniciar === true) {
167
                    $resp = [
168
                        'bStat' => true,
169
                        'message' => 'Início de transferência liberado',
170
                        'status' => 'OK'
171
                    ];
172
                    break;
173
                }
174
                $met = 'iniciarTransferencia';
175
                $body = "<svc:iniciarTransferencia>"
176
                    . "<chaveToken>$this->tokenid</chaveToken>"
177
                    . "</svc:iniciarTransferencia>";
178
                $resp = $this->envia($uri, $namespace, $body, '', $met);
179
                if ($resp['bStat'] && $resp['status'] == 'OK') {
180
                    $this->flagIniciar = true;
181
                }
182
                break;
183
            case self::TK_OBTEM:
184
                //Retorna um token para a unidade gestora poder usar o serviço do TCE.
185
                //Permite somente um token por unidade gestora.
186 View Code Duplication
                if ($this->tokenid != '') {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
187
                    $resp = [
188
                        'bStat' => true,
189
                        'message' => 'Token criado com sucesso',
190
                        'status' => 'OK',
191
                        'chaveToken' => $this->tokenid,
192
                        'posicao' => 2,
193
                        'situacao' => 'Pronto para envio ou consulta'
194
                    ];
195
                    break;
196
                }
197
                $met = 'obterToken';
198
                $body = "<svc:obterToken>"
199
                    . "<codigoUg>$this->codigoUnidadeGestora</codigoUg>"
200
                    . "</svc:obterToken>";
201
                $resp = $this->envia($uri, $namespace, $body, '', $met);
202
                if ($resp['bStat']
203
                    && $resp['chaveToken'] != ''
204
                    && $resp['status'] == 'OK'
205
                ) {
206
                    $this->tokenid = $resp['chaveToken'];
207
                }
208
                break;
209
            case self::TK_STATUS:
210
                //Retorna a situação do token passado como parâmetro. Para evitar solicitações
211
                //indefinidas a este serviço o sistema punirá com a remoção do token da fila
212
                //sempre que for feita duas chamadas seguidas do serviço obterSituacaoToken
213
                //em menos de cinco segundos.
214
                if ($this->tokenid == '') {
215
                    //não é possivel verificar o token
216
                    throw new RuntimeException('Não existe um token aberto.');
217
                }
218
                //se tentativa de verificação ocorrer em menos de 2 seg
219
                //retorna como OK
220 View Code Duplication
                if ((time()-$this->tsLastSitToken) <= 2) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
221
                    $resp = [
222
                        'bStat' => true,
223
                        'message' => 'Situação token obtida com sucesso',
224
                        'status' => 'OK',
225
                        'posicao' => 1,
226
                        'situacao' => 'Pronto para envio ou consulta'
227
                    ];
228
                    break;
229
                }
230
                $met = 'obterSituacaoToken';
231
                $body = "<svc:obterSituacaoToken>"
232
                    . "<chaveToken>$this->tokenid</chaveToken>"
233
                    . "</svc:obterSituacaoToken>";
234
                $resp = $this->envia($uri, $namespace, $body, '', $met);
235
                $this->tsLastSitToken = time();
0 ignored issues
show
Documentation Bug introduced by
It seems like time() of type integer is incompatible with the declared type object<NFePHP\Esfinge\timestramp> of property $tsLastSitToken.

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...
236
                break;
237
        }
238
        return $resp;
0 ignored issues
show
Bug introduced by
The variable $resp 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

  1. 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;
        }
    }
    
  2. 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;
    }
    
  3. 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...
239
    }
240
    
241
    /**
242
     * Inicia o processo de tranferência de dados
243
     * @param array $data
244
     * @throws InvalidArgumentException
245
     * @throws RuntimeException
246
     */
247
    protected function obterTokenIniciarTransferencia($data = array(), $method = 'L')
248
    {
249
        if (empty($data)) {
250
            throw new InvalidArgumentException('Não foram passados dados para o método');
251
        }
252
        $this->token(self::TK_OBTEM);
253
        if ($method == 'E') {
254
            $this->token(self::TK_INICIA);
255
        }
256
        if ($this->tokenid == '') {
257
            throw new RuntimeException("Falha token:$this->tokenid , Iniciar: $this->flagIniciar");
258
        }
259
    }
260
261
    /**
262
     * Servidor
263
     *  se ainda não tiver o TOKEN -> Obtem  (automático)
264
     *  se ainda não tiver iniciado -> inicia (automático)
265
     * @param array $data
266
     * @param string $method
267
     * @return array
268
     */
269 View Code Duplication
    public function servidor($data = array(), $method = 'L')
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
270
    {
271
        $this->obterTokenIniciarTransferencia($data, $method);
272
        $uri = $this->url[$this->tpAmb].'/esfinge/services/servidorWS';
273
        $namespace = 'http://servidor.ws.tce.sc.gov.br/';
274
        $met = 'servidor'.$method;
275
        //envia a mensagem via cURL
276
        $resp = $this->envia($uri, $namespace, $data, $method, $met);
277
        return $resp;
278
    }
279
    
280
    /**
281
     * Situação Servidor Folha Pagamento
282
     *  se ainda não tiver o TOKEN -> Obtem  (automático)
283
     *  se ainda não tiver iniciado -> inicia (automático)
284
     * @param array $data
285
     * @param string $method
286
     * @return array
287
     */
288 View Code Duplication
    public function situacaoServidorFolhaPagamento($data = array(), $method = 'L')
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
289
    {
290
        $this->obterTokenIniciarTransferencia($data, $method);
291
        $uri = $this->url[$this->tpAmb].'/esfinge/services/situacaoServidorFolhaPagamentoWS';
292
        $namespace = 'http://situacaoservidorfolhapagamento.ws.tce.sc.gov.br/';
293
        $met = 'situacaoServidorFolhaPagamento'.$method;
294
        $resp = $this->envia($uri, $namespace, $data, $method, $met);
295
        return $resp;
296
    }
297
298
    /**
299
     * Componentes Folha Pagamento
300
     *  se ainda não tiver o TOKEN -> Obtem  (automático)
301
     *  se ainda não tiver iniciado -> inicia (automático)
302
     * @param array $data
303
     * @param string $method
304
     * @return array
305
     */
306 View Code Duplication
    public function componentesFolhaPagamento($data = array(), $method = 'L')
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
307
    {
308
        $this->obterTokenIniciarTransferencia($data, $method);
309
        $uri = $this->url[$this->tpAmb].'/esfinge/services/componentesFolhaPagamentoWS';
310
        $namespace = 'http://componentesfolhapagamento.ws.tce.sc.gov.br/';
311
        $met = 'componentesFolhaPagamento'.$method;
312
        $resp = $this->envia($uri, $namespace, $data, $method, $met);
313
        return $resp;
314
    }
315
316
    /**
317
     * Folha Pagamento
318
     *  se ainda não tiver o TOKEN -> Obtem  (automático)
319
     *  se ainda não tiver iniciado -> inicia (automático)
320
     * @param array $data
321
     * @param string $method
322
     * @return array
323
     */
324 View Code Duplication
    public function folhaPagamento($data = array(), $method = 'L')
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
325
    {
326
        $this->obterTokenIniciarTransferencia($data, $method);
327
        $uri = $this->url[$this->tpAmb].'/esfinge/services/folhaPagamentoWS';
328
        $namespace = 'http://folhapagamento.ws.tce.sc.gov.br/';
329
        $met = 'folhaPagamento'.$method;
330
        $resp = $this->envia($uri, $namespace, $data, $method, $met);
331
        return $resp;
332
    }
333
}
334