mazinsw /
nfe-api
Complex classes like Ajuste 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 Ajuste, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 37 | class Ajuste extends Configuracao implements Evento |
||
|
|
|||
| 38 | { |
||
| 39 | /** |
||
| 40 | * Caminho onde será salvo os XMLs |
||
| 41 | * @var string |
||
| 42 | */ |
||
| 43 | private $pasta_xml_base; |
||
| 44 | /** |
||
| 45 | * Subpasta onde será salvo os XMLs das numerações inutilizadas |
||
| 46 | * @var string |
||
| 47 | */ |
||
| 48 | private $pasta_xml_inutilizado; |
||
| 49 | /** |
||
| 50 | * Subpasta onde será salvo os XMLs dos eventos de cancelamentos |
||
| 51 | * @var string |
||
| 52 | */ |
||
| 53 | private $pasta_xml_cancelado; |
||
| 54 | /** |
||
| 55 | * Subpasta onde será salvo os XMLs das notas pendentes de envio |
||
| 56 | * @var string |
||
| 57 | */ |
||
| 58 | private $pasta_xml_pendente; |
||
| 59 | /** |
||
| 60 | * Subpasta onde será salvo os XMLs das notas denegadas pela SEFAZ |
||
| 61 | * @var string |
||
| 62 | */ |
||
| 63 | private $pasta_xml_denegado; |
||
| 64 | /** |
||
| 65 | * Subpasta onde será salvo os XMLs das notas rejeitadas |
||
| 66 | * @var string |
||
| 67 | */ |
||
| 68 | private $pasta_xml_rejeitado; |
||
| 69 | /** |
||
| 70 | * Subpasta onde será salvo os XMLs das notas autorizadas |
||
| 71 | * @var string |
||
| 72 | */ |
||
| 73 | private $pasta_xml_autorizado; |
||
| 74 | /** |
||
| 75 | * Subpasta onde será salvo os XMLs das notas em processamento na SEFAZ |
||
| 76 | * @var string |
||
| 77 | */ |
||
| 78 | private $pasta_xml_processamento; |
||
| 79 | /** |
||
| 80 | * Subpasta onde será salvo os XMLs das notas assinadas com certificado digital |
||
| 81 | * @var string |
||
| 82 | */ |
||
| 83 | private $pasta_xml_assinado; |
||
| 84 | |||
| 85 | /** |
||
| 86 | * @param mixed $ajuste array ou intância |
||
| 87 | */ |
||
| 88 | 102 | public function __construct($ajuste = []) |
|
| 108 | |||
| 109 | /** |
||
| 110 | * Caminho da pasta base para armazenamento dos XML |
||
| 111 | * @return string |
||
| 112 | */ |
||
| 113 | 5 | public function getPastaXmlBase() |
|
| 117 | |||
| 118 | /** |
||
| 119 | * @param string $pasta_xml_base |
||
| 120 | * @return self |
||
| 121 | */ |
||
| 122 | 102 | public function setPastaXmlBase($pasta_xml_base) |
|
| 127 | |||
| 128 | /** |
||
| 129 | * Pasta onde ficam os XML das inutilizações de números de notas |
||
| 130 | * @param string $ambiente |
||
| 131 | * @param string $caminho |
||
| 132 | * @return string |
||
| 133 | */ |
||
| 134 | 3 | protected function aplicaAmbiente($ambiente, $caminho) |
|
| 147 | |||
| 148 | /** |
||
| 149 | * Exclui os arquivos XML desnecessários |
||
| 150 | * @param \NFe\Core\Nota $nota nota |
||
| 151 | */ |
||
| 152 | 2 | protected function deleteXmlAnteriores($nota) |
|
| 174 | |||
| 175 | /** |
||
| 176 | * Pasta onde ficam os XML das inutilizações de números de notas |
||
| 177 | * @param string $ambiente |
||
| 178 | * @return string |
||
| 179 | */ |
||
| 180 | 3 | public function getPastaXmlInutilizado($ambiente = null) |
|
| 187 | |||
| 188 | /** |
||
| 189 | * @param string $pasta_xml_inutilizado |
||
| 190 | * @return self |
||
| 191 | */ |
||
| 192 | 102 | public function setPastaXmlInutilizado($pasta_xml_inutilizado) |
|
| 197 | |||
| 198 | /** |
||
| 199 | * Pasta onde ficam os XML das notas após serem aceitas e depois canceladas |
||
| 200 | * @param string $ambiente |
||
| 201 | * @return string |
||
| 202 | */ |
||
| 203 | 2 | public function getPastaXmlCancelado($ambiente = null) |
|
| 210 | |||
| 211 | /** |
||
| 212 | * @param string $pasta_xml_cancelado |
||
| 213 | * @return self |
||
| 214 | */ |
||
| 215 | 102 | public function setPastaXmlCancelado($pasta_xml_cancelado) |
|
| 220 | |||
| 221 | /** |
||
| 222 | * Pasta onde ficam os XML das notas pendentes de consulta |
||
| 223 | * @param string $ambiente |
||
| 224 | * @return string |
||
| 225 | */ |
||
| 226 | 4 | public function getPastaXmlPendente($ambiente = null) |
|
| 233 | |||
| 234 | /** |
||
| 235 | * @param string $pasta_xml_pendente |
||
| 236 | * @return self |
||
| 237 | */ |
||
| 238 | 102 | public function setPastaXmlPendente($pasta_xml_pendente) |
|
| 243 | |||
| 244 | /** |
||
| 245 | * Pasta onde ficam os XMLs após enviados e denegados |
||
| 246 | * @param string $ambiente |
||
| 247 | * @return string |
||
| 248 | */ |
||
| 249 | 2 | public function getPastaXmlDenegado($ambiente = null) |
|
| 256 | |||
| 257 | /** |
||
| 258 | * @param string $pasta_xml_denegado |
||
| 259 | * @return self |
||
| 260 | */ |
||
| 261 | 102 | public function setPastaXmlDenegado($pasta_xml_denegado) |
|
| 266 | |||
| 267 | /** |
||
| 268 | * Pasta onde ficam os XML das notas após serem enviadas e rejeitadas |
||
| 269 | * @param string $ambiente |
||
| 270 | * @return string |
||
| 271 | */ |
||
| 272 | 4 | public function getPastaXmlRejeitado($ambiente = null) |
|
| 279 | |||
| 280 | /** |
||
| 281 | * @param string $pasta_xml_rejeitado |
||
| 282 | * @return self |
||
| 283 | */ |
||
| 284 | 102 | public function setPastaXmlRejeitado($pasta_xml_rejeitado) |
|
| 289 | |||
| 290 | /** |
||
| 291 | * Pasta onde ficam os XML das notas após serem enviados e aceitos pela |
||
| 292 | * @param string $ambiente |
||
| 293 | * @return string |
||
| 294 | * SEFAZ |
||
| 295 | */ |
||
| 296 | 3 | public function getPastaXmlAutorizado($ambiente = null) |
|
| 303 | |||
| 304 | /** |
||
| 305 | * @param string $pasta_xml_autorizado |
||
| 306 | * @return self |
||
| 307 | */ |
||
| 308 | 102 | public function setPastaXmlAutorizado($pasta_xml_autorizado) |
|
| 313 | |||
| 314 | /** |
||
| 315 | * Pasta onde ficam os XML das notas em processamento de retorno de |
||
| 316 | * @param string $ambiente |
||
| 317 | * @return string |
||
| 318 | * autorização |
||
| 319 | */ |
||
| 320 | 4 | public function getPastaXmlProcessamento($ambiente = null) |
|
| 327 | |||
| 328 | /** |
||
| 329 | * @param string $pasta_xml_processamento |
||
| 330 | * @return self |
||
| 331 | */ |
||
| 332 | 102 | public function setPastaXmlProcessamento($pasta_xml_processamento) |
|
| 337 | |||
| 338 | /** |
||
| 339 | * Pasta onde ficam os XMLs após assinado e antes de serem enviados |
||
| 340 | * @param string $ambiente |
||
| 341 | * @return string |
||
| 342 | */ |
||
| 343 | 4 | public function getPastaXmlAssinado($ambiente = null) |
|
| 350 | |||
| 351 | /** |
||
| 352 | * @param string $pasta_xml_assinado |
||
| 353 | * @return self |
||
| 354 | */ |
||
| 355 | 102 | public function setPastaXmlAssinado($pasta_xml_assinado) |
|
| 360 | |||
| 361 | /** |
||
| 362 | * Chamado quando o XML da nota foi gerado, |
||
| 363 | * aqui pode ser atualizado a chave da nota, data de emissão, além do estado da nota |
||
| 364 | * O registro da nota pode ser encontrada pela chave ou pelo código |
||
| 365 | * @param \NFe\Core\Nota $nota |
||
| 366 | * @param \DOMDocument $xml |
||
| 367 | */ |
||
| 368 | 2 | public function onNotaGerada($nota, $xml) |
|
| 371 | |||
| 372 | /** |
||
| 373 | * Chamado após o XML da nota ser assinado |
||
| 374 | * @param \NFe\Core\Nota $nota |
||
| 375 | * @param \DOMDocument $xml |
||
| 376 | */ |
||
| 377 | 2 | public function onNotaAssinada($nota, $xml) |
|
| 380 | |||
| 381 | /** |
||
| 382 | * Chamado após o XML da nota ser validado com sucesso |
||
| 383 | * Nesse ponto pode ser salvo o QR Code, URL de consulta, tributos e complementos da nota |
||
| 384 | * além de atualizar o estado da nota para assinado |
||
| 385 | * @param \NFe\Core\Nota $nota |
||
| 386 | * @param \DOMDocument $xml |
||
| 387 | */ |
||
| 388 | 2 | public function onNotaValidada($nota, $xml) |
|
| 395 | |||
| 396 | /** |
||
| 397 | * Chamado antes de enviar a nota para a SEFAZ |
||
| 398 | * @param \NFe\Core\Nota $nota |
||
| 399 | * @param \DOMDocument $xml |
||
| 400 | */ |
||
| 401 | 2 | public function onNotaEnviando($nota, $xml) |
|
| 404 | |||
| 405 | /** |
||
| 406 | * Chamado quando a forma de emissão da nota fiscal muda para contingência |
||
| 407 | * Atualizar no banco flag de contingência informando a data de contingência e motivo |
||
| 408 | * @param \NFe\Core\Nota $nota |
||
| 409 | * @param bool $offline |
||
| 410 | * @param \Exception $exception |
||
| 411 | */ |
||
| 412 | 1 | public function onNotaContingencia($nota, $offline, $exception) |
|
| 416 | |||
| 417 | /** |
||
| 418 | * Chamado quando a nota foi enviada e aceita pela SEFAZ |
||
| 419 | * Além de salvar o XML, a data de autorização, protocolo e estado devem ser salvos no banco |
||
| 420 | * Nesse ponto essa nota deve ser marcada como concluída no banco de dados |
||
| 421 | * Atenção: se a ação dessa nota for para cancelar, não troque a flag de conclusão |
||
| 422 | * @param \NFe\Core\Nota $nota |
||
| 423 | * @param \DOMDocument $xml |
||
| 424 | * @param \NFe\Task\Retorno $retorno |
||
| 425 | */ |
||
| 426 | 1 | public function onNotaAutorizada($nota, $xml, $retorno) |
|
| 433 | |||
| 434 | /** |
||
| 435 | * Chamado quando a emissão da nota foi concluída com sucesso independente |
||
| 436 | * da forma de emissão |
||
| 437 | * @param \NFe\Core\Nota $nota |
||
| 438 | * @param \DOMDocument $xml |
||
| 439 | */ |
||
| 440 | 2 | public function onNotaCompleto($nota, $xml) |
|
| 443 | |||
| 444 | /** |
||
| 445 | * Chamado quando uma nota é rejeitada pela SEFAZ, a nota deve ser |
||
| 446 | * corrigida para depois ser enviada novamente |
||
| 447 | * Se a ação da nota for cancelar, deve-se mudar a ação para inutilizar se for rejeição de nota inexistente |
||
| 448 | * Caso contrário, deve marcar a flag para corrigir a nota antes de enviar novamente |
||
| 449 | * Além de marcar o estado como rejeitado |
||
| 450 | * @param \NFe\Core\Nota $nota |
||
| 451 | * @param \DOMDocument $xml |
||
| 452 | * @param \NFe\Task\Retorno $retorno |
||
| 453 | */ |
||
| 454 | public function onNotaRejeitada($nota, $xml, $retorno) |
||
| 461 | |||
| 462 | /** |
||
| 463 | * Chamado quando a nota é denegada e não pode ser utilizada (outra nota |
||
| 464 | * deve ser gerada) |
||
| 465 | * Atualizar o estado da nota e marcar como concluída mas não corrigida |
||
| 466 | * @param \NFe\Core\Nota $nota |
||
| 467 | * @param \DOMDocument $xml |
||
| 468 | * @param \NFe\Task\Retorno $retorno |
||
| 469 | */ |
||
| 470 | public function onNotaDenegada($nota, $xml, $retorno) |
||
| 477 | |||
| 478 | /** |
||
| 479 | * Chamado após tentar enviar uma nota e não ter certeza se ela foi |
||
| 480 | * recebida ou não (problemas técnicos), deverá ser feito uma consulta pela |
||
| 481 | * chave para obter o estado da nota, |
||
| 482 | * Aqui deve ser cancelada a nota incerta e gerar outra em contingência |
||
| 483 | * Atenção: Nota em contingência pode ficar pendente também, nesse caso não se deve criar outra nota |
||
| 484 | * Atualizar a nota incerta mudando a ação para cancelar e status para pendente |
||
| 485 | * Criar outra nota baseado na nota incerta incrementando sua numeração para uma disponível |
||
| 486 | * Atualizar o número da $nota e seu ID com a função gerarID, salvar também a chave na nova nota |
||
| 487 | * @param \NFe\Core\Nota $nota |
||
| 488 | * @param \DOMDocument $xml |
||
| 489 | * @param \Exception $exception |
||
| 490 | */ |
||
| 491 | 1 | public function onNotaPendente($nota, $xml, $exception) |
|
| 498 | |||
| 499 | /** |
||
| 500 | * Chamado quando uma nota é enviada, mas não retornou o protocolo que será |
||
| 501 | * consultado mais tarde |
||
| 502 | * Salvar o recibo na nota para consultar mais tarde além atualizar o status |
||
| 503 | * @param \NFe\Core\Nota $nota |
||
| 504 | * @param \DOMDocument $xml |
||
| 505 | * @param \NFe\Task\Retorno $retorno |
||
| 506 | */ |
||
| 507 | public function onNotaProcessando($nota, $xml, $retorno) |
||
| 514 | |||
| 515 | /** |
||
| 516 | * Chamado quando uma nota autorizada é cancelada na SEFAZ |
||
| 517 | * Atualizar o protocolo do retorno, estado e flag de conclusão da nota |
||
| 518 | * @param \NFe\Core\Nota $nota |
||
| 519 | * @param \DOMDocument $xml |
||
| 520 | * @param \NFe\Task\Retorno $retorno |
||
| 521 | */ |
||
| 522 | public function onNotaCancelada($nota, $xml, $retorno) |
||
| 529 | |||
| 530 | /** |
||
| 531 | * Chamado quando ocorre um erro nas etapas de geração e envio da nota (Não |
||
| 532 | * é chamado quando entra em contigência) |
||
| 533 | * Alterar a flag para corrigir a nota se não for problema de rede |
||
| 534 | * @param \NFe\Core\Nota $nota |
||
| 535 | * @param \Exception $exception |
||
| 536 | */ |
||
| 537 | public function onNotaErro($nota, $exception) |
||
| 540 | |||
| 541 | /** |
||
| 542 | * Chamado quando um ou mais números de notas forem inutilizados |
||
| 543 | * @param \NFe\Task\Inutilizacao $inutilizacao |
||
| 544 | * @param \DOMDocument $xml |
||
| 545 | */ |
||
| 546 | 1 | public function onInutilizado($inutilizacao, $xml) |
|
| 552 | |||
| 553 | /** |
||
| 554 | * Chamado quando uma tarefa é executada com sucesso |
||
| 555 | * @param \NFe\Task\Tarefa $tarefa |
||
| 556 | * @param \NFe\Task\Retorno $retorno |
||
| 557 | */ |
||
| 558 | 1 | public function onTarefaExecutada($tarefa, $retorno) |
|
| 579 | |||
| 580 | /** |
||
| 581 | * Chamado quando ocorre uma falha na execução de uma tarefa |
||
| 582 | * Altera a flag de correção da nota para evitar ficar enviando a nota a todo momento |
||
| 583 | * Atenção: Não alterar a flag de correção se o erro da tarefa for causado por problema de rede |
||
| 584 | * @param \NFe\Task\Tarefa $tarefa |
||
| 585 | * @param \Exception $exception |
||
| 586 | */ |
||
| 587 | 1 | public function onTarefaErro($tarefa, $exception) |
|
| 590 | |||
| 591 | /** |
||
| 592 | * @param bool $recursive |
||
| 593 | * @return array |
||
| 594 | */ |
||
| 595 | 2 | public function toArray($recursive = false) |
|
| 609 | |||
| 610 | /** |
||
| 611 | * @param mixed $ajuste array ou instância |
||
| 612 | * @return self |
||
| 613 | */ |
||
| 614 | 102 | public function fromArray($ajuste = []) |
|
| 669 | } |
||
| 670 |
Loading history...
The class complexity is the sum of the complexity of all methods. A very high value is usually an indication that your class does not follow the single reponsibility principle and does more than one job.
Some resources for further reading:
You can also find more detailed suggestions for refactoring in the “Code” section of your repository.