Complex classes like Envio 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 Envio, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 39 | class Envio |
||
|
|
|||
| 40 | { |
||
| 41 | |||
| 42 | /** |
||
| 43 | * Tipo de serviço a ser executado |
||
| 44 | */ |
||
| 45 | const SERVICO_INUTILIZACAO = 'inutilizacao'; |
||
| 46 | const SERVICO_PROTOCOLO = 'protocolo'; |
||
| 47 | const SERVICO_STATUS = 'status'; |
||
| 48 | const SERVICO_CADASTRO = 'cadastro'; |
||
| 49 | const SERVICO_AUTORIZACAO = 'autorizacao'; |
||
| 50 | const SERVICO_RETORNO = 'retorno'; |
||
| 51 | const SERVICO_RECEPCAO = 'recepcao'; |
||
| 52 | const SERVICO_CONFIRMACAO = 'confirmacao'; |
||
| 53 | const SERVICO_EVENTO = 'evento'; |
||
| 54 | const SERVICO_DESTINADAS = 'destinadas'; |
||
| 55 | const SERVICO_DOWNLOAD = 'download'; |
||
| 56 | const SERVICO_DISTRIBUICAO = 'distribuicao'; |
||
| 57 | |||
| 58 | /** |
||
| 59 | * Tipo de serviço a ser executado |
||
| 60 | */ |
||
| 61 | private $servico; |
||
| 62 | /** |
||
| 63 | * Identificação do Ambiente: |
||
| 64 | * 1 - Produção |
||
| 65 | * 2 - Homologação |
||
| 66 | */ |
||
| 67 | private $ambiente; |
||
| 68 | /** |
||
| 69 | * Código do modelo do Documento Fiscal. 55 = NF-e; 65 = NFC-e. |
||
| 70 | */ |
||
| 71 | private $modelo; |
||
| 72 | /** |
||
| 73 | * Forma de emissão da NF-e |
||
| 74 | */ |
||
| 75 | private $emissao; |
||
| 76 | /** |
||
| 77 | * Conteudo a ser enviado |
||
| 78 | */ |
||
| 79 | private $conteudo; |
||
| 80 | |||
| 81 | /** |
||
| 82 | * Constroi uma instância de Envio vazia |
||
| 83 | * @param array $envio Array contendo dados do Envio |
||
| 84 | */ |
||
| 85 | 10 | public function __construct($envio = []) |
|
| 89 | |||
| 90 | /** |
||
| 91 | * Tipo de serviço a ser executado |
||
| 92 | * @param boolean $normalize informa se o servico deve estar no formato do XML |
||
| 93 | * @return mixed servico do Envio |
||
| 94 | */ |
||
| 95 | 8 | public function getServico($normalize = false) |
|
| 106 | |||
| 107 | /** |
||
| 108 | * Altera o valor do Servico para o informado no parâmetro |
||
| 109 | * @param mixed $servico novo valor para Servico |
||
| 110 | * @return Envio A própria instância da classe |
||
| 111 | */ |
||
| 112 | 10 | public function setServico($servico) |
|
| 117 | |||
| 118 | /** |
||
| 119 | * Identificação do Ambiente: |
||
| 120 | * 1 - Produção |
||
| 121 | * 2 - Homologação |
||
| 122 | * @param boolean $normalize informa se o ambiente deve estar no formato do XML |
||
| 123 | * @return mixed ambiente do Envio |
||
| 124 | */ |
||
| 125 | 9 | public function getAmbiente($normalize = false) |
|
| 126 | { |
||
| 127 | 9 | if (!$normalize) { |
|
| 128 | 9 | return $this->ambiente; |
|
| 129 | } |
||
| 130 | 1 | switch ($this->ambiente) { |
|
| 131 | 1 | case Nota::AMBIENTE_PRODUCAO: |
|
| 132 | 1 | return '1'; |
|
| 133 | 1 | case Nota::AMBIENTE_HOMOLOGACAO: |
|
| 134 | 1 | return '2'; |
|
| 135 | } |
||
| 136 | 1 | return $this->ambiente; |
|
| 137 | } |
||
| 138 | |||
| 139 | /** |
||
| 140 | * Altera o valor do Ambiente para o informado no parâmetro |
||
| 141 | * @param mixed $ambiente novo valor para Ambiente |
||
| 142 | * @return Envio A própria instância da classe |
||
| 143 | */ |
||
| 144 | 10 | public function setAmbiente($ambiente) |
|
| 145 | { |
||
| 146 | switch ($ambiente) { |
||
| 147 | 10 | case '1': |
|
| 148 | 1 | $ambiente = Nota::AMBIENTE_PRODUCAO; |
|
| 149 | 1 | break; |
|
| 150 | 10 | case '2': |
|
| 151 | 1 | $ambiente = Nota::AMBIENTE_HOMOLOGACAO; |
|
| 152 | 1 | break; |
|
| 153 | } |
||
| 154 | 10 | $this->ambiente = $ambiente; |
|
| 155 | 10 | return $this; |
|
| 156 | } |
||
| 157 | |||
| 158 | /** |
||
| 159 | * Código do modelo do Documento Fiscal. 55 = NF-e; 65 = NFC-e. |
||
| 160 | * @param boolean $normalize informa se o modelo deve estar no formato do XML |
||
| 161 | * @return mixed modelo do Envio |
||
| 162 | */ |
||
| 163 | 9 | public function getModelo($normalize = false) |
|
| 164 | { |
||
| 165 | 9 | if (!$normalize) { |
|
| 166 | 9 | return $this->modelo; |
|
| 167 | } |
||
| 168 | 1 | switch ($this->modelo) { |
|
| 169 | 1 | case Nota::MODELO_NFE: |
|
| 170 | 1 | return '55'; |
|
| 171 | 1 | case Nota::MODELO_NFCE: |
|
| 172 | 1 | return '65'; |
|
| 173 | } |
||
| 174 | 1 | return $this->modelo; |
|
| 175 | } |
||
| 176 | |||
| 177 | /** |
||
| 178 | * Altera o valor do Modelo para o informado no parâmetro |
||
| 179 | * @param mixed $modelo novo valor para Modelo |
||
| 180 | * @return Envio A própria instância da classe |
||
| 181 | */ |
||
| 182 | 10 | public function setModelo($modelo) |
|
| 183 | { |
||
| 184 | switch ($modelo) { |
||
| 185 | 10 | case '55': |
|
| 186 | 1 | $modelo = Nota::MODELO_NFE; |
|
| 187 | 1 | break; |
|
| 188 | 10 | case '65': |
|
| 189 | 1 | $modelo = Nota::MODELO_NFCE; |
|
| 190 | 1 | break; |
|
| 191 | } |
||
| 192 | 10 | $this->modelo = $modelo; |
|
| 193 | 10 | return $this; |
|
| 194 | } |
||
| 195 | |||
| 196 | /** |
||
| 197 | * Forma de emissão da NF-e |
||
| 198 | * @param boolean $normalize informa se o emissao deve estar no formato do XML |
||
| 199 | * @return mixed emissao do Envio |
||
| 200 | */ |
||
| 201 | 9 | public function getEmissao($normalize = false) |
|
| 202 | { |
||
| 203 | 9 | if (!$normalize) { |
|
| 204 | 9 | return $this->emissao; |
|
| 205 | } |
||
| 206 | 1 | switch ($this->emissao) { |
|
| 207 | 1 | case Nota::EMISSAO_NORMAL: |
|
| 208 | 1 | return '1'; |
|
| 209 | 1 | case Nota::EMISSAO_CONTINGENCIA: |
|
| 210 | 1 | return '9'; |
|
| 211 | } |
||
| 212 | 1 | return $this->emissao; |
|
| 213 | } |
||
| 214 | |||
| 215 | /** |
||
| 216 | * Altera o valor do Emissao para o informado no parâmetro |
||
| 217 | * @param mixed $emissao novo valor para Emissao |
||
| 218 | * @return Envio A própria instância da classe |
||
| 219 | */ |
||
| 220 | 10 | public function setEmissao($emissao) |
|
| 221 | { |
||
| 222 | switch ($emissao) { |
||
| 223 | 10 | case '1': |
|
| 224 | 1 | $emissao = Nota::EMISSAO_NORMAL; |
|
| 225 | 1 | break; |
|
| 226 | 10 | case '9': |
|
| 227 | 1 | $emissao = Nota::EMISSAO_CONTINGENCIA; |
|
| 228 | 1 | break; |
|
| 229 | } |
||
| 230 | 10 | $this->emissao = $emissao; |
|
| 231 | 10 | return $this; |
|
| 232 | } |
||
| 233 | |||
| 234 | /** |
||
| 235 | * Conteudo a ser enviado |
||
| 236 | * @return mixed conteudo do Envio |
||
| 237 | */ |
||
| 238 | 5 | public function getConteudo() |
|
| 242 | |||
| 243 | /** |
||
| 244 | * Altera o valor do Conteudo para o informado no parâmetro |
||
| 245 | * @param mixed $conteudo novo valor para Conteudo |
||
| 246 | * @return Envio A própria instância da classe |
||
| 247 | */ |
||
| 248 | 10 | public function setConteudo($conteudo) |
|
| 253 | |||
| 254 | /** |
||
| 255 | * Obtém a versão do serviço a ser utilizado |
||
| 256 | * @return string Versão do serviço |
||
| 257 | */ |
||
| 258 | 4 | public function getVersao() |
|
| 266 | |||
| 267 | /** |
||
| 268 | * Devolve um array com as informações de serviço (URL, Versão, Serviço) |
||
| 269 | * @return array Informações de serviço |
||
| 270 | */ |
||
| 271 | 8 | private function getServiceInfo() |
|
| 272 | { |
||
| 273 | 8 | $config = SEFAZ::getInstance()->getConfiguracao(); |
|
| 274 | 8 | $db = $config->getBanco(); |
|
| 275 | 8 | $estado = $config->getEmitente()->getEndereco()->getMunicipio()->getEstado(); |
|
| 276 | 8 | $info = $db->getInformacaoServico( |
|
| 277 | 8 | $this->getEmissao(), |
|
| 278 | 8 | $estado->getUF(), |
|
| 279 | 8 | $this->getModelo(), |
|
| 280 | 8 | $this->getAmbiente() |
|
| 281 | ); |
||
| 282 | 8 | if (!isset($info[$this->getServico()])) { |
|
| 283 | 1 | throw new \Exception('O serviço "'.$this->getServico(). |
|
| 284 | 1 | '" não está disponível para o estado "'.$estado->getUF().'"', 404); |
|
| 285 | } |
||
| 286 | 7 | return $info[$this->getServico()]; |
|
| 287 | } |
||
| 288 | |||
| 289 | /** |
||
| 290 | * Converte a instância da classe para um array de campos com valores |
||
| 291 | * @return array Array contendo todos os campos e valores da instância |
||
| 292 | */ |
||
| 293 | 1 | public function toArray($recursive = false) |
|
| 303 | |||
| 304 | /** |
||
| 305 | * Atribui os valores do array para a instância atual |
||
| 306 | * @param mixed $envio Array ou instância de Envio, para copiar os valores |
||
| 307 | * @return Envio A própria instância da classe |
||
| 308 | */ |
||
| 309 | 10 | public function fromArray($envio = []) |
|
| 343 | |||
| 344 | /** |
||
| 345 | * Cria um nó XML do envio de acordo com o leiaute da NFe |
||
| 346 | * @param string $name Nome do nó que será criado |
||
| 347 | * @return DOMElement Nó que contém todos os campos da classe |
||
| 348 | */ |
||
| 349 | 4 | public function getNode($name = null) |
|
| 372 | |||
| 373 | /** |
||
| 374 | * Envia o conteúdo para o serviço da SEFAZ informado |
||
| 375 | * @return DOMDocument Documento XML da resposta da SEFAZ |
||
| 376 | */ |
||
| 377 | 5 | public function envia() |
|
| 402 | } |
||
| 403 |
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.