Caixa   A
last analyzed

Complexity

Total Complexity 4

Size/Duplication

Total Lines 199
Duplicated Lines 0 %

Coupling/Cohesion

Components 0
Dependencies 1

Importance

Changes 7
Bugs 0 Features 1
Metric Value
wmc 4
c 7
b 0
f 1
lcom 0
cbo 1
dl 0
loc 199
rs 10

2 Methods

Rating   Name   Duplication   Size   Complexity  
A defaults() 0 8 1
A motives() 0 10 3
1
<?php
2
3
namespace SmartCNAB\Support\Bank;
4
5
use SmartCNAB\Support\Bank\Bank;
6
7
/**
8
 * Bank Caixa support class.
9
 */
10
class Caixa extends Bank
11
{
12
    /**
13
     * Caixa instructions constants.
14
     */
15
    const INSTRUCTION_PROTEST = '01';
16
    const INSTRUCTION_DEVOLUTION = '02';
17
18
    /**
19
     * Constants for returning occurrences statuses.
20
     */
21
    const OCCURRENCES_DISCHARGED = [2, 23];
22
    const OCCURRENCES_ENTRY = [2];
23
    const OCCURRENCES_PAID = [21, 22];
24
    const OCCURRENCES_PROTESTED = [25];
25
26
    /**
27
     * Channels codes.
28
     *
29
     * @var array
30
     */
31
    protected static $channels = [
32
        '002' => 'Unidade lotérica',
33
        '003' => 'Agências CAIXA',
34
        '004' => 'Compensação eletrônica',
35
        '006' => 'Internet banking',
36
        '007' => 'Correspondente CAIXAaqui',
37
        '008' => 'Em cartório',
38
        '009' => 'Comandada banco',
39
        '010' => 'Comandada cliente via arquivo',
40
        '011' => 'Comandada cliente on-line',
41
    ];
42
43
    /**
44
     * Especies codes.
45
     *
46
     * @var array
47
     */
48
    protected static $especies = [
49
        '01' => 'Duplicata mercantil',
50
        '02' => 'Nota promissória',
51
        '03' => 'Duplicata de prestação de serviços',
52
        '05' => 'Nota de seguro',
53
        '06' => 'Letra de câmbio',
54
        '09' => 'Outros',
55
    ];
56
57
    /**
58
     * Emission codes.
59
     *
60
     * @var array
61
     */
62
    protected static $emission = [
63
        '1' => 'Banco emite',
64
        '2' => 'Cliente emite',
65
    ];
66
67
    /**
68
     * Postage codes.
69
     *
70
     * @var array
71
     */
72
    protected static $postage = [
73
        '1' => 'Postagem pelo Beneficiário',
74
        '2' => 'Pagador via Correio',
75
        '3' => 'Beneficiário via Agência CAIXA',
76
        '4' => 'Pagador via e-mail',
77
    ];
78
79
    /**
80
     * Billing instruction.
81
     *
82
     * @var array
83
     */
84
    protected static $instructions = [
85
        self::INSTRUCTION_PROTEST => 'Protestar - Dias corridos',
86
        self::INSTRUCTION_DEVOLUTION => 'Devolver - Não protestar',
87
    ];
88
89
    /**
90
     * Returning rejection codes.
91
     *
92
     * @var array
93
     */
94
    protected static $rejectionCodes = [
95
        '01' => 'Movimento sem beneficiário correspondente',
96
        '02' => 'Movimento sem título correspondente',
97
        '08' => 'Movimento para título já com movimentação no dia',
98
        '09' => 'Nosso número não pertence ao beneficiário',
99
        '10' => 'Inclusão de título já existente na base',
100
        '12' => 'Movimento duplicado',
101
        '13' => 'Entrada inválida para cobrança caucionada',
102
        '20' => 'CEP do pagador não encontrado',
103
        '21' => 'Agência cobradora não encontrada',
104
        '22' => 'Agência beneficiário não encontrada',
105
        '45' => 'Data de vencimento com prazo superior ao limite',
106
        '49' => 'Movimento inválido para título baixado/liquidado',
107
        '50' => 'Movimento inválido para título enviado a cartório',
108
        '54' => 'Faixa de CEP da agência cobradora não abrange CEP do pagador',
109
        '55' => 'Título já com opção de devolução',
110
        '56' => 'Processo de protesto em andamento',
111
        '57' => 'Título já com opção de protesto',
112
        '58' => 'Processo de devolução em andamento',
113
        '59' => 'Novo prazo p/ protesto/devolução inválido',
114
        '76' => 'Alteração do prazo de protesto inválida',
115
        '77' => 'Alteração do prazo de devolução inválida',
116
        '81' => 'CEP do pagador inválido',
117
        '82' => 'CNPJ/CPF do pagador inválido (dígito)',
118
        '83' => 'Número do documento (seu número) inválido',
119
        '84' => 'Protesto inválido para título sem número do documento (seu número)',
120
    ];
121
122
    /**
123
     * Remittance occurrences codes.
124
     *
125
     * @var array
126
     */
127
    protected static $remittanceOccurrences = [
128
        '01' => 'Entrada de Título',
129
        '02' => 'Pedido de baixa',
130
        '03' => 'Concessão de abatimento',
131
        '04' => 'Cancelamento de abatimento',
132
        '05' => 'Alteração do vencimento',
133
        '06' => 'Alteração do uso da empresa',
134
        '07' => 'Alteração do prazo de protesto',
135
        '08' => 'Alteração do prazo de devolução',
136
        '09' => 'Alteração de outros dados',
137
        // '10' => 'Alteração de dados com emissão de bloqueto', // Not implemented yet
0 ignored issues
show
Unused Code Comprehensibility introduced by
50% 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...
138
        '11' => 'Alteração da opção de protesto para devolução',
139
        '12' => 'Alteração da opção de devolução para protesto',
140
        // '31' => 'Alteração de outros dados', // Not implemented yet
0 ignored issues
show
Unused Code Comprehensibility introduced by
50% 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...
141
    ];
142
143
    /**
144
     * Return occurrences codes.
145
     *
146
     * @var array
147
     */
148
    protected static $returnOccurrences = [
149
        '01' => 'Entrada confirmada',
150
        '02' => 'Baixa manual confirmada',
151
        '03' => 'Abatimento concedido',
152
        '04' => 'Abatimento cancelado',
153
        '05' => 'Vencimento alterado',
154
        '06' => 'Uso da empresa alterado',
155
        '07' => 'Prazo de protesto alterado',
156
        '08' => 'Prazo de devolução alterado',
157
        '09' => 'Alteração confirmada',
158
        '10' => 'Alteração com reemissão de bloqueto confirmada',
159
        '11' => 'Alteração da opção de protesto para devolução confirmada',
160
        '12' => 'Alteração da opção de devolução para protesto confirmada',
161
        '20' => 'Em ser',
162
        '21' => 'Liquidação',
163
        '22' => 'Liquidação em cartório',
164
        '23' => 'Baixa por devolução',
165
        '25' => 'Baixa por protesto',
166
        '26' => 'Título enviado para cartório',
167
        '27' => 'Sustação de protesto',
168
        '28' => 'Estorno de protesto',
169
        '29' => 'Estorno de sustação de protesto',
170
        '30' => 'Alteração de título',
171
        '31' => 'Tarifa sobre título vencido',
172
        '32' => 'Outras tarifas de alteração',
173
        '33' => 'Estorno de baixa/liquidação',
174
        '34' => 'Tarifas diversas',
175
        '99' => 'Rejeição do título',
176
    ];
177
178
    /**
179
     * Return the default state of info.
180
     *
181
     * @return \StdClass
182
     */
183
    public function defaults()
184
    {
185
        return (object) [
186
            'especie' => '01',
187
            'instruction1' => '02',
188
            'instruction2' => '00',
189
        ];
190
    }
191
192
    /**
193
     * Return all motives codes.
194
     *
195
     * @param  int  $occurrenceCode
196
     * @return array
197
     */
198
    public function motives($occurrenceCode = null)
199
    {
200
        if ($occurrenceCode == '99') return [];
201
202
        if ( ! $occurrenceCode) return $this->rejectionCodes();
0 ignored issues
show
Bug Best Practice introduced by
The expression $occurrenceCode of type integer|null is loosely compared to false; this is ambiguous if the integer can be zero. You might want to explicitly use === null instead.

In PHP, under loose comparison (like ==, or !=, or switch conditions), values of different types might be equal.

For integer values, zero is a special case, in particular the following results might be unexpected:

0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
Loading history...
203
204
        $occurrenceCode = str_pad($occurrenceCode, 2, 0, STR_PAD_LEFT);
205
206
        return $this->rejectionCodes($occurrenceCode);
0 ignored issues
show
Unused Code introduced by
The call to Caixa::rejectionCodes() has too many arguments starting with $occurrenceCode.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
207
    }
208
}
209