Complex classes like Matcher 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 Matcher, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 14 | class Matcher |
||
| 15 | { |
||
| 16 | /** |
||
| 17 | * The logical OR |
||
| 18 | */ |
||
| 19 | const LOGICAL_OR = 'logicalOr'; |
||
| 20 | |||
| 21 | /** |
||
| 22 | * The logical AND |
||
| 23 | */ |
||
| 24 | const LOGICAL_AND = 'logicalAnd'; |
||
| 25 | |||
| 26 | /** |
||
| 27 | * @var string |
||
| 28 | */ |
||
| 29 | protected $dataType = ''; |
||
| 30 | |||
| 31 | /** |
||
| 32 | * @var string |
||
| 33 | */ |
||
| 34 | protected $searchTerm = ''; |
||
| 35 | |||
| 36 | /** |
||
| 37 | * @var array |
||
| 38 | */ |
||
| 39 | protected $supportedOperators = [ |
||
| 40 | '=' => 'equals', |
||
| 41 | '!=' => 'notEquals', |
||
| 42 | 'in' => 'in', |
||
| 43 | 'like' => 'like', |
||
| 44 | '>' => 'greaterThan', |
||
| 45 | '>=' => 'greaterThanOrEqual', |
||
| 46 | '<' => 'lessThan', |
||
| 47 | '<=' => 'lessThanOrEqual', |
||
| 48 | ]; |
||
| 49 | |||
| 50 | /** |
||
| 51 | * @var array |
||
| 52 | */ |
||
| 53 | protected $equals = []; |
||
| 54 | |||
| 55 | /** |
||
| 56 | * @var array |
||
| 57 | */ |
||
| 58 | protected $notEquals = []; |
||
| 59 | |||
| 60 | /** |
||
| 61 | * @var array |
||
| 62 | */ |
||
| 63 | protected $greaterThan = []; |
||
| 64 | |||
| 65 | /** |
||
| 66 | * @var array |
||
| 67 | */ |
||
| 68 | protected $greaterThanOrEqual = []; |
||
| 69 | |||
| 70 | /** |
||
| 71 | * @var array |
||
| 72 | */ |
||
| 73 | protected $lessThan = []; |
||
| 74 | |||
| 75 | /** |
||
| 76 | * @var array |
||
| 77 | */ |
||
| 78 | protected $lessThanOrEqual = []; |
||
| 79 | |||
| 80 | /** |
||
| 81 | * @var array |
||
| 82 | */ |
||
| 83 | protected $in = []; |
||
| 84 | |||
| 85 | /** |
||
| 86 | * @var array |
||
| 87 | */ |
||
| 88 | protected $like = []; |
||
| 89 | |||
| 90 | /** |
||
| 91 | * @var array |
||
| 92 | */ |
||
| 93 | protected $matches = []; |
||
| 94 | |||
| 95 | /** |
||
| 96 | * @var string |
||
| 97 | */ |
||
| 98 | protected $defaultLogicalSeparator = self::LOGICAL_AND; |
||
| 99 | |||
| 100 | /** |
||
| 101 | * @var string |
||
| 102 | */ |
||
| 103 | protected $logicalSeparatorForEquals = self::LOGICAL_AND; |
||
| 104 | |||
| 105 | /** |
||
| 106 | * @var string |
||
| 107 | */ |
||
| 108 | protected $logicalSeparatorForGreaterThan = self::LOGICAL_AND; |
||
| 109 | |||
| 110 | /** |
||
| 111 | * @var string |
||
| 112 | */ |
||
| 113 | protected $logicalSeparatorForGreaterThanOrEqual = self::LOGICAL_AND; |
||
| 114 | |||
| 115 | /** |
||
| 116 | * @var string |
||
| 117 | */ |
||
| 118 | protected $logicalSeparatorForLessThan = self::LOGICAL_AND; |
||
| 119 | |||
| 120 | /** |
||
| 121 | * @var string |
||
| 122 | */ |
||
| 123 | protected $logicalSeparatorForLessThanOrEqual = self::LOGICAL_AND; |
||
| 124 | |||
| 125 | /** |
||
| 126 | * @var string |
||
| 127 | */ |
||
| 128 | protected $logicalSeparatorForIn = self::LOGICAL_AND; |
||
| 129 | |||
| 130 | /** |
||
| 131 | * @var string |
||
| 132 | */ |
||
| 133 | protected $logicalSeparatorForLike = self::LOGICAL_AND; |
||
| 134 | |||
| 135 | /** |
||
| 136 | * @var string |
||
| 137 | */ |
||
| 138 | protected $logicalSeparatorForSearchTerm = self::LOGICAL_OR; |
||
| 139 | |||
| 140 | /** |
||
| 141 | * Constructs a new Matcher |
||
| 142 | * |
||
| 143 | * @param array $matches associative [$field => $value] |
||
| 144 | * @param string $dataType which corresponds to an entry of the TCA (table name). |
||
| 145 | */ |
||
| 146 | public function __construct($matches = [], $dataType = '') |
||
| 151 | |||
| 152 | /** |
||
| 153 | * @param string $searchTerm |
||
| 154 | * @return \Fab\Vidi\Persistence\Matcher |
||
| 155 | */ |
||
| 156 | public function setSearchTerm($searchTerm): Matcher |
||
| 161 | |||
| 162 | /** |
||
| 163 | * @return string |
||
| 164 | */ |
||
| 165 | public function getSearchTerm(): string |
||
| 169 | |||
| 170 | /** |
||
| 171 | * @return array |
||
| 172 | */ |
||
| 173 | public function getEquals(): array |
||
| 177 | |||
| 178 | /** |
||
| 179 | * @param $fieldNameAndPath |
||
| 180 | * @param $operand |
||
| 181 | * @return $this |
||
| 182 | */ |
||
| 183 | public function equals($fieldNameAndPath, $operand): self |
||
| 188 | |||
| 189 | /** |
||
| 190 | * @return array |
||
| 191 | */ |
||
| 192 | public function getNotEquals(): array |
||
| 196 | |||
| 197 | /** |
||
| 198 | * @param $fieldNameAndPath |
||
| 199 | * @param $operand |
||
| 200 | * @return $this |
||
| 201 | */ |
||
| 202 | public function notEquals($fieldNameAndPath, $operand): self |
||
| 207 | |||
| 208 | /** |
||
| 209 | * @return array |
||
| 210 | */ |
||
| 211 | public function getGreaterThan(): array |
||
| 215 | |||
| 216 | /** |
||
| 217 | * @param $fieldNameAndPath |
||
| 218 | * @param $operand |
||
| 219 | * @return $this |
||
| 220 | */ |
||
| 221 | public function greaterThan($fieldNameAndPath, $operand): self |
||
| 226 | |||
| 227 | /** |
||
| 228 | * @return array |
||
| 229 | */ |
||
| 230 | public function getGreaterThanOrEqual(): array |
||
| 234 | |||
| 235 | /** |
||
| 236 | * @param $fieldNameAndPath |
||
| 237 | * @param $operand |
||
| 238 | * @return $this |
||
| 239 | */ |
||
| 240 | public function greaterThanOrEqual($fieldNameAndPath, $operand): self |
||
| 245 | |||
| 246 | /** |
||
| 247 | * @return array |
||
| 248 | */ |
||
| 249 | public function getLessThan(): array |
||
| 253 | |||
| 254 | /** |
||
| 255 | * @param $fieldNameAndPath |
||
| 256 | * @param $operand |
||
| 257 | * @return $this |
||
| 258 | */ |
||
| 259 | public function lessThan($fieldNameAndPath, $operand): self |
||
| 264 | |||
| 265 | /** |
||
| 266 | * @return array |
||
| 267 | */ |
||
| 268 | public function getLessThanOrEqual(): array |
||
| 272 | |||
| 273 | /** |
||
| 274 | * @param $fieldNameAndPath |
||
| 275 | * @param $operand |
||
| 276 | * @return $this |
||
| 277 | */ |
||
| 278 | public function lessThanOrEqual($fieldNameAndPath, $operand): self |
||
| 283 | |||
| 284 | /** |
||
| 285 | * @return array |
||
| 286 | */ |
||
| 287 | public function getLike(): array |
||
| 291 | |||
| 292 | /** |
||
| 293 | * @param $fieldNameAndPath |
||
| 294 | * @param $operand |
||
| 295 | * @return $this |
||
| 296 | */ |
||
| 297 | public function in($fieldNameAndPath, $operand): self |
||
| 302 | |||
| 303 | /** |
||
| 304 | * @return array |
||
| 305 | */ |
||
| 306 | public function getIn(): array |
||
| 310 | |||
| 311 | /** |
||
| 312 | * @param $fieldNameAndPath |
||
| 313 | * @param $operand |
||
| 314 | * @param bool $addWildCard |
||
| 315 | * @return $this |
||
| 316 | */ |
||
| 317 | public function like($fieldNameAndPath, $operand, $addWildCard = true): self |
||
| 323 | |||
| 324 | /** |
||
| 325 | * @return string |
||
| 326 | */ |
||
| 327 | public function getDefaultLogicalSeparator(): string |
||
| 331 | |||
| 332 | /** |
||
| 333 | * @param string $defaultLogicalSeparator |
||
| 334 | * @return $this |
||
| 335 | */ |
||
| 336 | public function setDefaultLogicalSeparator($defaultLogicalSeparator): self |
||
| 341 | |||
| 342 | /** |
||
| 343 | * @return string |
||
| 344 | */ |
||
| 345 | public function getLogicalSeparatorForEquals(): string |
||
| 349 | |||
| 350 | /** |
||
| 351 | * @param string $logicalSeparatorForEquals |
||
| 352 | * @return $this |
||
| 353 | */ |
||
| 354 | public function setLogicalSeparatorForEquals($logicalSeparatorForEquals): self |
||
| 359 | |||
| 360 | /** |
||
| 361 | * @return string |
||
| 362 | */ |
||
| 363 | public function getLogicalSeparatorForGreaterThan(): string |
||
| 367 | |||
| 368 | /** |
||
| 369 | * @param string $logicalSeparatorForGreaterThan |
||
| 370 | * @return $this |
||
| 371 | */ |
||
| 372 | public function setLogicalSeparatorForGreaterThan($logicalSeparatorForGreaterThan): self |
||
| 377 | |||
| 378 | /** |
||
| 379 | * @return string |
||
| 380 | */ |
||
| 381 | public function getLogicalSeparatorForGreaterThanOrEqual(): string |
||
| 385 | |||
| 386 | /** |
||
| 387 | * @param string $logicalSeparatorForGreaterThanOrEqual |
||
| 388 | * @return $this |
||
| 389 | */ |
||
| 390 | public function setLogicalSeparatorForGreaterThanOrEqual($logicalSeparatorForGreaterThanOrEqual): self |
||
| 395 | |||
| 396 | /** |
||
| 397 | * @return string |
||
| 398 | */ |
||
| 399 | public function getLogicalSeparatorForLessThan(): string |
||
| 403 | |||
| 404 | /** |
||
| 405 | * @param string $logicalSeparatorForLessThan |
||
| 406 | * @return $this |
||
| 407 | */ |
||
| 408 | public function setLogicalSeparatorForLessThan($logicalSeparatorForLessThan): self |
||
| 413 | |||
| 414 | /** |
||
| 415 | * @return string |
||
| 416 | */ |
||
| 417 | public function getLogicalSeparatorForLessThanOrEqual(): string |
||
| 421 | |||
| 422 | /** |
||
| 423 | * @param string $logicalSeparatorForLessThanOrEqual |
||
| 424 | * @return $this |
||
| 425 | */ |
||
| 426 | public function setLogicalSeparatorForLessThanOrEqual($logicalSeparatorForLessThanOrEqual): self |
||
| 431 | |||
| 432 | /** |
||
| 433 | * @return string |
||
| 434 | */ |
||
| 435 | public function getLogicalSeparatorForIn(): string |
||
| 439 | |||
| 440 | /** |
||
| 441 | * @param string $logicalSeparatorForIn |
||
| 442 | * @return $this |
||
| 443 | */ |
||
| 444 | public function setLogicalSeparatorForIn($logicalSeparatorForIn): self |
||
| 449 | |||
| 450 | /** |
||
| 451 | * @return string |
||
| 452 | */ |
||
| 453 | public function getLogicalSeparatorForLike(): string |
||
| 457 | |||
| 458 | /** |
||
| 459 | * @param string $logicalSeparatorForLike |
||
| 460 | * @return $this |
||
| 461 | */ |
||
| 462 | public function setLogicalSeparatorForLike($logicalSeparatorForLike): self |
||
| 467 | |||
| 468 | /** |
||
| 469 | * @return string |
||
| 470 | */ |
||
| 471 | public function getLogicalSeparatorForSearchTerm(): string |
||
| 475 | |||
| 476 | /** |
||
| 477 | * @param string $logicalSeparatorForSearchTerm |
||
| 478 | * @return $this |
||
| 479 | */ |
||
| 480 | public function setLogicalSeparatorForSearchTerm($logicalSeparatorForSearchTerm): self |
||
| 485 | |||
| 486 | /** |
||
| 487 | * @return array |
||
| 488 | */ |
||
| 489 | public function getSupportedOperators(): array |
||
| 493 | |||
| 494 | /** |
||
| 495 | * @return string |
||
| 496 | */ |
||
| 497 | public function getDataType(): string |
||
| 501 | |||
| 502 | /** |
||
| 503 | * @param string $dataType |
||
| 504 | * @return $this |
||
| 505 | */ |
||
| 506 | public function setDataType($dataType): self |
||
| 511 | } |
||
| 512 |