Complex classes like Validation 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 Validation, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 13 | class Validation { |
||
| 14 | /** |
||
| 15 | * @var array |
||
| 16 | */ |
||
| 17 | private $errors = []; |
||
| 18 | |||
| 19 | /** |
||
| 20 | * @var string |
||
| 21 | */ |
||
| 22 | private $mainMessage = ''; |
||
| 23 | |||
| 24 | /** |
||
| 25 | * @var int |
||
| 26 | */ |
||
| 27 | private $mainStatus = 0; |
||
| 28 | |||
| 29 | /** |
||
| 30 | * @var bool Whether or not fields should be translated. |
||
| 31 | */ |
||
| 32 | private $translateFieldNames = false; |
||
| 33 | |||
| 34 | /** |
||
| 35 | * Add an error. |
||
| 36 | * |
||
| 37 | * @param string $field The name and path of the field to add or an empty string if this is a global error. |
||
| 38 | * @param string $error The message code. |
||
| 39 | * @param int|array $options An array of additional information to add to the error entry or a numeric error code. |
||
| 40 | * @return $this |
||
| 41 | */ |
||
| 42 | 60 | public function addError($field, $error, $options = []) { |
|
| 76 | |||
| 77 | /** |
||
| 78 | * Get or set the error status code. |
||
| 79 | * |
||
| 80 | * The status code is an http response code and should be of the 4xx variety. |
||
| 81 | * |
||
| 82 | * @return int Returns the current status code. |
||
| 83 | */ |
||
| 84 | 53 | public function getStatus() { |
|
| 103 | |||
| 104 | /** |
||
| 105 | * Get the message for this exception. |
||
| 106 | * |
||
| 107 | * @return string Returns the exception message. |
||
| 108 | */ |
||
| 109 | 54 | public function getMessage() { |
|
| 127 | |||
| 128 | /** |
||
| 129 | * Gets all of the errors as a flat array. |
||
| 130 | * |
||
| 131 | * The errors are internally stored indexed by field. This method flattens them for final error returns. |
||
| 132 | * |
||
| 133 | * @return array Returns all of the errors. |
||
| 134 | */ |
||
| 135 | 4 | public function getErrors() { |
|
| 142 | |||
| 143 | /** |
||
| 144 | * Get the errors for a specific field. |
||
| 145 | * |
||
| 146 | * @param string $field The full path to the field. |
||
| 147 | * @return array Returns an array of errors. |
||
| 148 | */ |
||
| 149 | 6 | public function getFieldErrors($field) { |
|
| 160 | |||
| 161 | /** |
||
| 162 | * Gets all of the errors as a flat array. |
||
| 163 | * |
||
| 164 | * The errors are internally stored indexed by field. This method flattens them for final error returns. |
||
| 165 | * |
||
| 166 | * @return \Traversable Returns all of the errors. |
||
| 167 | */ |
||
| 168 | 57 | protected function getRawErrors() { |
|
| 175 | |||
| 176 | /** |
||
| 177 | * Check whether or not the validation is free of errors. |
||
| 178 | * |
||
| 179 | * @return bool Returns true if there are no errors, false otherwise. |
||
| 180 | */ |
||
| 181 | 92 | public function isValid() { |
|
| 184 | |||
| 185 | /** |
||
| 186 | * Check whether or not a particular field is has errors. |
||
| 187 | * |
||
| 188 | * @param string $field The name of the field to check for validity. |
||
| 189 | * @return bool Returns true if the field has no errors, false otherwise. |
||
| 190 | */ |
||
| 191 | 34 | public function isValidField($field) { |
|
| 195 | |||
| 196 | /** |
||
| 197 | * Get the error message for an error row. |
||
| 198 | * |
||
| 199 | * @param array $error The error row. |
||
| 200 | * @return string Returns a formatted/translated error message. |
||
| 201 | */ |
||
| 202 | 55 | private function getErrorMessage(array $error) { |
|
| 232 | |||
| 233 | /** |
||
| 234 | * Expand and translate a message format against an array of values. |
||
| 235 | * |
||
| 236 | * @param string $format The message format. |
||
| 237 | * @param array $context The context arguments to apply to the message. |
||
| 238 | * @return string Returns a formatted string. |
||
| 239 | */ |
||
| 240 | 55 | private function formatMessage($format, $context = []) { |
|
| 250 | |||
| 251 | /** |
||
| 252 | * Translate an argument being placed in an error message. |
||
| 253 | * |
||
| 254 | * @param mixed $value The argument to translate. |
||
| 255 | * @param array $args Formatting arguments. |
||
| 256 | * @return string Returns the translated string. |
||
| 257 | */ |
||
| 258 | 52 | private function formatField($value, array $args = []) { |
|
| 284 | |||
| 285 | /** |
||
| 286 | * Translate a string. |
||
| 287 | * |
||
| 288 | * This method doesn't do any translation itself, but is meant for subclasses wanting to add translation ability to |
||
| 289 | * this class. |
||
| 290 | * |
||
| 291 | * @param string $str The string to translate. |
||
| 292 | * @return string Returns the translated string. |
||
| 293 | */ |
||
| 294 | 56 | public function translate($str) { |
|
| 302 | |||
| 303 | /** |
||
| 304 | * Merge another validation object with this one. |
||
| 305 | * |
||
| 306 | * @param Validation $validation The validation object to merge. |
||
| 307 | * @param string $name The path to merge to. Use this parameter when the validation object is meant to be a subset of this one. |
||
| 308 | * @return $this |
||
| 309 | */ |
||
| 310 | 1 | public function merge(Validation $validation, $name = '') { |
|
| 323 | |||
| 324 | /** |
||
| 325 | * Get the main error message. |
||
| 326 | * |
||
| 327 | * If set, this message will be returned as the error message. Otherwise the message will be set from individual |
||
| 328 | * errors. |
||
| 329 | * |
||
| 330 | * @return string Returns the main message. |
||
| 331 | */ |
||
| 332 | 54 | public function getMainMessage() { |
|
| 335 | |||
| 336 | /** |
||
| 337 | * Set the main error message. |
||
| 338 | * |
||
| 339 | * @param string $message The new message. |
||
| 340 | * @return $this |
||
| 341 | */ |
||
| 342 | 1 | public function setMainMessage($message) { |
|
| 346 | |||
| 347 | /** |
||
| 348 | * Get the main status. |
||
| 349 | * |
||
| 350 | * @return int Returns an HTTP response code or zero to indicate it should be calculated. |
||
| 351 | */ |
||
| 352 | 53 | public function getMainStatus() { |
|
| 355 | |||
| 356 | /** |
||
| 357 | * Set the main status. |
||
| 358 | * |
||
| 359 | * @param int $status An HTTP response code or zero. |
||
| 360 | * @return $this |
||
| 361 | */ |
||
| 362 | 1 | public function setMainStatus($status) { |
|
| 366 | |||
| 367 | /** |
||
| 368 | * Whether or not fields should be translated. |
||
| 369 | * |
||
| 370 | * @return bool Returns **true** if field names are translated or **false** otherwise. |
||
| 371 | */ |
||
| 372 | 55 | public function getTranslateFieldNames() { |
|
| 375 | |||
| 376 | /** |
||
| 377 | * Set whether or not fields should be translated. |
||
| 378 | * |
||
| 379 | * @param bool $translate Whether or not fields should be translated. |
||
| 380 | * @return $this |
||
| 381 | */ |
||
| 382 | 2 | public function setTranslateFieldNames($translate) { |
|
| 386 | |||
| 387 | /** |
||
| 388 | * @param $error |
||
| 389 | * @return array |
||
| 390 | */ |
||
| 391 | 10 | private function formatError($error) { |
|
| 400 | } |
||
| 401 |
This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line.
To visualize
will produce issues in the first and second line, while this second example
will produce no issues.