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 |
||
| 47 | abstract class Nota implements Node |
||
| 48 | { |
||
| 49 | |||
| 50 | /** |
||
| 51 | * Versão da nota fiscal |
||
| 52 | */ |
||
| 53 | const VERSAO = '4.00'; |
||
| 54 | |||
| 55 | /** |
||
| 56 | * Versão do aplicativo gerador da nota |
||
| 57 | */ |
||
| 58 | const APP_VERSAO = '1.0'; |
||
| 59 | |||
| 60 | /** |
||
| 61 | * Portal da nota fiscal |
||
| 62 | */ |
||
| 63 | const PORTAL = 'http://www.portalfiscal.inf.br/nfe'; |
||
| 64 | |||
| 65 | /** |
||
| 66 | * Código do modelo do Documento Fiscal. 55 = NF-e; 65 = NFC-e. |
||
| 67 | */ |
||
| 68 | const MODELO_NFE = 'nfe'; |
||
| 69 | const MODELO_NFCE = 'nfce'; |
||
| 70 | |||
| 71 | /** |
||
| 72 | * Tipo do Documento Fiscal (0 - entrada; 1 - saída) |
||
| 73 | */ |
||
| 74 | const TIPO_ENTRADA = 'entrada'; |
||
| 75 | const TIPO_SAIDA = 'saida'; |
||
| 76 | |||
| 77 | /** |
||
| 78 | * Identificador de Local de destino da operação |
||
| 79 | * (1-Interna;2-Interestadual;3-Exterior) |
||
| 80 | */ |
||
| 81 | const DESTINO_INTERNA = 'interna'; |
||
| 82 | const DESTINO_INTERESTADUAL = 'interestadual'; |
||
| 83 | const DESTINO_EXTERIOR = 'exterior'; |
||
| 84 | |||
| 85 | /** |
||
| 86 | * Formato de impressão do DANFE (0-sem DANFE;1-DANFe Retrato; 2-DANFe |
||
| 87 | * Paisagem;3-DANFe Simplificado;4-DANFe NFC-e;5-DANFe NFC-e em mensagem |
||
| 88 | * eletrônica) |
||
| 89 | */ |
||
| 90 | const FORMATO_NENHUMA = 'nenhuma'; |
||
| 91 | const FORMATO_RETRATO = 'retrato'; |
||
| 92 | const FORMATO_PAISAGEM = 'paisagem'; |
||
| 93 | const FORMATO_SIMPLIFICADO = 'simplificado'; |
||
| 94 | const FORMATO_CONSUMIDOR = 'consumidor'; |
||
| 95 | const FORMATO_MENSAGEM = 'mensagem'; |
||
| 96 | |||
| 97 | /** |
||
| 98 | * Forma de emissão da NF-e |
||
| 99 | */ |
||
| 100 | const EMISSAO_NORMAL = 'normal'; |
||
| 101 | const EMISSAO_CONTINGENCIA = 'contingencia'; |
||
| 102 | |||
| 103 | /** |
||
| 104 | * Identificação do Ambiente: 1 - Produção, 2 - Homologação |
||
| 105 | */ |
||
| 106 | const AMBIENTE_PRODUCAO = 'producao'; |
||
| 107 | const AMBIENTE_HOMOLOGACAO = 'homologacao'; |
||
| 108 | |||
| 109 | /** |
||
| 110 | * Finalidade da emissão da NF-e: 1 - NFe normal, 2 - NFe complementar, 3 - |
||
| 111 | * NFe de ajuste, 4 - Devolução/Retorno |
||
| 112 | */ |
||
| 113 | const FINALIDADE_NORMAL = 'normal'; |
||
| 114 | const FINALIDADE_COMPLEMENTAR = 'complementar'; |
||
| 115 | const FINALIDADE_AJUSTE = 'ajuste'; |
||
| 116 | const FINALIDADE_RETORNO = 'retorno'; |
||
| 117 | |||
| 118 | /** |
||
| 119 | * Indicador de presença do comprador no estabelecimento comercial no |
||
| 120 | * momento da operação (0-Não se aplica ex.: Nota Fiscal complementar ou de |
||
| 121 | * ajuste;1-Operação presencial;2-Não presencial, internet;3-Não |
||
| 122 | * presencial, teleatendimento;4-NFC-e entrega em domicílio;5-Operação |
||
| 123 | * presencial, fora do estabelecimento;9-Não presencial, outros) |
||
| 124 | */ |
||
| 125 | const PRESENCA_NENHUM = 'nenhum'; |
||
| 126 | const PRESENCA_PRESENCIAL = 'presencial'; |
||
| 127 | const PRESENCA_INTERNET = 'internet'; |
||
| 128 | const PRESENCA_TELEATENDIMENTO = 'teleatendimento'; |
||
| 129 | const PRESENCA_ENTREGA = 'entrega'; |
||
| 130 | const PRESENCA_AMBULANTE = 'ambulante'; |
||
| 131 | const PRESENCA_OUTROS = 'outros'; |
||
| 132 | |||
| 133 | /** |
||
| 134 | * Chave da nota fiscal |
||
| 135 | */ |
||
| 136 | private $id; |
||
| 137 | /** |
||
| 138 | * Número do Documento Fiscal |
||
| 139 | */ |
||
| 140 | private $numero; |
||
| 141 | /** |
||
| 142 | * Emitente da nota fiscal |
||
| 143 | */ |
||
| 144 | private $emitente; |
||
| 145 | /** |
||
| 146 | * Destinatário que receberá os produtos |
||
| 147 | */ |
||
| 148 | private $destinatario; |
||
| 149 | /** |
||
| 150 | * Produtos adicionados na nota |
||
| 151 | */ |
||
| 152 | private $produtos; |
||
| 153 | /** |
||
| 154 | * Informações de trasnporte da mercadoria |
||
| 155 | */ |
||
| 156 | private $transporte; |
||
| 157 | /** |
||
| 158 | * Pagamentos realizados |
||
| 159 | */ |
||
| 160 | private $pagamentos; |
||
| 161 | /** |
||
| 162 | * Data e Hora da saída ou de entrada da mercadoria / produto |
||
| 163 | */ |
||
| 164 | private $data_movimentacao; |
||
| 165 | /** |
||
| 166 | * Informar a data e hora de entrada em contingência |
||
| 167 | */ |
||
| 168 | private $data_contingencia; |
||
| 169 | /** |
||
| 170 | * Informar a Justificativa da entrada em contingência |
||
| 171 | */ |
||
| 172 | private $justificativa; |
||
| 173 | /** |
||
| 174 | * Código do modelo do Documento Fiscal. 55 = NF-e; 65 = NFC-e. |
||
| 175 | */ |
||
| 176 | private $modelo; |
||
| 177 | /** |
||
| 178 | * Tipo do Documento Fiscal (0 - entrada; 1 - saída) |
||
| 179 | */ |
||
| 180 | private $tipo; |
||
| 181 | /** |
||
| 182 | * Identificador de Local de destino da operação |
||
| 183 | * (1-Interna;2-Interestadual;3-Exterior) |
||
| 184 | */ |
||
| 185 | private $destino; |
||
| 186 | /** |
||
| 187 | * Descrição da Natureza da Operação |
||
| 188 | */ |
||
| 189 | private $natureza; |
||
| 190 | /** |
||
| 191 | * Código numérico que compõe a Chave de Acesso. Número aleatório gerado |
||
| 192 | * pelo emitente para cada NF-e. |
||
| 193 | */ |
||
| 194 | private $codigo; |
||
| 195 | /** |
||
| 196 | * Data e Hora de emissão do Documento Fiscal |
||
| 197 | */ |
||
| 198 | private $data_emissao; |
||
| 199 | /** |
||
| 200 | * Série do Documento Fiscal: série normal 0-889, Avulsa Fisco 890-899, |
||
| 201 | * SCAN 900-999 |
||
| 202 | */ |
||
| 203 | private $serie; |
||
| 204 | /** |
||
| 205 | * Formato de impressão do DANFE (0-sem DANFE;1-DANFe Retrato; 2-DANFe |
||
| 206 | * Paisagem;3-DANFe Simplificado;4-DANFe NFC-e;5-DANFe NFC-e em mensagem |
||
| 207 | * eletrônica) |
||
| 208 | */ |
||
| 209 | private $formato; |
||
| 210 | /** |
||
| 211 | * Forma de emissão da NF-e |
||
| 212 | */ |
||
| 213 | private $emissao; |
||
| 214 | /** |
||
| 215 | * Digito Verificador da Chave de Acesso da NF-e |
||
| 216 | */ |
||
| 217 | private $digito_verificador; |
||
| 218 | /** |
||
| 219 | * Identificação do Ambiente: 1 - Produção, 2 - Homologação |
||
| 220 | */ |
||
| 221 | private $ambiente; |
||
| 222 | /** |
||
| 223 | * Finalidade da emissão da NF-e: 1 - NFe normal, 2 - NFe complementar, 3 - |
||
| 224 | * NFe de ajuste, 4 - Devolução/Retorno |
||
| 225 | */ |
||
| 226 | private $finalidade; |
||
| 227 | /** |
||
| 228 | * Indica operação com consumidor final (0-Não;1-Consumidor Final) |
||
| 229 | */ |
||
| 230 | private $consumidor_final; |
||
| 231 | /** |
||
| 232 | * Indicador de presença do comprador no estabelecimento comercial no |
||
| 233 | * momento da oepração (0-Não se aplica, ex.: Nota Fiscal complementar ou |
||
| 234 | * de ajuste;1-Operação presencial;2-Não presencial, internet;3-Não |
||
| 235 | * presencial, teleatendimento;4-NFC-e entrega em domicílio;9-Não |
||
| 236 | * presencial, outros) |
||
| 237 | */ |
||
| 238 | private $presenca; |
||
| 239 | /** |
||
| 240 | * Dados dos totais da NF-e |
||
| 241 | */ |
||
| 242 | private $total; |
||
| 243 | /** |
||
| 244 | * Informações adicionais de interesse do Fisco |
||
| 245 | */ |
||
| 246 | private $adicionais; |
||
| 247 | /** |
||
| 248 | * Campo de uso livre do contribuinte informar o nome do campo no atributo |
||
| 249 | * xCampo e o conteúdo do campo no xTexto |
||
| 250 | */ |
||
| 251 | private $observacoes; |
||
| 252 | /** |
||
| 253 | * Campo de uso exclusivo do Fisco informar o nome do campo no atributo |
||
| 254 | * xCampo e o conteúdo do campo no xTexto |
||
| 255 | */ |
||
| 256 | private $informacoes; |
||
| 257 | /** |
||
| 258 | * Protocolo de autorização da nota, informado apenas quando a nota for |
||
| 259 | * enviada e autorizada |
||
| 260 | */ |
||
| 261 | private $protocolo; |
||
| 262 | |||
| 263 | /** |
||
| 264 | * Constroi uma instância de Nota vazia |
||
| 265 | * @param array $nota Array contendo dados da Nota |
||
| 266 | */ |
||
| 267 | 35 | public function __construct($nota = []) |
|
| 271 | |||
| 272 | /** |
||
| 273 | * Chave da nota fiscal |
||
| 274 | * @param boolean $normalize informa se o id deve estar no formato do XML |
||
| 275 | * @return mixed id da Nota |
||
| 276 | */ |
||
| 277 | 33 | public function getID($normalize = false) |
|
| 284 | |||
| 285 | /** |
||
| 286 | * Altera o valor do ID para o informado no parâmetro |
||
| 287 | * @param mixed $id novo valor para ID |
||
| 288 | * @return Nota A própria instância da classe |
||
| 289 | */ |
||
| 290 | 35 | public function setID($id) |
|
| 295 | |||
| 296 | /** |
||
| 297 | * Número do Documento Fiscal |
||
| 298 | * @param boolean $normalize informa se o numero deve estar no formato do XML |
||
| 299 | * @return mixed numero da Nota |
||
| 300 | */ |
||
| 301 | 33 | public function getNumero($normalize = false) |
|
| 308 | |||
| 309 | /** |
||
| 310 | * Altera o valor do Numero para o informado no parâmetro |
||
| 311 | * @param mixed $numero novo valor para Numero |
||
| 312 | * @return Nota A própria instância da classe |
||
| 313 | */ |
||
| 314 | 35 | public function setNumero($numero) |
|
| 319 | |||
| 320 | /** |
||
| 321 | * Emitente da nota fiscal |
||
| 322 | * @return mixed emitente da Nota |
||
| 323 | */ |
||
| 324 | 33 | public function getEmitente() |
|
| 328 | |||
| 329 | /** |
||
| 330 | * Altera o valor do Emitente para o informado no parâmetro |
||
| 331 | * @param mixed $emitente novo valor para Emitente |
||
| 332 | * @return Nota A própria instância da classe |
||
| 333 | */ |
||
| 334 | 35 | public function setEmitente($emitente) |
|
| 339 | |||
| 340 | /** |
||
| 341 | * Destinatário que receberá os produtos |
||
| 342 | * @return mixed destinatario da Nota |
||
| 343 | */ |
||
| 344 | 33 | public function getDestinatario() |
|
| 348 | |||
| 349 | /** |
||
| 350 | * Altera o valor do Destinatario para o informado no parâmetro |
||
| 351 | * @param mixed $destinatario novo valor para Destinatario |
||
| 352 | * @return Nota A própria instância da classe |
||
| 353 | */ |
||
| 354 | 35 | public function setDestinatario($destinatario) |
|
| 359 | |||
| 360 | /** |
||
| 361 | * Produtos adicionados na nota |
||
| 362 | * @return \NFe\Entity\Produto[] produtos da Nota |
||
| 363 | */ |
||
| 364 | 33 | public function getProdutos() |
|
| 368 | |||
| 369 | /** |
||
| 370 | * Altera o valor do Produtos para o informado no parâmetro |
||
| 371 | * @param mixed $produtos novo valor para Produtos |
||
| 372 | * @return Nota A própria instância da classe |
||
| 373 | */ |
||
| 374 | 35 | public function setProdutos($produtos) |
|
| 379 | |||
| 380 | /** |
||
| 381 | * Adiciona um(a) Produto para a lista de produto |
||
| 382 | * @param Produto $produto Instância do Produto que será adicionada |
||
| 383 | * @return Nota A própria instância da classe |
||
| 384 | */ |
||
| 385 | 6 | public function addProduto($produto) |
|
| 390 | |||
| 391 | /** |
||
| 392 | * Informações de trasnporte da mercadoria |
||
| 393 | * @return mixed transporte da Nota |
||
| 394 | */ |
||
| 395 | 33 | public function getTransporte() |
|
| 399 | |||
| 400 | /** |
||
| 401 | * Altera o valor da Transporte para o informado no parâmetro |
||
| 402 | * @param mixed $transporte novo valor para Transporte |
||
| 403 | * @return Nota A própria instância da classe |
||
| 404 | */ |
||
| 405 | 35 | public function setTransporte($transporte) |
|
| 410 | |||
| 411 | /** |
||
| 412 | * Pagamentos realizados |
||
| 413 | * @return mixed pagamentos da Nota |
||
| 414 | */ |
||
| 415 | 33 | public function getPagamentos() |
|
| 419 | |||
| 420 | /** |
||
| 421 | * Altera o valor do Pagamentos para o informado no parâmetro |
||
| 422 | * @param mixed $pagamentos novo valor para Pagamentos |
||
| 423 | * @return Nota A própria instância da classe |
||
| 424 | */ |
||
| 425 | 35 | public function setPagamentos($pagamentos) |
|
| 430 | |||
| 431 | /** |
||
| 432 | * Adiciona um(a) Pagamento para a lista de pagamento |
||
| 433 | * @param Pagamento $pagamento Instância do Pagamento que será adicionada |
||
| 434 | * @return Nota A própria instância da classe |
||
| 435 | */ |
||
| 436 | 5 | public function addPagamento($pagamento) |
|
| 441 | |||
| 442 | /** |
||
| 443 | * Data e Hora da saída ou de entrada da mercadoria / produto |
||
| 444 | * @param boolean $normalize informa se a data_movimentacao deve estar no formato do XML |
||
| 445 | * @return mixed data_movimentacao da Nota |
||
| 446 | */ |
||
| 447 | 33 | public function getDataMovimentacao($normalize = false) |
|
| 454 | |||
| 455 | /** |
||
| 456 | * Altera o valor da DataMovimentacao para o informado no parâmetro |
||
| 457 | * @param mixed $data_movimentacao novo valor para DataMovimentacao |
||
| 458 | * @return Nota A própria instância da classe |
||
| 459 | */ |
||
| 460 | 35 | public function setDataMovimentacao($data_movimentacao) |
|
| 468 | |||
| 469 | /** |
||
| 470 | * Informar a data e hora de entrada em contingência |
||
| 471 | * @param boolean $normalize informa se a data_contingencia deve estar no formato do XML |
||
| 472 | * @return mixed data_contingencia da Nota |
||
| 473 | */ |
||
| 474 | 8 | public function getDataContingencia($normalize = false) |
|
| 481 | |||
| 482 | /** |
||
| 483 | * Altera o valor da DataContingencia para o informado no parâmetro |
||
| 484 | * @param mixed $data_contingencia novo valor para DataContingencia |
||
| 485 | * @return Nota A própria instância da classe |
||
| 486 | */ |
||
| 487 | 35 | public function setDataContingencia($data_contingencia) |
|
| 495 | |||
| 496 | /** |
||
| 497 | * Informar a Justificativa da entrada em contingência |
||
| 498 | * @param boolean $normalize informa se a justificativa deve estar no formato do XML |
||
| 499 | * @return mixed justificativa da Nota |
||
| 500 | */ |
||
| 501 | 10 | public function getJustificativa($normalize = false) |
|
| 508 | |||
| 509 | /** |
||
| 510 | * Altera o valor da Justificativa para o informado no parâmetro |
||
| 511 | * @param mixed $justificativa novo valor para Justificativa |
||
| 512 | * @return Nota A própria instância da classe |
||
| 513 | */ |
||
| 514 | 35 | public function setJustificativa($justificativa) |
|
| 519 | |||
| 520 | /** |
||
| 521 | * Código do modelo do Documento Fiscal. 55 = NF-e; 65 = NFC-e. |
||
| 522 | * @param boolean $normalize informa se o modelo deve estar no formato do XML |
||
| 523 | * @return mixed modelo da Nota |
||
| 524 | */ |
||
| 525 | 33 | public function getModelo($normalize = false) |
|
| 538 | |||
| 539 | /** |
||
| 540 | * Altera o valor do Modelo para o informado no parâmetro |
||
| 541 | * @param mixed $modelo novo valor para Modelo |
||
| 542 | * @return Nota A própria instância da classe |
||
| 543 | */ |
||
| 544 | 35 | public function setModelo($modelo) |
|
| 557 | |||
| 558 | /** |
||
| 559 | * Tipo do Documento Fiscal (0 - entrada; 1 - saída) |
||
| 560 | * @param boolean $normalize informa se o tipo deve estar no formato do XML |
||
| 561 | * @return mixed tipo da Nota |
||
| 562 | */ |
||
| 563 | 33 | public function getTipo($normalize = false) |
|
| 576 | |||
| 577 | /** |
||
| 578 | * Altera o valor do Tipo para o informado no parâmetro |
||
| 579 | * @param mixed $tipo novo valor para Tipo |
||
| 580 | * @return Nota A própria instância da classe |
||
| 581 | */ |
||
| 582 | 35 | public function setTipo($tipo) |
|
| 595 | |||
| 596 | /** |
||
| 597 | * Identificador de Local de destino da operação |
||
| 598 | * (1-Interna;2-Interestadual;3-Exterior) |
||
| 599 | * @param boolean $normalize informa se o destino deve estar no formato do XML |
||
| 600 | * @return mixed destino da Nota |
||
| 601 | */ |
||
| 602 | 33 | public function getDestino($normalize = false) |
|
| 617 | |||
| 618 | /** |
||
| 619 | * Altera o valor do Destino para o informado no parâmetro |
||
| 620 | * @param mixed $destino novo valor para Destino |
||
| 621 | * @return Nota A própria instância da classe |
||
| 622 | */ |
||
| 623 | 35 | public function setDestino($destino) |
|
| 639 | |||
| 640 | /** |
||
| 641 | * Descrição da Natureza da Operação |
||
| 642 | * @param boolean $normalize informa se a natureza deve estar no formato do XML |
||
| 643 | * @return mixed natureza da Nota |
||
| 644 | */ |
||
| 645 | 33 | public function getNatureza($normalize = false) |
|
| 652 | |||
| 653 | /** |
||
| 654 | * Altera o valor da Natureza para o informado no parâmetro |
||
| 655 | * @param mixed $natureza novo valor para Natureza |
||
| 656 | * @return Nota A própria instância da classe |
||
| 657 | */ |
||
| 658 | 35 | public function setNatureza($natureza) |
|
| 663 | |||
| 664 | /** |
||
| 665 | * Código numérico que compõe a Chave de Acesso. Número aleatório gerado |
||
| 666 | * pelo emitente para cada NF-e. |
||
| 667 | * @param boolean $normalize informa se o codigo deve estar no formato do XML |
||
| 668 | * @return mixed codigo da Nota |
||
| 669 | */ |
||
| 670 | 33 | public function getCodigo($normalize = false) |
|
| 677 | |||
| 678 | /** |
||
| 679 | * Altera o valor do Codigo para o informado no parâmetro |
||
| 680 | * @param mixed $codigo novo valor para Codigo |
||
| 681 | * @return Nota A própria instância da classe |
||
| 682 | */ |
||
| 683 | 35 | public function setCodigo($codigo) |
|
| 688 | |||
| 689 | /** |
||
| 690 | * Data e Hora de emissão do Documento Fiscal |
||
| 691 | * @param boolean $normalize informa se o data_emissao deve estar no formato do XML |
||
| 692 | * @return mixed data_emissao da Nota |
||
| 693 | */ |
||
| 694 | 33 | public function getDataEmissao($normalize = false) |
|
| 701 | |||
| 702 | /** |
||
| 703 | * Altera o valor do DataEmissao para o informado no parâmetro |
||
| 704 | * @param mixed $data_emissao novo valor para DataEmissao |
||
| 705 | * @return Nota A própria instância da classe |
||
| 706 | */ |
||
| 707 | 35 | public function setDataEmissao($data_emissao) |
|
| 715 | |||
| 716 | /** |
||
| 717 | * Série do Documento Fiscal: série normal 0-889, Avulsa Fisco 890-899, |
||
| 718 | * SCAN 900-999 |
||
| 719 | * @param boolean $normalize informa se o serie deve estar no formato do XML |
||
| 720 | * @return mixed serie da Nota |
||
| 721 | */ |
||
| 722 | 33 | public function getSerie($normalize = false) |
|
| 729 | |||
| 730 | /** |
||
| 731 | * Altera o valor do Serie para o informado no parâmetro |
||
| 732 | * @param mixed $serie novo valor para Serie |
||
| 733 | * @return Nota A própria instância da classe |
||
| 734 | */ |
||
| 735 | 35 | public function setSerie($serie) |
|
| 740 | |||
| 741 | /** |
||
| 742 | * Formato de impressão do DANFE (0-sem DANFE;1-DANFe Retrato; 2-DANFe |
||
| 743 | * Paisagem;3-DANFe Simplificado;4-DANFe NFC-e;5-DANFe NFC-e em mensagem |
||
| 744 | * eletrônica) |
||
| 745 | * @param boolean $normalize informa se o formato deve estar no formato do XML |
||
| 746 | * @return mixed formato da Nota |
||
| 747 | */ |
||
| 748 | 33 | public function getFormato($normalize = false) |
|
| 769 | |||
| 770 | /** |
||
| 771 | * Altera o valor do Formato para o informado no parâmetro |
||
| 772 | * @param mixed $formato novo valor para Formato |
||
| 773 | * @return Nota A própria instância da classe |
||
| 774 | */ |
||
| 775 | 35 | public function setFormato($formato) |
|
| 800 | |||
| 801 | /** |
||
| 802 | * Forma de emissão da NF-e |
||
| 803 | * @param boolean $normalize informa se o emissao deve estar no formato do XML |
||
| 804 | * @return mixed emissao da Nota |
||
| 805 | */ |
||
| 806 | 33 | public function getEmissao($normalize = false) |
|
| 819 | |||
| 820 | /** |
||
| 821 | * Altera o valor do Emissao para o informado no parâmetro |
||
| 822 | * @param mixed $emissao novo valor para Emissao |
||
| 823 | * @return Nota A própria instância da classe |
||
| 824 | */ |
||
| 825 | 35 | public function setEmissao($emissao) |
|
| 838 | |||
| 839 | /** |
||
| 840 | * Digito Verificador da Chave de Acesso da NF-e |
||
| 841 | * @param boolean $normalize informa se o digito_verificador deve estar no formato do XML |
||
| 842 | * @return mixed digito_verificador da Nota |
||
| 843 | */ |
||
| 844 | 33 | public function getDigitoVerificador($normalize = false) |
|
| 851 | |||
| 852 | /** |
||
| 853 | * Altera o valor do DigitoVerificador para o informado no parâmetro |
||
| 854 | * @param mixed $digito_verificador novo valor para DigitoVerificador |
||
| 855 | * @return Nota A própria instância da classe |
||
| 856 | */ |
||
| 857 | 35 | public function setDigitoVerificador($digito_verificador) |
|
| 862 | |||
| 863 | /** |
||
| 864 | * Identificação do Ambiente: 1 - Produção, 2 - Homologação |
||
| 865 | * @param boolean $normalize informa se o ambiente deve estar no formato do XML |
||
| 866 | * @return mixed ambiente da Nota |
||
| 867 | */ |
||
| 868 | 33 | public function getAmbiente($normalize = false) |
|
| 881 | |||
| 882 | /** |
||
| 883 | * Altera o valor do Ambiente para o informado no parâmetro |
||
| 884 | * @param mixed $ambiente novo valor para Ambiente |
||
| 885 | * @return Nota A própria instância da classe |
||
| 886 | */ |
||
| 887 | 35 | public function setAmbiente($ambiente) |
|
| 900 | |||
| 901 | /** |
||
| 902 | * Finalidade da emissão da NF-e: 1 - NFe normal, 2 - NFe complementar, 3 - |
||
| 903 | * NFe de ajuste, 4 - Devolução/Retorno |
||
| 904 | * @param boolean $normalize informa se a finalidade deve estar no formato do XML |
||
| 905 | * @return mixed finalidade da Nota |
||
| 906 | */ |
||
| 907 | 33 | public function getFinalidade($normalize = false) |
|
| 924 | |||
| 925 | /** |
||
| 926 | * Altera o valor da Finalidade para o informado no parâmetro |
||
| 927 | * @param mixed $finalidade novo valor para Finalidade |
||
| 928 | * @return Nota A própria instância da classe |
||
| 929 | */ |
||
| 930 | 35 | public function setFinalidade($finalidade) |
|
| 949 | |||
| 950 | /** |
||
| 951 | * Indica operação com consumidor final (0-Não;1-Consumidor Final) |
||
| 952 | * @param boolean $normalize informa se o consumidor_final deve estar no formato do XML |
||
| 953 | * @return mixed consumidor_final da Nota |
||
| 954 | */ |
||
| 955 | 33 | public function getConsumidorFinal($normalize = false) |
|
| 968 | |||
| 969 | /** |
||
| 970 | * Indica operação com consumidor final (0-Não;1-Consumidor Final) |
||
| 971 | * @return boolean informa se o ConsumidorFinal está habilitado |
||
| 972 | */ |
||
| 973 | public function isConsumidorFinal() |
||
| 977 | |||
| 978 | /** |
||
| 979 | * Altera o valor do ConsumidorFinal para o informado no parâmetro |
||
| 980 | * @param mixed $consumidor_final novo valor para ConsumidorFinal |
||
| 981 | * @return Nota A própria instância da classe |
||
| 982 | */ |
||
| 983 | 35 | public function setConsumidorFinal($consumidor_final) |
|
| 991 | |||
| 992 | /** |
||
| 993 | * Indicador de presença do comprador no estabelecimento comercial no |
||
| 994 | * momento da oepração (0-Não se aplica (ex.: Nota Fiscal complementar ou |
||
| 995 | * de ajuste;1-Operação presencial;2-Não presencial, internet; |
||
| 996 | * 3-Não presencial, teleatendimento;4-NFC-e entrega em domicílio; |
||
| 997 | * 5-Operação presencial, fora do estabelecimento;9-Não presencial, outros) |
||
| 998 | * @param boolean $normalize informa se a presenca deve estar no formato do XML |
||
| 999 | * @return mixed presenca da Nota |
||
| 1000 | */ |
||
| 1001 | 33 | public function getPresenca($normalize = false) |
|
| 1024 | |||
| 1025 | /** |
||
| 1026 | * Altera o valor da Presenca para o informado no parâmetro |
||
| 1027 | * @param mixed $presenca novo valor para Presenca |
||
| 1028 | * @return Nota A própria instância da classe |
||
| 1029 | */ |
||
| 1030 | 35 | public function setPresenca($presenca) |
|
| 1058 | |||
| 1059 | /** |
||
| 1060 | * Dados dos totais da NF-e |
||
| 1061 | * @return mixed total da Nota |
||
| 1062 | */ |
||
| 1063 | 33 | public function getTotal() |
|
| 1067 | |||
| 1068 | /** |
||
| 1069 | * Altera o valor do Total para o informado no parâmetro |
||
| 1070 | * @param mixed $total novo valor para Total |
||
| 1071 | * @return Nota A própria instância da classe |
||
| 1072 | */ |
||
| 1073 | 35 | public function setTotal($total) |
|
| 1078 | |||
| 1079 | /** |
||
| 1080 | * Informações adicionais de interesse do Fisco |
||
| 1081 | * @param boolean $normalize informa se a adicionais deve estar no formato do XML |
||
| 1082 | * @return mixed adicionais da Nota |
||
| 1083 | */ |
||
| 1084 | 33 | public function getAdicionais($normalize = false) |
|
| 1091 | |||
| 1092 | /** |
||
| 1093 | * Altera o valor da Adicionais para o informado no parâmetro |
||
| 1094 | * @param mixed $adicionais novo valor para Adicionais |
||
| 1095 | * @return Nota A própria instância da classe |
||
| 1096 | */ |
||
| 1097 | 35 | public function setAdicionais($adicionais) |
|
| 1102 | |||
| 1103 | /** |
||
| 1104 | * Campo de uso livre do contribuinte informar o nome do campo no atributo |
||
| 1105 | * xCampo e o conteúdo do campo no xTexto |
||
| 1106 | * @return mixed observacoes da Nota |
||
| 1107 | */ |
||
| 1108 | 33 | public function getObservacoes() |
|
| 1112 | |||
| 1113 | /** |
||
| 1114 | * Altera o valor da Observacoes para o informado no parâmetro |
||
| 1115 | * @param mixed $observacoes novo valor para Observacoes |
||
| 1116 | * @return Nota A própria instância da classe |
||
| 1117 | */ |
||
| 1118 | 35 | public function setObservacoes($observacoes) |
|
| 1123 | |||
| 1124 | /** |
||
| 1125 | * Adiciona um(a) Observacao para a lista de observacao |
||
| 1126 | * @param Observacao $observacao Instância da Observacao que será adicionada |
||
| 1127 | * @return Nota A própria instância da classe |
||
| 1128 | */ |
||
| 1129 | 6 | public function addObservacao($campo, $observacao) |
|
| 1134 | |||
| 1135 | /** |
||
| 1136 | * Campo de uso exclusivo do Fisco informar o nome do campo no atributo |
||
| 1137 | * xCampo e o conteúdo do campo no xTexto |
||
| 1138 | * @return mixed informacoes da Nota |
||
| 1139 | */ |
||
| 1140 | 33 | public function getInformacoes() |
|
| 1144 | |||
| 1145 | /** |
||
| 1146 | * Altera o valor da Informacoes para o informado no parâmetro |
||
| 1147 | * @param mixed $informacoes novo valor para Informacoes |
||
| 1148 | * @return Nota A própria instância da classe |
||
| 1149 | */ |
||
| 1150 | 35 | public function setInformacoes($informacoes) |
|
| 1155 | |||
| 1156 | /** |
||
| 1157 | * Adiciona um(a) Informacao para a lista de informacao |
||
| 1158 | * @param Informacao $informacao Instância da Informacao que será adicionada |
||
| 1159 | * @return Nota A própria instância da classe |
||
| 1160 | */ |
||
| 1161 | 6 | public function addInformacao($campo, $informacao) |
|
| 1166 | |||
| 1167 | /** |
||
| 1168 | * Protocolo de autorização da nota, informado apenas quando a nota for |
||
| 1169 | * enviada e autorizada |
||
| 1170 | */ |
||
| 1171 | 31 | public function getProtocolo() |
|
| 1175 | |||
| 1176 | 35 | public function setProtocolo($protocolo) |
|
| 1181 | |||
| 1182 | 8 | public function toArray($recursive = false) |
|
| 1254 | |||
| 1255 | 35 | public function fromArray($nota = []) |
|
| 1393 | |||
| 1394 | 32 | public function gerarID() |
|
| 1412 | |||
| 1413 | 32 | public function getTotais() |
|
| 1488 | |||
| 1489 | 32 | private function getNodeTotal($name = null) |
|
| 1526 | |||
| 1527 | 32 | public function getNode($name = null) |
|
| 1664 | |||
| 1665 | 27 | public function loadNode($element, $name = null) |
|
| 1916 | |||
| 1917 | /** |
||
| 1918 | * Carrega um arquivo XML e preenche a nota com as informações dele |
||
| 1919 | * @param string $filename caminho do arquivo |
||
| 1920 | * @return DOMDocument objeto do documento carregado |
||
| 1921 | */ |
||
| 1922 | 27 | public function load($filename) |
|
| 1923 | { |
||
| 1924 | 27 | $dom = new \DOMDocument(); |
|
| 1925 | 27 | if (!file_exists($filename)) { |
|
| 1926 | 1 | throw new \Exception('Arquivo XML "'.$filename.'" não encontrado', 404); |
|
| 1927 | } |
||
| 1928 | 26 | $dom->load($filename); |
|
| 1929 | 26 | $this->loadNode($dom->documentElement); |
|
| 1930 | 26 | return $dom; |
|
| 1931 | } |
||
| 1932 | |||
| 1933 | /** |
||
| 1934 | * Assina o XML com a assinatura eletrônica do tipo A1 |
||
| 1935 | */ |
||
| 1936 | 29 | public function assinar($dom = null) |
|
| 1953 | |||
| 1954 | /** |
||
| 1955 | * Valida o documento após assinar |
||
| 1956 | */ |
||
| 1957 | 27 | public function validar($dom) |
|
| 1984 | |||
| 1985 | /** |
||
| 1986 | * Adiciona o protocolo no XML da nota |
||
| 1987 | */ |
||
| 1988 | 3 | public function addProtocolo($dom) |
|
| 2018 | } |
||
| 2019 |
Really long classes often contain too much logic and violate the single responsibility principle.
We suggest to take a look at the “Code” section for options on how to refactor this code.