nfephp-org /
sped-common
Complex classes like DOMImproved 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 DOMImproved, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 21 | class DOMImproved extends DOMDocument |
||
| 22 | { |
||
| 23 | /** |
||
| 24 | * @var array |
||
| 25 | */ |
||
| 26 | public $errors = []; |
||
| 27 | |||
| 28 | /** |
||
| 29 | * @param string $version |
||
| 30 | * @param string $charset |
||
| 31 | */ |
||
| 32 | 1 | public function __construct($version = '1.0', $charset = 'utf-8') |
|
| 38 | |||
| 39 | /** |
||
| 40 | * Insert node AFTER reference node |
||
| 41 | * @param \DOMNode $newNode |
||
| 42 | * @param \DOMNode $referenceNode |
||
| 43 | * @return \DOMNode |
||
| 44 | */ |
||
| 45 | public function insertAfter(\DOMNode $newNode, \DOMNode $referenceNode) |
||
| 53 | |||
| 54 | /** |
||
| 55 | * Loads string in DOMDocument |
||
| 56 | * @param string $content content of xml |
||
| 57 | * @return bool |
||
| 58 | */ |
||
| 59 | public function loadXMLString($content) |
||
| 70 | |||
| 71 | /** |
||
| 72 | * Load xml from path |
||
| 73 | * @param string $filename |
||
| 74 | * @return bool |
||
| 75 | */ |
||
| 76 | public function loadXMLFile($filename) |
||
| 85 | |||
| 86 | /** |
||
| 87 | * Extrai o valor do node DOM |
||
| 88 | * @param string $nodeName identificador da TAG do xml |
||
| 89 | * @param int $itemNum numero do item a ser retornado |
||
| 90 | * @param string $extraTextBefore prefixo do retorno |
||
| 91 | * @param string $extraTextAfter sufixo do retorno |
||
| 92 | * @return string |
||
| 93 | */ |
||
| 94 | public function getNodeValue($nodeName, $itemNum = 0, $extraTextBefore = '', $extraTextAfter = '') |
||
| 103 | |||
| 104 | /** |
||
| 105 | * getValue |
||
| 106 | * @param DOMElement $node |
||
| 107 | * @param string $name |
||
| 108 | * @return string |
||
| 109 | */ |
||
| 110 | public function getValue(DOMElement $node, $name) |
||
| 119 | |||
| 120 | /** |
||
| 121 | * getNode |
||
| 122 | * Retorna o node solicitado |
||
| 123 | * @param string $nodeName |
||
| 124 | * @param integer $itemNum |
||
| 125 | * @return DOMElement | string |
||
| 126 | */ |
||
| 127 | public function getNode($nodeName, $itemNum = 0) |
||
| 135 | |||
| 136 | /** |
||
| 137 | * getChave |
||
| 138 | * @param string $nodeName |
||
| 139 | * @return string |
||
| 140 | */ |
||
| 141 | public function getChave($nodeName = 'infNFe') |
||
| 151 | |||
| 152 | /** |
||
| 153 | * addChild |
||
| 154 | * Adiciona um elemento ao node xml passado como referencia |
||
| 155 | * Serão inclusos erros na array $erros[] sempre que a tag for obrigatória e |
||
| 156 | * nenhum parâmetro for passado na variável $content e $force for false |
||
| 157 | * @param \DOMElement $parent |
||
| 158 | * @param string|null $name |
||
| 159 | * @param string|float|null $content |
||
| 160 | * @param boolean $obrigatorio |
||
| 161 | * @param string $descricao |
||
| 162 | * @param boolean $force força a criação do elemento mesmo sem dados e não considera como erro |
||
| 163 | * @return void |
||
| 164 | */ |
||
| 165 | public function addChild( |
||
| 190 | |||
| 191 | /** |
||
| 192 | * Acrescenta DOMElement a pai DOMElement |
||
| 193 | * Caso o pai esteja vazio retorna uma exception com a mensagem |
||
| 194 | * O parametro "child" pode ser null |
||
| 195 | * @param DOMElement $parent |
||
| 196 | * @param DOMElement|null $child |
||
| 197 | * @param string $msg |
||
| 198 | * @return void |
||
| 199 | */ |
||
| 200 | public function appChild(DOMElement &$parent, DOMElement $child = null, $msg = '') |
||
| 201 | { |
||
| 202 | if (empty($child)) { |
||
| 203 | //$this->errors[] = $msg; |
||
| 204 | return; |
||
| 205 | } |
||
| 206 | $parent->appendChild($child); |
||
| 207 | } |
||
| 208 | |||
| 209 | /** |
||
| 210 | * Append DOMElement from external documento to local Node |
||
| 211 | * @param \DOMElement $parent |
||
| 212 | * @param \DOMElement $child |
||
| 213 | * @return void |
||
| 214 | */ |
||
| 215 | public function appExternalChild(DOMElement &$parent, DOMElement $child) |
||
| 220 | |||
| 221 | /** |
||
| 222 | * Append DOMElement from external documento to local Node |
||
| 223 | * before existent node |
||
| 224 | * @param \DOMElement $parent |
||
| 225 | * @param \DOMElement $child |
||
| 226 | * @param string $before |
||
| 227 | * @return void |
||
| 228 | */ |
||
| 229 | public function appExternalChildBefore( |
||
| 240 | |||
| 241 | /** |
||
| 242 | * appChildBefore |
||
| 243 | * Acrescenta DOMElement a pai DOMElement |
||
| 244 | * Caso o pai esteja vazio retorna uma exception com a mensagem |
||
| 245 | * O parametro "child" pode ser vazio |
||
| 246 | * @param \DOMElement $parent |
||
| 247 | * @param \DOMElement $child |
||
| 248 | * @param string $before |
||
| 249 | * @param string $msg |
||
| 250 | * @return void |
||
| 251 | */ |
||
| 252 | public function appChildBefore(DOMElement &$parent, DOMElement $child = null, $before = '', $msg = '') |
||
| 263 | |||
| 264 | /** |
||
| 265 | * addArrayChild |
||
| 266 | * Adiciona a um DOMElemt parent, outros elementos passados em um array de DOMElements |
||
| 267 | * @param \DOMElement $parent |
||
| 268 | * @param array $arr |
||
| 269 | * @return int |
||
| 270 | */ |
||
| 271 | public function addArrayChild(DOMElement &$parent, $arr) |
||
| 282 | } |
||
| 283 |
Loading history...
If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design.
Let’s take a look at an example:
Our function
my_functionexpects aPostobject, and outputs the author of the post. The base classPostreturns a simple string and outputting a simple string will work just fine. However, the child classBlogPostwhich is a sub-type ofPostinstead decided to return anobject, and is therefore violating the SOLID principles. If aBlogPostwere passed tomy_function, PHP would not complain, but ultimately fail when executing thestrtouppercall in its body.