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 | 1 | 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 | public function getServico($normalize = false) |
||
132 | |||
133 | /** |
||
134 | 1 | * Altera o valor do Servico para o informado no parâmetro |
|
135 | * @param mixed $servico novo valor para Servico |
||
136 | 1 | * @return Envio A própria instância da classe |
|
137 | 1 | */ |
|
138 | public function setServico($servico) |
||
143 | |||
144 | /** |
||
145 | * Identificação do Ambiente: |
||
146 | * 1 - Produção |
||
147 | * 2 - Homologação |
||
148 | * @param boolean $normalize informa se o ambiente deve estar no formato do XML |
||
149 | * @return mixed ambiente do Envio |
||
150 | */ |
||
151 | public function getAmbiente($normalize = false) |
||
164 | |||
165 | /** |
||
166 | 1 | * Altera o valor do Ambiente para o informado no parâmetro |
|
167 | * @param mixed $ambiente novo valor para Ambiente |
||
168 | * @return Envio A própria instância da classe |
||
169 | 1 | */ |
|
170 | public function setAmbiente($ambiente) |
||
183 | |||
184 | /** |
||
185 | * Código do modelo do Documento Fiscal. 55 = NF-e; 65 = NFC-e. |
||
186 | * @param boolean $normalize informa se o modelo deve estar no formato do XML |
||
187 | * @return mixed modelo do Envio |
||
188 | */ |
||
189 | public function getModelo($normalize = false) |
||
202 | |||
203 | /** |
||
204 | 1 | * Altera o valor do Modelo para o informado no parâmetro |
|
205 | * @param mixed $modelo novo valor para Modelo |
||
206 | * @return Envio A própria instância da classe |
||
207 | 1 | */ |
|
208 | public function setModelo($modelo) |
||
221 | |||
222 | /** |
||
223 | * Forma de emissão da NF-e |
||
224 | * @param boolean $normalize informa se o emissao deve estar no formato do XML |
||
225 | * @return mixed emissao do Envio |
||
226 | */ |
||
227 | public function getEmissao($normalize = false) |
||
240 | |||
241 | /** |
||
242 | 1 | * Altera o valor do Emissao para o informado no parâmetro |
|
243 | * @param mixed $emissao novo valor para Emissao |
||
244 | * @return Envio A própria instância da classe |
||
245 | 1 | */ |
|
246 | public function setEmissao($emissao) |
||
259 | |||
260 | /** |
||
261 | * Conteudo a ser enviado |
||
262 | * @return mixed conteudo do Envio |
||
263 | */ |
||
264 | public function getConteudo() |
||
268 | |||
269 | /** |
||
270 | 1 | * Altera o valor do Conteudo para o informado no parâmetro |
|
271 | * @param mixed $conteudo novo valor para Conteudo |
||
272 | 1 | * @return Envio A própria instância da classe |
|
273 | 1 | */ |
|
274 | public function setConteudo($conteudo) |
||
279 | |||
280 | /** |
||
281 | * Obtém a versão do serviço a ser utilizado |
||
282 | * @return string Versão do serviço |
||
283 | */ |
||
284 | public function getVersao() |
||
292 | |||
293 | /** |
||
294 | * Devolve um array com as informações de serviço (URL, Versão, Serviço) |
||
295 | * @return array Informações de serviço |
||
296 | */ |
||
297 | private function getServiceInfo() |
||
314 | |||
315 | /** |
||
316 | * Converte a instância da classe para um array de campos com valores |
||
317 | * @return array Array contendo todos os campos e valores da instância |
||
318 | */ |
||
319 | public function toArray($recursive = false) |
||
329 | 1 | ||
330 | /** |
||
331 | * Atribui os valores do array para a instância atual |
||
332 | 1 | * @param mixed $envio Array ou instância de Envio, para copiar os valores |
|
333 | * @return Envio A própria instância da classe |
||
334 | 1 | */ |
|
335 | public function fromArray($envio = array()) |
||
369 | |||
370 | /** |
||
371 | * Obtém o nó do cabeçalho da requisição SOAP |
||
372 | * @return DOMDocument Cabeçalho para adicionar na requisição |
||
373 | */ |
||
374 | private function getNodeHeader() |
||
387 | |||
388 | /** |
||
389 | * Cria um nó XML do envio de acordo com o leiaute da NFe |
||
390 | * @param string $name Nome do nó que será criado |
||
391 | * @return DOMElement Nó que contém todos os campos da classe |
||
392 | */ |
||
393 | public function getNode($name = null) |
||
416 | |||
417 | /** |
||
418 | * Envia o conteúdo para o serviço da SEFAZ informado |
||
419 | * @return DOMDocument Documento XML da resposta da SEFAZ |
||
420 | */ |
||
421 | public function envia() |
||
446 | } |
||
447 |
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.