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 | 21 | public function __construct($envio = array()) |
|
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 | 20 | 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 | 21 | 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 | 20 | public function getAmbiente($normalize = false) |
|
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 | 21 | public function setAmbiente($ambiente) |
|
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 | 20 | public function getModelo($normalize = false) |
|
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 | 21 | public function setModelo($modelo) |
|
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 | 20 | public function getEmissao($normalize = false) |
|
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 | 21 | public function setEmissao($emissao) |
|
233 | |||
234 | /** |
||
235 | * Conteudo a ser enviado |
||
236 | * @return mixed conteudo do Envio |
||
237 | */ |
||
238 | 18 | 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 | 21 | 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 | 17 | 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 | 20 | private function getServiceInfo() |
|
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 | 21 | public function fromArray($envio = array()) |
|
343 | |||
344 | /** |
||
345 | * Obtém o nó do cabeçalho da requisição SOAP |
||
346 | * @return DOMDocument Cabeçalho para adicionar na requisição |
||
347 | */ |
||
348 | 17 | private function getNodeHeader() |
|
361 | |||
362 | /** |
||
363 | * Cria um nó XML do envio de acordo com o leiaute da NFe |
||
364 | * @param string $name Nome do nó que será criado |
||
365 | * @return DOMElement Nó que contém todos os campos da classe |
||
366 | */ |
||
367 | 17 | public function getNode($name = null) |
|
390 | |||
391 | /** |
||
392 | * Envia o conteúdo para o serviço da SEFAZ informado |
||
393 | * @return DOMDocument Documento XML da resposta da SEFAZ |
||
394 | */ |
||
395 | 18 | public function envia() |
|
420 | } |
||
421 |
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.