Complex classes like Nota often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use Nota, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
49 | abstract class Nota implements Node |
||
50 | { |
||
51 | |||
52 | /** |
||
53 | * Versão da nota fiscal |
||
54 | */ |
||
55 | public const VERSAO = '4.00'; |
||
56 | |||
57 | /** |
||
58 | * Versão do aplicativo gerador da nota |
||
59 | */ |
||
60 | public const APP_VERSAO = '1.0'; |
||
61 | |||
62 | /** |
||
63 | * Portal da nota fiscal |
||
64 | */ |
||
65 | public const PORTAL = 'http://www.portalfiscal.inf.br/nfe'; |
||
66 | |||
67 | /** |
||
68 | * Código do modelo do Documento Fiscal. 55 = NF-e; 65 = NFC-e. |
||
69 | */ |
||
70 | public const MODELO_NFE = 'nfe'; |
||
71 | public const MODELO_NFCE = 'nfce'; |
||
72 | |||
73 | /** |
||
74 | * Tipo do Documento Fiscal (0 - entrada; 1 - saída) |
||
75 | */ |
||
76 | public const TIPO_ENTRADA = 'entrada'; |
||
77 | public const TIPO_SAIDA = 'saida'; |
||
78 | |||
79 | /** |
||
80 | * Identificador de Local de destino da operação |
||
81 | * (1-Interna;2-Interestadual;3-Exterior) |
||
82 | */ |
||
83 | public const DESTINO_INTERNA = 'interna'; |
||
84 | public const DESTINO_INTERESTADUAL = 'interestadual'; |
||
85 | public const DESTINO_EXTERIOR = 'exterior'; |
||
86 | |||
87 | /** |
||
88 | * Formato de impressão do DANFE (0-sem DANFE;1-DANFe Retrato; 2-DANFe |
||
89 | * Paisagem;3-DANFe Simplificado;4-DANFe NFC-e;5-DANFe NFC-e em mensagem |
||
90 | * eletrônica) |
||
91 | */ |
||
92 | public const FORMATO_NENHUMA = 'nenhuma'; |
||
93 | public const FORMATO_RETRATO = 'retrato'; |
||
94 | public const FORMATO_PAISAGEM = 'paisagem'; |
||
95 | public const FORMATO_SIMPLIFICADO = 'simplificado'; |
||
96 | public const FORMATO_CONSUMIDOR = 'consumidor'; |
||
97 | public const FORMATO_MENSAGEM = 'mensagem'; |
||
98 | |||
99 | /** |
||
100 | * Forma de emissão da NF-e |
||
101 | */ |
||
102 | public const EMISSAO_NORMAL = 'normal'; |
||
103 | public const EMISSAO_CONTINGENCIA = 'contingencia'; |
||
104 | |||
105 | /** |
||
106 | * Identificação do Ambiente: 1 - Produção, 2 - Homologação |
||
107 | */ |
||
108 | public const AMBIENTE_PRODUCAO = 'producao'; |
||
109 | public const AMBIENTE_HOMOLOGACAO = 'homologacao'; |
||
110 | |||
111 | /** |
||
112 | * Finalidade da emissão da NF-e: 1 - NFe normal, 2 - NFe complementar, 3 - |
||
113 | * NFe de ajuste, 4 - Devolução/Retorno |
||
114 | */ |
||
115 | public const FINALIDADE_NORMAL = 'normal'; |
||
116 | public const FINALIDADE_COMPLEMENTAR = 'complementar'; |
||
117 | public const FINALIDADE_AJUSTE = 'ajuste'; |
||
118 | public const FINALIDADE_RETORNO = 'retorno'; |
||
119 | |||
120 | /** |
||
121 | * Indicador de presença do comprador no estabelecimento comercial no |
||
122 | * momento da operação (0-Não se aplica ex.: Nota Fiscal complementar ou de |
||
123 | * ajuste;1-Operação presencial;2-Não presencial, internet;3-Não |
||
124 | * presencial, teleatendimento;4-NFC-e entrega em domicílio;5-Operação |
||
125 | * presencial, fora do estabelecimento;9-Não presencial, outros) |
||
126 | */ |
||
127 | public const PRESENCA_NENHUM = 'nenhum'; |
||
128 | public const PRESENCA_PRESENCIAL = 'presencial'; |
||
129 | public const PRESENCA_INTERNET = 'internet'; |
||
130 | public const PRESENCA_TELEATENDIMENTO = 'teleatendimento'; |
||
131 | public const PRESENCA_ENTREGA = 'entrega'; |
||
132 | public const PRESENCA_AMBULANTE = 'ambulante'; |
||
133 | public const PRESENCA_OUTROS = 'outros'; |
||
134 | |||
135 | /** |
||
136 | * Indicador de intermediador/marketplace 0=Operação sem intermediador (em |
||
137 | * site ou plataforma própria) 1=Operação em site ou plataforma de |
||
138 | * terceiros (intermediadores/marketplace) |
||
139 | */ |
||
140 | public const INTERMEDIACAO_NENHUM = 'nenhum'; |
||
141 | public const INTERMEDIACAO_TERCEIROS = 'terceiros'; |
||
142 | |||
143 | /** |
||
144 | * Chave da nota fiscal |
||
145 | */ |
||
146 | private $id; |
||
147 | |||
148 | /** |
||
149 | * Número do Documento Fiscal |
||
150 | */ |
||
151 | private $numero; |
||
152 | |||
153 | /** |
||
154 | * Emitente da nota fiscal |
||
155 | * |
||
156 | * @var Emitente |
||
157 | */ |
||
158 | private $emitente; |
||
159 | |||
160 | /** |
||
161 | * Destinatário que receberá os produtos |
||
162 | * |
||
163 | * @var Destinatario |
||
164 | */ |
||
165 | private $destinatario; |
||
166 | |||
167 | /** |
||
168 | * Grupo de informações do responsável técnico pelo sistema |
||
169 | * |
||
170 | * @var Responsavel |
||
171 | */ |
||
172 | private $responsavel; |
||
173 | |||
174 | /** |
||
175 | * Grupo de Informações do Intermediador da Transação |
||
176 | * |
||
177 | * @var Intermediador |
||
178 | */ |
||
179 | private $intermediador; |
||
180 | |||
181 | /** |
||
182 | * Produtos adicionados na nota |
||
183 | * |
||
184 | * @var Produto[] |
||
185 | */ |
||
186 | private $produtos; |
||
187 | |||
188 | /** |
||
189 | * Informações de trasnporte da mercadoria |
||
190 | * |
||
191 | * @var Transporte |
||
192 | */ |
||
193 | private $transporte; |
||
194 | |||
195 | /** |
||
196 | * Pagamentos realizados |
||
197 | * |
||
198 | * @var Pagamento[] |
||
199 | */ |
||
200 | private $pagamentos; |
||
201 | |||
202 | /** |
||
203 | * Data e Hora da saída ou de entrada da mercadoria / produto |
||
204 | */ |
||
205 | private $data_movimentacao; |
||
206 | |||
207 | /** |
||
208 | * Informar a data e hora de entrada em contingência |
||
209 | */ |
||
210 | private $data_contingencia; |
||
211 | |||
212 | /** |
||
213 | * Informar a Justificativa da entrada em contingência |
||
214 | */ |
||
215 | private $justificativa; |
||
216 | |||
217 | /** |
||
218 | * Código do modelo do Documento Fiscal. 55 = NF-e; 65 = NFC-e. |
||
219 | */ |
||
220 | private $modelo; |
||
221 | |||
222 | /** |
||
223 | * Tipo do Documento Fiscal (0 - entrada; 1 - saída) |
||
224 | */ |
||
225 | private $tipo; |
||
226 | |||
227 | /** |
||
228 | * Identificador de Local de destino da operação |
||
229 | * (1-Interna;2-Interestadual;3-Exterior) |
||
230 | */ |
||
231 | private $destino; |
||
232 | |||
233 | /** |
||
234 | * Descrição da Natureza da Operação |
||
235 | */ |
||
236 | private $natureza; |
||
237 | |||
238 | /** |
||
239 | * Código numérico que compõe a Chave de Acesso. Número aleatório gerado |
||
240 | * pelo emitente para cada NF-e. |
||
241 | */ |
||
242 | private $codigo; |
||
243 | |||
244 | /** |
||
245 | * Data e Hora de emissão do Documento Fiscal |
||
246 | */ |
||
247 | private $data_emissao; |
||
248 | |||
249 | /** |
||
250 | * Série do Documento Fiscal: série normal 0-889, Avulsa Fisco 890-899, |
||
251 | * SCAN 900-999 |
||
252 | */ |
||
253 | private $serie; |
||
254 | |||
255 | /** |
||
256 | * Formato de impressão do DANFE (0-sem DANFE;1-DANFe Retrato; 2-DANFe |
||
257 | * Paisagem;3-DANFe Simplificado;4-DANFe NFC-e;5-DANFe NFC-e em mensagem |
||
258 | * eletrônica) |
||
259 | */ |
||
260 | private $formato; |
||
261 | |||
262 | /** |
||
263 | * Forma de emissão da NF-e |
||
264 | */ |
||
265 | private $emissao; |
||
266 | |||
267 | /** |
||
268 | * Digito Verificador da Chave de Acesso da NF-e |
||
269 | */ |
||
270 | private $digito_verificador; |
||
271 | |||
272 | /** |
||
273 | * Identificação do Ambiente: 1 - Produção, 2 - Homologação |
||
274 | */ |
||
275 | private $ambiente; |
||
276 | |||
277 | /** |
||
278 | * Finalidade da emissão da NF-e: 1 - NFe normal, 2 - NFe complementar, 3 - |
||
279 | * NFe de ajuste, 4 - Devolução/Retorno |
||
280 | */ |
||
281 | private $finalidade; |
||
282 | |||
283 | /** |
||
284 | * Indica operação com consumidor final (0-Não;1-Consumidor Final) |
||
285 | */ |
||
286 | private $consumidor_final; |
||
287 | |||
288 | /** |
||
289 | * Indicador de presença do comprador no estabelecimento comercial no |
||
290 | * momento da oepração (0-Não se aplica, ex.: Nota Fiscal complementar ou |
||
291 | * de ajuste;1-Operação presencial;2-Não presencial, internet;3-Não |
||
292 | * presencial, teleatendimento;4-NFC-e entrega em domicílio;9-Não |
||
293 | * presencial, outros) |
||
294 | */ |
||
295 | private $presenca; |
||
296 | |||
297 | /** |
||
298 | * Indicador de intermediador/marketplace 0=Operação sem intermediador (em |
||
299 | * site ou plataforma própria) 1=Operação em site ou plataforma de |
||
300 | * terceiros (intermediadores/marketplace) |
||
301 | * |
||
302 | * @var string |
||
303 | */ |
||
304 | private $intermediacao; |
||
305 | |||
306 | /** |
||
307 | * Dados dos totais da NF-e |
||
308 | */ |
||
309 | private $total; |
||
310 | |||
311 | /** |
||
312 | * Informações adicionais de interesse do Fisco |
||
313 | */ |
||
314 | private $adicionais; |
||
315 | |||
316 | /** |
||
317 | * Campo de uso livre do contribuinte informar o nome do campo no atributo |
||
318 | * xCampo e o conteúdo do campo no xTexto |
||
319 | */ |
||
320 | private $observacoes; |
||
321 | |||
322 | /** |
||
323 | * Campo de uso exclusivo do Fisco informar o nome do campo no atributo |
||
324 | * xCampo e o conteúdo do campo no xTexto |
||
325 | */ |
||
326 | private $informacoes; |
||
327 | |||
328 | /** |
||
329 | * Protocolo de autorização da nota, informado apenas quando a nota for |
||
330 | * enviada e autorizada |
||
331 | * |
||
332 | * @var Protocolo |
||
333 | */ |
||
334 | private $protocolo; |
||
335 | |||
336 | /** |
||
337 | * Constroi uma instância de Nota vazia |
||
338 | * @param array $nota Array contendo dados da Nota |
||
339 | */ |
||
340 | public function __construct($nota = []) |
||
344 | |||
345 | /** |
||
346 | * Chave da nota fiscal |
||
347 | * @param boolean $normalize informa se o id deve estar no formato do XML |
||
348 | * @return mixed id da Nota |
||
349 | */ |
||
350 | public function getID($normalize = false) |
||
357 | |||
358 | /** |
||
359 | * Altera o valor do ID para o informado no parâmetro |
||
360 | * @param mixed $id novo valor para ID |
||
361 | * @return self |
||
362 | */ |
||
363 | public function setID($id) |
||
368 | |||
369 | /** |
||
370 | * Número do Documento Fiscal |
||
371 | * @param boolean $normalize informa se o numero deve estar no formato do XML |
||
372 | * @return mixed numero da Nota |
||
373 | */ |
||
374 | public function getNumero($normalize = false) |
||
381 | |||
382 | /** |
||
383 | * Altera o valor do Numero para o informado no parâmetro |
||
384 | * @param mixed $numero novo valor para Numero |
||
385 | * @return self |
||
386 | */ |
||
387 | public function setNumero($numero) |
||
392 | |||
393 | /** |
||
394 | * Emitente da nota fiscal |
||
395 | * @return Emitente emitente da Nota |
||
396 | */ |
||
397 | public function getEmitente() |
||
401 | |||
402 | /** |
||
403 | * Altera o valor do Emitente para o informado no parâmetro |
||
404 | * @param Emitente $emitente novo valor para Emitente |
||
405 | * @return self |
||
406 | */ |
||
407 | public function setEmitente($emitente) |
||
412 | |||
413 | /** |
||
414 | * Destinatário que receberá os produtos |
||
415 | * @return Destinatario destinatario da Nota |
||
416 | */ |
||
417 | public function getDestinatario() |
||
421 | |||
422 | /** |
||
423 | * Altera o valor do Destinatario para o informado no parâmetro |
||
424 | * @param Destinatario $destinatario novo valor para Destinatario |
||
425 | * @return self |
||
426 | */ |
||
427 | public function setDestinatario($destinatario) |
||
432 | |||
433 | /** |
||
434 | * Grupo de informações do responsável técnico pelo sistema |
||
435 | * @return Responsavel responsável da Nota |
||
436 | */ |
||
437 | public function getResponsavel() |
||
441 | |||
442 | /** |
||
443 | * Altera o valor do grupo de informações do responsável técnico pelo sistema |
||
444 | * @param Responsavel $responsavel novo valor para grupo de informações do responsável |
||
445 | * @return self |
||
446 | */ |
||
447 | public function setResponsavel($responsavel) |
||
452 | |||
453 | /** |
||
454 | * Produtos adicionados na nota |
||
455 | * @return Produto[] produtos da Nota |
||
456 | */ |
||
457 | public function getProdutos() |
||
461 | |||
462 | /** |
||
463 | * Altera o valor do Produtos para o informado no parâmetro |
||
464 | * |
||
465 | * @param Produto[] $produtos |
||
466 | * |
||
467 | * @return self |
||
468 | */ |
||
469 | public function setProdutos($produtos) |
||
474 | |||
475 | /** |
||
476 | * Adiciona um(a) Produto para a lista de produto |
||
477 | * @param Produto $produto Instância do Produto que será adicionada |
||
478 | * @return self |
||
479 | */ |
||
480 | public function addProduto($produto) |
||
485 | |||
486 | /** |
||
487 | * Grupo de Informações do Intermediador da Transação |
||
488 | * |
||
489 | * @return Intermediador |
||
490 | */ |
||
491 | public function getIntermediador() |
||
495 | |||
496 | /** |
||
497 | * Altera o valor do Intermediador para o informado no parâmetro |
||
498 | * |
||
499 | * @param Intermediador $intermediador |
||
500 | * |
||
501 | * @return self |
||
502 | */ |
||
503 | public function setIntermediador($intermediador) |
||
508 | |||
509 | /** |
||
510 | * Informações de trasnporte da mercadoria |
||
511 | * @return mixed transporte da Nota |
||
512 | */ |
||
513 | public function getTransporte() |
||
517 | |||
518 | /** |
||
519 | * Altera o valor da Transporte para o informado no parâmetro |
||
520 | * @param mixed $transporte novo valor para Transporte |
||
521 | * @return self |
||
522 | */ |
||
523 | public function setTransporte($transporte) |
||
528 | |||
529 | /** |
||
530 | * Pagamentos realizados |
||
531 | * @return mixed pagamentos da Nota |
||
532 | */ |
||
533 | public function getPagamentos() |
||
537 | |||
538 | /** |
||
539 | * Altera o valor do Pagamentos para o informado no parâmetro |
||
540 | * @param mixed $pagamentos novo valor para Pagamentos |
||
541 | * @return self |
||
542 | */ |
||
543 | public function setPagamentos($pagamentos) |
||
548 | |||
549 | /** |
||
550 | * Adiciona um(a) Pagamento para a lista de pagamento |
||
551 | * @param Pagamento $pagamento Instância do Pagamento que será adicionada |
||
552 | * @return self |
||
553 | */ |
||
554 | public function addPagamento($pagamento) |
||
559 | |||
560 | /** |
||
561 | * Data e Hora da saída ou de entrada da mercadoria / produto |
||
562 | * @param boolean $normalize informa se a data_movimentacao deve estar no formato do XML |
||
563 | * @return mixed data_movimentacao da Nota |
||
564 | */ |
||
565 | public function getDataMovimentacao($normalize = false) |
||
572 | |||
573 | /** |
||
574 | * Altera o valor da DataMovimentacao para o informado no parâmetro |
||
575 | * @param mixed $data_movimentacao novo valor para DataMovimentacao |
||
576 | * @return self |
||
577 | */ |
||
578 | public function setDataMovimentacao($data_movimentacao) |
||
586 | |||
587 | /** |
||
588 | * Informar a data e hora de entrada em contingência |
||
589 | * @param boolean $normalize informa se a data_contingencia deve estar no formato do XML |
||
590 | * @return mixed data_contingencia da Nota |
||
591 | */ |
||
592 | public function getDataContingencia($normalize = false) |
||
599 | |||
600 | /** |
||
601 | * Altera o valor da DataContingencia para o informado no parâmetro |
||
602 | * @param mixed $data_contingencia novo valor para DataContingencia |
||
603 | * @return self |
||
604 | */ |
||
605 | public function setDataContingencia($data_contingencia) |
||
613 | |||
614 | /** |
||
615 | * Informar a Justificativa da entrada em contingência |
||
616 | * @param boolean $normalize informa se a justificativa deve estar no formato do XML |
||
617 | * @return mixed justificativa da Nota |
||
618 | */ |
||
619 | public function getJustificativa($normalize = false) |
||
626 | |||
627 | /** |
||
628 | * Altera o valor da Justificativa para o informado no parâmetro |
||
629 | * @param mixed $justificativa novo valor para Justificativa |
||
630 | * @return self |
||
631 | */ |
||
632 | public function setJustificativa($justificativa) |
||
637 | |||
638 | /** |
||
639 | * Código do modelo do Documento Fiscal. 55 = NF-e; 65 = NFC-e. |
||
640 | * @param boolean $normalize informa se o modelo deve estar no formato do XML |
||
641 | * @return mixed modelo da Nota |
||
642 | */ |
||
643 | public function getModelo($normalize = false) |
||
656 | |||
657 | /** |
||
658 | * Altera o valor do Modelo para o informado no parâmetro |
||
659 | * @param mixed $modelo novo valor para Modelo |
||
660 | * @return self |
||
661 | */ |
||
662 | public function setModelo($modelo) |
||
675 | |||
676 | /** |
||
677 | * Tipo do Documento Fiscal (0 - entrada; 1 - saída) |
||
678 | * @param boolean $normalize informa se o tipo deve estar no formato do XML |
||
679 | * @return mixed tipo da Nota |
||
680 | */ |
||
681 | public function getTipo($normalize = false) |
||
694 | |||
695 | /** |
||
696 | * Altera o valor do Tipo para o informado no parâmetro |
||
697 | * @param mixed $tipo novo valor para Tipo |
||
698 | * @return self |
||
699 | */ |
||
700 | public function setTipo($tipo) |
||
713 | |||
714 | /** |
||
715 | * Identificador de Local de destino da operação |
||
716 | * (1-Interna;2-Interestadual;3-Exterior) |
||
717 | * @param boolean $normalize informa se o destino deve estar no formato do XML |
||
718 | * @return mixed destino da Nota |
||
719 | */ |
||
720 | public function getDestino($normalize = false) |
||
735 | |||
736 | /** |
||
737 | * Altera o valor do Destino para o informado no parâmetro |
||
738 | * @param mixed $destino novo valor para Destino |
||
739 | * @return self |
||
740 | */ |
||
741 | public function setDestino($destino) |
||
757 | |||
758 | /** |
||
759 | * Descrição da Natureza da Operação |
||
760 | * @param boolean $normalize informa se a natureza deve estar no formato do XML |
||
761 | * @return mixed natureza da Nota |
||
762 | */ |
||
763 | public function getNatureza($normalize = false) |
||
770 | |||
771 | /** |
||
772 | * Altera o valor da Natureza para o informado no parâmetro |
||
773 | * @param mixed $natureza novo valor para Natureza |
||
774 | * @return self |
||
775 | */ |
||
776 | public function setNatureza($natureza) |
||
781 | |||
782 | /** |
||
783 | * Código numérico que compõe a Chave de Acesso. Número aleatório gerado |
||
784 | * pelo emitente para cada NF-e. |
||
785 | * @param boolean $normalize informa se o codigo deve estar no formato do XML |
||
786 | * @return mixed codigo da Nota |
||
787 | */ |
||
788 | public function getCodigo($normalize = false) |
||
795 | |||
796 | /** |
||
797 | * Altera o valor do Codigo para o informado no parâmetro |
||
798 | * @param mixed $codigo novo valor para Codigo |
||
799 | * @return self |
||
800 | */ |
||
801 | public function setCodigo($codigo) |
||
806 | |||
807 | /** |
||
808 | * Data e Hora de emissão do Documento Fiscal |
||
809 | * @param boolean $normalize informa se o data_emissao deve estar no formato do XML |
||
810 | * @return mixed data_emissao da Nota |
||
811 | */ |
||
812 | public function getDataEmissao($normalize = false) |
||
819 | |||
820 | /** |
||
821 | * Altera o valor do DataEmissao para o informado no parâmetro |
||
822 | * @param mixed $data_emissao novo valor para DataEmissao |
||
823 | * @return self |
||
824 | */ |
||
825 | public function setDataEmissao($data_emissao) |
||
833 | |||
834 | /** |
||
835 | * Série do Documento Fiscal: série normal 0-889, Avulsa Fisco 890-899, |
||
836 | * SCAN 900-999 |
||
837 | * @param boolean $normalize informa se o serie deve estar no formato do XML |
||
838 | * @return mixed serie da Nota |
||
839 | */ |
||
840 | public function getSerie($normalize = false) |
||
847 | |||
848 | /** |
||
849 | * Altera o valor do Serie para o informado no parâmetro |
||
850 | * @param mixed $serie novo valor para Serie |
||
851 | * @return self |
||
852 | */ |
||
853 | public function setSerie($serie) |
||
858 | |||
859 | /** |
||
860 | * Formato de impressão do DANFE (0-sem DANFE;1-DANFe Retrato; 2-DANFe |
||
861 | * Paisagem;3-DANFe Simplificado;4-DANFe NFC-e;5-DANFe NFC-e em mensagem |
||
862 | * eletrônica) |
||
863 | * @param boolean $normalize informa se o formato deve estar no formato do XML |
||
864 | * @return mixed formato da Nota |
||
865 | */ |
||
866 | public function getFormato($normalize = false) |
||
887 | |||
888 | /** |
||
889 | * Altera o valor do Formato para o informado no parâmetro |
||
890 | * @param mixed $formato novo valor para Formato |
||
891 | * @return self |
||
892 | */ |
||
893 | public function setFormato($formato) |
||
918 | |||
919 | /** |
||
920 | * Forma de emissão da NF-e |
||
921 | * @param boolean $normalize informa se o emissao deve estar no formato do XML |
||
922 | * @return mixed emissao da Nota |
||
923 | */ |
||
924 | public function getEmissao($normalize = false) |
||
937 | |||
938 | /** |
||
939 | * Altera o valor do Emissao para o informado no parâmetro |
||
940 | * @param mixed $emissao novo valor para Emissao |
||
941 | * @return self |
||
942 | */ |
||
943 | public function setEmissao($emissao) |
||
956 | |||
957 | /** |
||
958 | * Digito Verificador da Chave de Acesso da NF-e |
||
959 | * @param boolean $normalize informa se o digito_verificador deve estar no formato do XML |
||
960 | * @return mixed digito_verificador da Nota |
||
961 | */ |
||
962 | public function getDigitoVerificador($normalize = false) |
||
969 | |||
970 | /** |
||
971 | * Altera o valor do DigitoVerificador para o informado no parâmetro |
||
972 | * @param mixed $digito_verificador novo valor para DigitoVerificador |
||
973 | * @return self |
||
974 | */ |
||
975 | public function setDigitoVerificador($digito_verificador) |
||
980 | |||
981 | /** |
||
982 | * Identificação do Ambiente: 1 - Produção, 2 - Homologação |
||
983 | * @param boolean $normalize informa se o ambiente deve estar no formato do XML |
||
984 | * @return mixed ambiente da Nota |
||
985 | */ |
||
986 | public function getAmbiente($normalize = false) |
||
999 | |||
1000 | /** |
||
1001 | * Altera o valor do Ambiente para o informado no parâmetro |
||
1002 | * @param mixed $ambiente novo valor para Ambiente |
||
1003 | * @return self |
||
1004 | */ |
||
1005 | public function setAmbiente($ambiente) |
||
1018 | |||
1019 | /** |
||
1020 | * Finalidade da emissão da NF-e: 1 - NFe normal, 2 - NFe complementar, 3 - |
||
1021 | * NFe de ajuste, 4 - Devolução/Retorno |
||
1022 | * @param boolean $normalize informa se a finalidade deve estar no formato do XML |
||
1023 | * @return mixed finalidade da Nota |
||
1024 | */ |
||
1025 | public function getFinalidade($normalize = false) |
||
1042 | |||
1043 | /** |
||
1044 | * Altera o valor da Finalidade para o informado no parâmetro |
||
1045 | * @param mixed $finalidade novo valor para Finalidade |
||
1046 | * @return self |
||
1047 | */ |
||
1048 | public function setFinalidade($finalidade) |
||
1067 | |||
1068 | /** |
||
1069 | * Indica operação com consumidor final (0-Não;1-Consumidor Final) |
||
1070 | * @param boolean $normalize informa se o consumidor_final deve estar no formato do XML |
||
1071 | * @return mixed consumidor_final da Nota |
||
1072 | */ |
||
1073 | public function getConsumidorFinal($normalize = false) |
||
1086 | |||
1087 | /** |
||
1088 | * Indica operação com consumidor final (0-Não;1-Consumidor Final) |
||
1089 | * @return boolean informa se o ConsumidorFinal está habilitado |
||
1090 | */ |
||
1091 | public function isConsumidorFinal() |
||
1095 | |||
1096 | /** |
||
1097 | * Altera o valor do ConsumidorFinal para o informado no parâmetro |
||
1098 | * @param mixed $consumidor_final novo valor para ConsumidorFinal |
||
1099 | * @return self |
||
1100 | */ |
||
1101 | public function setConsumidorFinal($consumidor_final) |
||
1109 | |||
1110 | /** |
||
1111 | * Indicador de presença do comprador no estabelecimento comercial no |
||
1112 | * momento da oepração (0-Não se aplica (ex.: Nota Fiscal complementar ou |
||
1113 | * de ajuste;1-Operação presencial;2-Não presencial, internet; |
||
1114 | * 3-Não presencial, teleatendimento;4-NFC-e entrega em domicílio; |
||
1115 | * 5-Operação presencial, fora do estabelecimento;9-Não presencial, outros) |
||
1116 | * @param boolean $normalize informa se a presenca deve estar no formato do XML |
||
1117 | * @return mixed presenca da Nota |
||
1118 | */ |
||
1119 | public function getPresenca($normalize = false) |
||
1142 | |||
1143 | /** |
||
1144 | * Altera o valor da Presenca para o informado no parâmetro |
||
1145 | * @param mixed $presenca novo valor para Presenca |
||
1146 | * @return self |
||
1147 | */ |
||
1148 | public function setPresenca($presenca) |
||
1176 | |||
1177 | /** |
||
1178 | * Indicador de intermediador/marketplace 0=Operação sem intermediador (em |
||
1179 | * site ou plataforma própria) 1=Operação em site ou plataforma de |
||
1180 | * terceiros (intermediadores/marketplace) |
||
1181 | * @param boolean $normalize informa se a intermediacao deve estar no formato do XML |
||
1182 | * @return string intermediacao of Nota |
||
1183 | */ |
||
1184 | public function getIntermediacao($normalize = false) |
||
1197 | |||
1198 | /** |
||
1199 | * Altera o valor da Intermediacao para o informado no parâmetro |
||
1200 | * @param mixed $intermediacao novo valor para Intermediacao |
||
1201 | * @param string $intermediacao Novo intermediacao para Nota |
||
1202 | * @return self |
||
1203 | */ |
||
1204 | public function setIntermediacao($intermediacao) |
||
1217 | |||
1218 | /** |
||
1219 | * Dados dos totais da NF-e |
||
1220 | * @return mixed total da Nota |
||
1221 | */ |
||
1222 | public function getTotal() |
||
1226 | |||
1227 | /** |
||
1228 | * Altera o valor do Total para o informado no parâmetro |
||
1229 | * @param mixed $total novo valor para Total |
||
1230 | * @return self |
||
1231 | */ |
||
1232 | public function setTotal($total) |
||
1237 | |||
1238 | /** |
||
1239 | * Informações adicionais de interesse do Fisco |
||
1240 | * @param boolean $normalize informa se a adicionais deve estar no formato do XML |
||
1241 | * @return mixed adicionais da Nota |
||
1242 | */ |
||
1243 | public function getAdicionais($normalize = false) |
||
1250 | |||
1251 | /** |
||
1252 | * Altera o valor da Adicionais para o informado no parâmetro |
||
1253 | * @param mixed $adicionais novo valor para Adicionais |
||
1254 | * @return self |
||
1255 | */ |
||
1256 | public function setAdicionais($adicionais) |
||
1261 | |||
1262 | /** |
||
1263 | * Campo de uso livre do contribuinte informar o nome do campo no atributo |
||
1264 | * xCampo e o conteúdo do campo no xTexto |
||
1265 | * @return mixed observacoes da Nota |
||
1266 | */ |
||
1267 | public function getObservacoes() |
||
1271 | |||
1272 | /** |
||
1273 | * Altera o valor da Observacoes para o informado no parâmetro |
||
1274 | * @param mixed $observacoes novo valor para Observacoes |
||
1275 | * @return self |
||
1276 | */ |
||
1277 | public function setObservacoes($observacoes) |
||
1282 | |||
1283 | /** |
||
1284 | * Adiciona um(a) Observacao para a lista de observacao |
||
1285 | * @param Observacao $observacao Instância da Observacao que será adicionada |
||
1286 | * @return self |
||
1287 | */ |
||
1288 | public function addObservacao($campo, $observacao) |
||
1293 | |||
1294 | /** |
||
1295 | * Campo de uso exclusivo do Fisco informar o nome do campo no atributo |
||
1296 | * xCampo e o conteúdo do campo no xTexto |
||
1297 | * @return mixed informacoes da Nota |
||
1298 | */ |
||
1299 | public function getInformacoes() |
||
1303 | |||
1304 | /** |
||
1305 | * Altera o valor da Informacoes para o informado no parâmetro |
||
1306 | * @param mixed $informacoes novo valor para Informacoes |
||
1307 | * @return self |
||
1308 | */ |
||
1309 | public function setInformacoes($informacoes) |
||
1314 | |||
1315 | /** |
||
1316 | * Adiciona um(a) Informacao para a lista de informacao |
||
1317 | * @param Informacao $informacao Instância da Informacao que será adicionada |
||
1318 | * @return self |
||
1319 | */ |
||
1320 | public function addInformacao($campo, $informacao) |
||
1325 | |||
1326 | /** |
||
1327 | * Protocolo de autorização da nota, informado apenas quando a nota for |
||
1328 | * enviada e autorizada |
||
1329 | */ |
||
1330 | public function getProtocolo() |
||
1334 | |||
1335 | public function setProtocolo($protocolo) |
||
1340 | |||
1341 | public function toArray($recursive = false) |
||
1424 | |||
1425 | public function fromArray($nota = []) |
||
1574 | |||
1575 | public function gerarID() |
||
1593 | |||
1594 | public function getTotais() |
||
1669 | |||
1670 | private function getNodeTotal($name = null) |
||
1707 | |||
1708 | public function getNode($name = null) |
||
1858 | |||
1859 | public function loadNode($element, $name = null) |
||
2125 | |||
2126 | /** |
||
2127 | * Carrega um arquivo XML e preenche a nota com as informações dele |
||
2128 | * @param string $filename caminho do arquivo |
||
2129 | * @return DOMDocument objeto do documento carregado |
||
2130 | */ |
||
2131 | public function load($filename) |
||
2141 | |||
2142 | /** |
||
2143 | * Assina o XML com a assinatura eletrônica do tipo A1 |
||
2144 | */ |
||
2145 | public function assinar($dom = null) |
||
2162 | |||
2163 | /** |
||
2164 | * Valida o documento após assinar |
||
2165 | */ |
||
2166 | public function validar($dom) |
||
2193 | |||
2194 | /** |
||
2195 | * Adiciona o protocolo no XML da nota |
||
2196 | */ |
||
2197 | public function addProtocolo($dom) |
||
2227 | } |
||
2228 |
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..