doctrine /
mongodb-odm
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 YamlDriver 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 YamlDriver, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 18 | class YamlDriver extends FileDriver |
||
| 19 | { |
||
| 20 | const DEFAULT_FILE_EXTENSION = '.dcm.yml'; |
||
| 21 | |||
| 22 | /** |
||
| 23 | * {@inheritDoc} |
||
| 24 | */ |
||
| 25 | 13 | public function __construct($locator, $fileExtension = self::DEFAULT_FILE_EXTENSION) |
|
| 26 | { |
||
| 27 | 13 | parent::__construct($locator, $fileExtension); |
|
| 28 | 13 | } |
|
| 29 | |||
| 30 | /** |
||
| 31 | * {@inheritDoc} |
||
| 32 | */ |
||
| 33 | 9 | public function loadMetadataForClass($className, ClassMetadata $class) |
|
| 34 | { |
||
| 35 | /* @var $class ClassMetadataInfo */ |
||
| 36 | 9 | $element = $this->getElement($className); |
|
| 37 | 9 | if ( ! $element) { |
|
|
|
|||
| 38 | return; |
||
| 39 | } |
||
| 40 | 9 | $element['type'] = $element['type'] ?? 'document'; |
|
| 41 | |||
| 42 | 9 | if (isset($element['db'])) { |
|
| 43 | 3 | $class->setDatabase($element['db']); |
|
| 44 | } |
||
| 45 | 9 | if (isset($element['collection'])) { |
|
| 46 | 9 | $class->setCollection($element['collection']); |
|
| 47 | } |
||
| 48 | 9 | if (isset($element['readPreference'])) { |
|
| 49 | 1 | if (! isset($element['readPreference']['mode'])) { |
|
| 50 | throw new \InvalidArgumentException('"mode" is a required key for the readPreference setting.'); |
||
| 51 | } |
||
| 52 | 1 | $class->setReadPreference( |
|
| 53 | 1 | $element['readPreference']['mode'], |
|
| 54 | 1 | $element['readPreference']['tagSets'] ?? null |
|
| 55 | ); |
||
| 56 | } |
||
| 57 | 9 | if (isset($element['writeConcern'])) { |
|
| 58 | 1 | $class->setWriteConcern($element['writeConcern']); |
|
| 59 | } |
||
| 60 | 9 | if ($element['type'] == 'document') { |
|
| 61 | 9 | if (isset($element['repositoryClass'])) { |
|
| 62 | 9 | $class->setCustomRepositoryClass($element['repositoryClass']); |
|
| 63 | } |
||
| 64 | 1 | } elseif ($element['type'] === 'mappedSuperclass') { |
|
| 65 | $class->setCustomRepositoryClass( |
||
| 66 | $element['repositoryClass'] ?? null |
||
| 67 | ); |
||
| 68 | $class->isMappedSuperclass = true; |
||
| 69 | 1 | } elseif ($element['type'] === 'embeddedDocument') { |
|
| 70 | 1 | $class->isEmbeddedDocument = true; |
|
| 71 | 1 | } elseif ($element['type'] === 'queryResultDocument') { |
|
| 72 | 1 | $class->isQueryResultDocument = true; |
|
| 73 | } |
||
| 74 | 9 | if (isset($element['indexes'])) { |
|
| 75 | 2 | foreach($element['indexes'] as $index) { |
|
| 76 | 2 | $class->addIndex($index['keys'], $index['options'] ?? array()); |
|
| 77 | } |
||
| 78 | } |
||
| 79 | 9 | if (isset($element['shardKey'])) { |
|
| 80 | 1 | $this->setShardKey($class, $element['shardKey']); |
|
| 81 | } |
||
| 82 | 9 | View Code Duplication | if (isset($element['inheritanceType'])) { |
| 83 | $class->setInheritanceType(constant(MappingClassMetadata::class . '::INHERITANCE_TYPE_' . strtoupper($element['inheritanceType']))); |
||
| 84 | } |
||
| 85 | 9 | if (isset($element['discriminatorField'])) { |
|
| 86 | 1 | $class->setDiscriminatorField($this->parseDiscriminatorField($element['discriminatorField'])); |
|
| 87 | } |
||
| 88 | 9 | if (isset($element['discriminatorMap'])) { |
|
| 89 | 1 | $class->setDiscriminatorMap($element['discriminatorMap']); |
|
| 90 | } |
||
| 91 | 9 | if (isset($element['defaultDiscriminatorValue'])) { |
|
| 92 | 1 | $class->setDefaultDiscriminatorValue($element['defaultDiscriminatorValue']); |
|
| 93 | } |
||
| 94 | 9 | View Code Duplication | if (isset($element['changeTrackingPolicy'])) { |
| 95 | $class->setChangeTrackingPolicy(constant(MappingClassMetadata::class . '::CHANGETRACKING_' . strtoupper($element['changeTrackingPolicy']))); |
||
| 96 | } |
||
| 97 | 9 | if (isset($element['slaveOkay'])) { |
|
| 98 | $class->setSlaveOkay($element['slaveOkay']); |
||
| 99 | } |
||
| 100 | 9 | if (! empty($element['readOnly'])) { |
|
| 101 | 1 | $class->markReadOnly(); |
|
| 102 | } |
||
| 103 | 9 | if (isset($element['fields'])) { |
|
| 104 | 9 | foreach ($element['fields'] as $fieldName => $mapping) { |
|
| 105 | 9 | if (is_string($mapping)) { |
|
| 106 | 1 | $type = $mapping; |
|
| 107 | 1 | $mapping = array(); |
|
| 108 | 1 | $mapping['type'] = $type; |
|
| 109 | } |
||
| 110 | 9 | if ( ! isset($mapping['fieldName'])) { |
|
| 111 | 7 | $mapping['fieldName'] = $fieldName; |
|
| 112 | } |
||
| 113 | 9 | if (isset($mapping['type']) && ! empty($mapping['embedded'])) { |
|
| 114 | 2 | $this->addMappingFromEmbed($class, $fieldName, $mapping, $mapping['type']); |
|
| 115 | 9 | } elseif (isset($mapping['type']) && ! empty($mapping['reference'])) { |
|
| 116 | 2 | $this->addMappingFromReference($class, $fieldName, $mapping, $mapping['type']); |
|
| 117 | } else { |
||
| 118 | 9 | $this->addFieldMapping($class, $mapping); |
|
| 119 | } |
||
| 120 | } |
||
| 121 | } |
||
| 122 | 9 | View Code Duplication | if (isset($element['embedOne'])) { |
| 123 | 2 | foreach ($element['embedOne'] as $fieldName => $embed) { |
|
| 124 | 2 | $this->addMappingFromEmbed($class, $fieldName, $embed, 'one'); |
|
| 125 | } |
||
| 126 | } |
||
| 127 | 9 | View Code Duplication | if (isset($element['embedMany'])) { |
| 128 | 2 | foreach ($element['embedMany'] as $fieldName => $embed) { |
|
| 129 | 2 | $this->addMappingFromEmbed($class, $fieldName, $embed, 'many'); |
|
| 130 | } |
||
| 131 | } |
||
| 132 | 9 | View Code Duplication | if (isset($element['referenceOne'])) { |
| 133 | 2 | foreach ($element['referenceOne'] as $fieldName => $reference) { |
|
| 134 | 2 | $this->addMappingFromReference($class, $fieldName, $reference, 'one'); |
|
| 135 | } |
||
| 136 | } |
||
| 137 | 9 | View Code Duplication | if (isset($element['referenceMany'])) { |
| 138 | 3 | foreach ($element['referenceMany'] as $fieldName => $reference) { |
|
| 139 | 3 | $this->addMappingFromReference($class, $fieldName, $reference, 'many'); |
|
| 140 | } |
||
| 141 | } |
||
| 142 | 9 | if (isset($element['lifecycleCallbacks'])) { |
|
| 143 | 2 | foreach ($element['lifecycleCallbacks'] as $type => $methods) { |
|
| 144 | 2 | foreach ($methods as $method) { |
|
| 145 | 2 | $class->addLifecycleCallback($method, constant('Doctrine\ODM\MongoDB\Events::' . $type)); |
|
| 146 | } |
||
| 147 | } |
||
| 148 | } |
||
| 149 | 9 | if (isset($element['alsoLoadMethods'])) { |
|
| 150 | 1 | foreach ($element['alsoLoadMethods'] as $methodName => $fieldName) { |
|
| 151 | 1 | $class->registerAlsoLoadMethod($methodName, $fieldName); |
|
| 152 | } |
||
| 153 | } |
||
| 154 | 9 | } |
|
| 155 | |||
| 156 | 9 | private function addFieldMapping(ClassMetadataInfo $class, $mapping) |
|
| 157 | { |
||
| 158 | 9 | View Code Duplication | if (isset($mapping['name'])) { |
| 159 | 1 | $name = $mapping['name']; |
|
| 160 | 9 | } elseif (isset($mapping['fieldName'])) { |
|
| 161 | 9 | $name = $mapping['fieldName']; |
|
| 162 | } else { |
||
| 163 | throw new \InvalidArgumentException('Cannot infer a MongoDB name from the mapping'); |
||
| 164 | } |
||
| 165 | |||
| 166 | 9 | $class->mapField($mapping); |
|
| 167 | |||
| 168 | 9 | View Code Duplication | if ( ! (isset($mapping['index']) || isset($mapping['unique']) || isset($mapping['sparse']))) { |
| 169 | 9 | return; |
|
| 170 | } |
||
| 171 | |||
| 172 | // Multiple index specifications in one field mapping is ambiguous |
||
| 173 | 4 | if ((isset($mapping['index']) && is_array($mapping['index'])) + |
|
| 174 | 4 | (isset($mapping['unique']) && is_array($mapping['unique'])) + |
|
| 175 | 4 | (isset($mapping['sparse']) && is_array($mapping['sparse'])) > 1) { |
|
| 176 | throw new \InvalidArgumentException('Multiple index specifications found among index, unique, and/or sparse fields'); |
||
| 177 | } |
||
| 178 | |||
| 179 | // Index this field if either "index", "unique", or "sparse" are set |
||
| 180 | 4 | $keys = array($name => 'asc'); |
|
| 181 | |||
| 182 | /* The "order" option is only used in the index specification and should |
||
| 183 | * not be passed along as an index option. |
||
| 184 | */ |
||
| 185 | 4 | if (isset($mapping['index']['order'])) { |
|
| 186 | 1 | $keys[$name] = $mapping['index']['order']; |
|
| 187 | 1 | unset($mapping['index']['order']); |
|
| 188 | 4 | } elseif (isset($mapping['unique']['order'])) { |
|
| 189 | 1 | $keys[$name] = $mapping['unique']['order']; |
|
| 190 | 1 | unset($mapping['unique']['order']); |
|
| 191 | 3 | } elseif (isset($mapping['sparse']['order'])) { |
|
| 192 | $keys[$name] = $mapping['sparse']['order']; |
||
| 193 | unset($mapping['sparse']['order']); |
||
| 194 | } |
||
| 195 | |||
| 196 | /* Initialize $options from any array value among index, unique, and |
||
| 197 | * sparse. Any boolean values for unique or sparse should be merged into |
||
| 198 | * the options afterwards to ensure consistent parsing. |
||
| 199 | */ |
||
| 200 | 4 | $options = array(); |
|
| 201 | 4 | $unique = null; |
|
| 202 | 4 | $sparse = null; |
|
| 203 | |||
| 204 | 4 | if (isset($mapping['index']) && is_array($mapping['index'])) { |
|
| 205 | 1 | $options = $mapping['index']; |
|
| 206 | } |
||
| 207 | |||
| 208 | 4 | View Code Duplication | if (isset($mapping['unique'])) { |
| 209 | 4 | if (is_array($mapping['unique'])) { |
|
| 210 | 1 | $options = $mapping['unique'] + array('unique' => true); |
|
| 211 | } else { |
||
| 212 | 3 | $unique = (boolean) $mapping['unique']; |
|
| 213 | } |
||
| 214 | } |
||
| 215 | |||
| 216 | 4 | View Code Duplication | if (isset($mapping['sparse'])) { |
| 217 | 3 | if (is_array($mapping['sparse'])) { |
|
| 218 | $options = $mapping['sparse'] + array('sparse' => true); |
||
| 219 | } else { |
||
| 220 | 3 | $sparse = (boolean) $mapping['sparse']; |
|
| 221 | } |
||
| 222 | } |
||
| 223 | |||
| 224 | 4 | if (isset($unique)) { |
|
| 225 | 3 | $options['unique'] = $unique; |
|
| 226 | } |
||
| 227 | |||
| 228 | 4 | if (isset($sparse)) { |
|
| 229 | 3 | $options['sparse'] = $sparse; |
|
| 230 | } |
||
| 231 | |||
| 232 | 4 | $class->addIndex($keys, $options); |
|
| 233 | 4 | } |
|
| 234 | |||
| 235 | 4 | private function addMappingFromEmbed(ClassMetadataInfo $class, $fieldName, $embed, $type) |
|
| 236 | { |
||
| 237 | 4 | $defaultStrategy = $type == 'one' ? ClassMetadataInfo::STORAGE_STRATEGY_SET : CollectionHelper::DEFAULT_STRATEGY; |
|
| 238 | $mapping = array( |
||
| 239 | 4 | 'type' => $type, |
|
| 240 | 'embedded' => true, |
||
| 241 | 4 | 'targetDocument' => $embed['targetDocument'] ?? null, |
|
| 242 | 4 | 'collectionClass' => $embed['collectionClass'] ?? null, |
|
| 243 | 4 | 'fieldName' => $fieldName, |
|
| 244 | 4 | 'strategy' => (string) ($embed['strategy'] ?? $defaultStrategy), |
|
| 245 | ); |
||
| 246 | 4 | if (isset($embed['name'])) { |
|
| 247 | 1 | $mapping['name'] = $embed['name']; |
|
| 248 | } |
||
| 249 | 4 | if (isset($embed['discriminatorField'])) { |
|
| 250 | 1 | $mapping['discriminatorField'] = $this->parseDiscriminatorField($embed['discriminatorField']); |
|
| 251 | } |
||
| 252 | 4 | if (isset($embed['discriminatorMap'])) { |
|
| 253 | 1 | $mapping['discriminatorMap'] = $embed['discriminatorMap']; |
|
| 254 | } |
||
| 255 | 4 | if (isset($embed['defaultDiscriminatorValue'])) { |
|
| 256 | 1 | $mapping['defaultDiscriminatorValue'] = $embed['defaultDiscriminatorValue']; |
|
| 257 | } |
||
| 258 | 4 | $this->addFieldMapping($class, $mapping); |
|
| 259 | 4 | } |
|
| 260 | |||
| 261 | 5 | private function addMappingFromReference(ClassMetadataInfo $class, $fieldName, $reference, $type) |
|
| 262 | { |
||
| 263 | 5 | $defaultStrategy = $type == 'one' ? ClassMetadataInfo::STORAGE_STRATEGY_SET : CollectionHelper::DEFAULT_STRATEGY; |
|
| 264 | $mapping = array( |
||
| 265 | 5 | 'cascade' => $reference['cascade'] ?? [], |
|
| 266 | 5 | 'orphanRemoval' => $reference['orphanRemoval'] ?? false, |
|
| 267 | 5 | 'type' => $type, |
|
| 268 | 'reference' => true, |
||
| 269 | 5 | 'storeAs' => (string) ($reference['storeAs'] ?? ClassMetadataInfo::REFERENCE_STORE_AS_DB_REF), |
|
| 270 | 5 | 'targetDocument' => $reference['targetDocument'] ?? null, |
|
| 271 | 5 | 'collectionClass' => $reference['collectionClass'] ?? null, |
|
| 272 | 5 | 'fieldName' => $fieldName, |
|
| 273 | 5 | 'strategy' => (string) ($reference['strategy'] ?? $defaultStrategy), |
|
| 274 | 5 | 'inversedBy' => isset($reference['inversedBy']) ? (string) $reference['inversedBy'] : null, |
|
| 275 | 5 | 'mappedBy' => isset($reference['mappedBy']) ? (string) $reference['mappedBy'] : null, |
|
| 276 | 5 | 'repositoryMethod' => isset($reference['repositoryMethod']) ? (string) $reference['repositoryMethod'] : null, |
|
| 277 | 5 | 'limit' => isset($reference['limit']) ? (integer) $reference['limit'] : null, |
|
| 278 | 5 | 'skip' => isset($reference['skip']) ? (integer) $reference['skip'] : null, |
|
| 279 | 5 | 'prime' => $reference['prime'] ?? [], |
|
| 280 | ); |
||
| 281 | 5 | if (isset($reference['name'])) { |
|
| 282 | 1 | $mapping['name'] = $reference['name']; |
|
| 283 | } |
||
| 284 | 5 | if (isset($reference['discriminatorField'])) { |
|
| 285 | 1 | $mapping['discriminatorField'] = $this->parseDiscriminatorField($reference['discriminatorField']); |
|
| 286 | } |
||
| 287 | 5 | if (isset($reference['discriminatorMap'])) { |
|
| 288 | 1 | $mapping['discriminatorMap'] = $reference['discriminatorMap']; |
|
| 289 | } |
||
| 290 | 5 | if (isset($reference['defaultDiscriminatorValue'])) { |
|
| 291 | 1 | $mapping['defaultDiscriminatorValue'] = $reference['defaultDiscriminatorValue']; |
|
| 292 | } |
||
| 293 | 5 | if (isset($reference['sort'])) { |
|
| 294 | $mapping['sort'] = $reference['sort']; |
||
| 295 | } |
||
| 296 | 5 | if (isset($reference['criteria'])) { |
|
| 297 | $mapping['criteria'] = $reference['criteria']; |
||
| 298 | } |
||
| 299 | 5 | $this->addFieldMapping($class, $mapping); |
|
| 300 | 5 | } |
|
| 301 | |||
| 302 | /** |
||
| 303 | * Parses the class or field-level "discriminatorField" option. |
||
| 304 | * |
||
| 305 | * If the value is an array, check the "name" option before falling back to |
||
| 306 | * the deprecated "fieldName" option (for BC). Otherwise, the value must be |
||
| 307 | * a string. |
||
| 308 | * |
||
| 309 | * @param array|string $discriminatorField |
||
| 310 | * @return string |
||
| 311 | * @throws \InvalidArgumentException if the value is neither a string nor an |
||
| 312 | * array with a "name" or "fieldName" key. |
||
| 313 | */ |
||
| 314 | 1 | private function parseDiscriminatorField($discriminatorField) |
|
| 334 | |||
| 335 | /** |
||
| 336 | * {@inheritDoc} |
||
| 337 | */ |
||
| 338 | 9 | protected function loadMappingFile($file) |
|
| 348 | |||
| 349 | 1 | private function setShardKey(ClassMetadataInfo $class, array $shardKey) |
|
| 366 | } |
||
| 367 |
Loading history...
This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.
Consider making the comparison explicit by using
empty(..)or! empty(...)instead.