libgraviton /
graviton
Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
Complex classes like DocumentMap 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 DocumentMap, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 17 | class DocumentMap |
||
| 18 | { |
||
| 19 | /** |
||
| 20 | * @var array |
||
| 21 | */ |
||
| 22 | private $mappings = []; |
||
| 23 | /** |
||
| 24 | * @var Document[] |
||
| 25 | */ |
||
| 26 | private $documents = []; |
||
| 27 | |||
| 28 | /** |
||
| 29 | * Constructor |
||
| 30 | * |
||
| 31 | * @param Finder $doctrineFinder Doctrine mapping finder |
||
| 32 | * @param Finder $serializerFinder Serializer mapping finder |
||
| 33 | * @param Finder $validationFinder Validation mapping finder |
||
| 34 | */ |
||
| 35 | 8 | public function __construct(Finder $doctrineFinder, Finder $serializerFinder, Finder $validationFinder) |
|
| 36 | { |
||
| 37 | 8 | $doctrineMap = $this->loadDoctrineClassMap($doctrineFinder); |
|
| 38 | 8 | $serializerMap = $this->loadSerializerClassMap($serializerFinder); |
|
| 39 | 8 | $validationMap = $this->loadValidationClassMap($validationFinder); |
|
| 40 | |||
| 41 | 8 | foreach ($doctrineMap as $className => $doctrineMapping) { |
|
| 42 | 8 | $this->mappings[$className] = [ |
|
| 43 | 8 | 'doctrine' => $doctrineMap[$className], |
|
| 44 | 8 | 'serializer' => isset($serializerMap[$className]) ? $serializerMap[$className] : null, |
|
| 45 | 8 | 'validation' => isset($validationMap[$className]) ? $validationMap[$className] : null, |
|
| 46 | ]; |
||
| 47 | } |
||
| 48 | 8 | } |
|
| 49 | |||
| 50 | /** |
||
| 51 | * Get document |
||
| 52 | * |
||
| 53 | * @param string $className Document class |
||
| 54 | * @return Document |
||
| 55 | */ |
||
| 56 | 8 | public function getDocument($className) |
|
| 57 | { |
||
| 58 | 8 | if (isset($this->documents[$className])) { |
|
| 59 | 8 | return $this->documents[$className]; |
|
| 60 | } |
||
| 61 | 8 | if (!isset($this->mappings[$className])) { |
|
| 62 | throw new \InvalidArgumentException(sprintf('No XML mapping found for document "%s"', $className)); |
||
| 63 | } |
||
| 64 | |||
| 65 | 8 | return $this->documents[$className] = $this->processDocument( |
|
| 66 | $className, |
||
| 67 | 8 | $this->mappings[$className]['doctrine'], |
|
| 68 | 8 | $this->mappings[$className]['serializer'], |
|
| 69 | 8 | $this->mappings[$className]['validation'] |
|
| 70 | ); |
||
| 71 | } |
||
| 72 | |||
| 73 | /** |
||
| 74 | * Get all documents |
||
| 75 | * |
||
| 76 | * @return Document[] |
||
| 77 | */ |
||
| 78 | 6 | public function getDocuments() |
|
| 82 | |||
| 83 | /** |
||
| 84 | * Process document |
||
| 85 | * |
||
| 86 | * @param string $className Class name |
||
| 87 | * @param \DOMElement $doctrineMapping Doctrine XML mapping |
||
| 88 | * @param \DOMElement $serializerMapping Serializer XML mapping |
||
| 89 | * @param \DOMElement $validationMapping Validation XML mapping |
||
| 90 | * @return Document |
||
| 91 | */ |
||
| 92 | 8 | private function processDocument( |
|
| 93 | $className, |
||
| 94 | \DOMElement $doctrineMapping, |
||
| 95 | \DOMElement $serializerMapping = null, |
||
| 96 | \DOMElement $validationMapping = null |
||
| 97 | ) { |
||
| 98 | 8 | if ($serializerMapping === null) { |
|
| 99 | 2 | $serializerFields = []; |
|
| 100 | } else { |
||
| 101 | 8 | $serializerFields = array_reduce( |
|
| 102 | 8 | $this->getSerializerFields($serializerMapping), |
|
| 103 | function (array $fields, array $field) { |
||
| 104 | 8 | $fields[$field['fieldName']] = $field; |
|
| 105 | 8 | return $fields; |
|
| 106 | 8 | }, |
|
| 107 | 8 | [] |
|
| 108 | ); |
||
| 109 | } |
||
| 110 | |||
| 111 | 8 | if ($validationMapping === null) { |
|
| 112 | 2 | $validationFields = []; |
|
| 113 | } else { |
||
| 114 | 8 | $validationFields = array_reduce( |
|
| 115 | 8 | $this->getValidationFields($validationMapping), |
|
| 116 | function (array $fields, array $field) { |
||
| 117 | 5 | $fields[$field['fieldName']] = $field; |
|
| 118 | 5 | return $fields; |
|
| 119 | 8 | }, |
|
| 120 | 8 | [] |
|
| 121 | ); |
||
| 122 | } |
||
| 123 | |||
| 124 | 8 | $fields = []; |
|
| 125 | 8 | foreach ($this->getDoctrineFields($doctrineMapping) as $doctrineField) { |
|
| 126 | 8 | $serializerField = isset($serializerFields[$doctrineField['name']]) ? |
|
| 127 | 8 | $serializerFields[$doctrineField['name']] : |
|
| 128 | 8 | null; |
|
| 129 | 8 | $validationField = isset($validationFields[$doctrineField['name']]) ? |
|
| 130 | 5 | $validationFields[$doctrineField['name']] : |
|
| 131 | 8 | null; |
|
| 132 | |||
| 133 | 8 | if ($doctrineField['type'] === 'collection') { |
|
| 134 | 2 | $fields[] = new ArrayField( |
|
| 135 | 2 | $serializerField === null ? 'array<string>' : $serializerField['fieldType'], |
|
| 136 | 2 | $doctrineField['name'], |
|
| 137 | 2 | $serializerField === null ? $doctrineField['name'] : $serializerField['exposedName'], |
|
| 138 | 2 | $serializerField === null ? false : $serializerField['readOnly'], |
|
| 139 | 2 | $validationField === null ? false : $validationField['required'], |
|
| 140 | 2 | $serializerField === null ? false : $serializerField['searchable'] |
|
|
|
|||
| 141 | ); |
||
| 142 | } else { |
||
| 143 | 8 | $fields[] = new Field( |
|
| 144 | 8 | $doctrineField['type'], |
|
| 145 | 8 | $doctrineField['name'], |
|
| 146 | 8 | $serializerField === null ? $doctrineField['name'] : $serializerField['exposedName'], |
|
| 147 | 8 | $serializerField === null ? false : $serializerField['readOnly'], |
|
| 148 | 8 | $validationField === null ? false : $validationField['required'], |
|
| 149 | 8 | $serializerField === null ? false : $serializerField['searchable'] |
|
| 150 | ); |
||
| 151 | } |
||
| 152 | } |
||
| 153 | 8 | foreach ($this->getDoctrineEmbedOneFields($doctrineMapping) as $doctrineField) { |
|
| 154 | 8 | $serializerField = isset($serializerFields[$doctrineField['name']]) ? |
|
| 155 | 8 | $serializerFields[$doctrineField['name']] : |
|
| 156 | 8 | null; |
|
| 157 | 8 | $validationField = isset($validationFields[$doctrineField['name']]) ? |
|
| 158 | 5 | $validationFields[$doctrineField['name']] : |
|
| 159 | 8 | null; |
|
| 160 | |||
| 161 | 8 | $fields[] = new EmbedOne( |
|
| 162 | 8 | $this->getDocument($doctrineField['type']), |
|
| 163 | 8 | $doctrineField['name'], |
|
| 164 | 8 | $serializerField === null ? $doctrineField['name'] : $serializerField['exposedName'], |
|
| 165 | 8 | $serializerField === null ? false : $serializerField['readOnly'], |
|
| 166 | 8 | $validationField === null ? false : $validationField['required'], |
|
| 167 | 8 | $serializerField === null ? false : $serializerField['searchable'] |
|
| 168 | ); |
||
| 169 | } |
||
| 170 | 8 | foreach ($this->getDoctrineEmbedManyFields($doctrineMapping) as $doctrineField) { |
|
| 171 | 8 | $serializerField = isset($serializerFields[$doctrineField['name']]) ? |
|
| 172 | 8 | $serializerFields[$doctrineField['name']] : |
|
| 173 | 8 | null; |
|
| 174 | 8 | $validationField = isset($validationFields[$doctrineField['name']]) ? |
|
| 175 | 2 | $validationFields[$doctrineField['name']] : |
|
| 176 | 8 | null; |
|
| 177 | |||
| 178 | 8 | $fields[] = new EmbedMany( |
|
| 179 | 8 | $this->getDocument($doctrineField['type']), |
|
| 180 | 8 | $doctrineField['name'], |
|
| 181 | 8 | $serializerField === null ? $doctrineField['name'] : $serializerField['exposedName'], |
|
| 182 | 8 | $serializerField === null ? false : $serializerField['readOnly'], |
|
| 183 | 8 | $validationField === null ? false : $validationField['required'] |
|
| 184 | ); |
||
| 185 | } |
||
| 186 | |||
| 187 | 8 | return new Document($className, $fields); |
|
| 188 | } |
||
| 189 | |||
| 190 | /** |
||
| 191 | * Load doctrine class map |
||
| 192 | * |
||
| 193 | * @param Finder $finder Mapping finder |
||
| 194 | * @return array |
||
| 195 | */ |
||
| 196 | 8 | View Code Duplication | private function loadDoctrineClassMap(Finder $finder) |
| 218 | |||
| 219 | /** |
||
| 220 | * Load serializer class map |
||
| 221 | * |
||
| 222 | * @param Finder $finder Mapping finder |
||
| 223 | * @return array |
||
| 224 | */ |
||
| 225 | 8 | View Code Duplication | private function loadSerializerClassMap(Finder $finder) |
| 246 | |||
| 247 | /** |
||
| 248 | * Load validation class map |
||
| 249 | * |
||
| 250 | * @param Finder $finder Mapping finder |
||
| 251 | * @return array |
||
| 252 | */ |
||
| 253 | 8 | View Code Duplication | private function loadValidationClassMap(Finder $finder) |
| 275 | |||
| 276 | /** |
||
| 277 | * Get serializer fields |
||
| 278 | * |
||
| 279 | * @param \DOMElement $mapping Serializer XML mapping |
||
| 280 | * @return array |
||
| 281 | */ |
||
| 282 | 8 | private function getSerializerFields(\DOMElement $mapping) |
|
| 299 | |||
| 300 | /** |
||
| 301 | * Get serializer field type |
||
| 302 | * |
||
| 303 | * @param \DOMElement $field Field node |
||
| 304 | * @return string|null |
||
| 305 | */ |
||
| 306 | 8 | private function getSerializerFieldType(\DOMElement $field) |
|
| 317 | |||
| 318 | /** |
||
| 319 | * Get validation fields |
||
| 320 | * |
||
| 321 | * @param \DOMElement $mapping Validation XML mapping |
||
| 322 | * @return array |
||
| 323 | */ |
||
| 324 | 8 | private function getValidationFields(\DOMElement $mapping) |
|
| 340 | |||
| 341 | /** |
||
| 342 | * Get doctrine document fields |
||
| 343 | * |
||
| 344 | * @param \DOMElement $mapping Doctrine XML mapping |
||
| 345 | * @return array |
||
| 346 | */ |
||
| 347 | 8 | View Code Duplication | private function getDoctrineFields(\DOMElement $mapping) |
| 362 | |||
| 363 | /** |
||
| 364 | * Get doctrine document embed-one fields |
||
| 365 | * |
||
| 366 | * @param \DOMElement $mapping Doctrine XML mapping |
||
| 367 | * @return array |
||
| 368 | */ |
||
| 369 | 8 | View Code Duplication | private function getDoctrineEmbedOneFields(\DOMElement $mapping) |
| 384 | |||
| 385 | /** |
||
| 386 | * Get doctrine document embed-many fields |
||
| 387 | * |
||
| 388 | * @param \DOMElement $mapping Doctrine XML mapping |
||
| 389 | * @return array |
||
| 390 | */ |
||
| 391 | 8 | View Code Duplication | private function getDoctrineEmbedManyFields(\DOMElement $mapping) |
| 406 | } |
||
| 407 |
Loading history...
This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.
If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.
In this case you can add the
@ignorePhpDoc annotation to the duplicate definition and it will be ignored.