pods-framework /
pods
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 PodsField_Website 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 PodsField_Website, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 5 | class PodsField_Website extends PodsField { |
||
| 6 | |||
| 7 | /** |
||
| 8 | * Field Type Group |
||
| 9 | * |
||
| 10 | * @var string |
||
| 11 | * @since 2.0 |
||
| 12 | */ |
||
| 13 | public static $group = 'Text'; |
||
| 14 | |||
| 15 | /** |
||
| 16 | * Field Type Identifier |
||
| 17 | * |
||
| 18 | * @var string |
||
| 19 | * @since 2.0 |
||
| 20 | */ |
||
| 21 | public static $type = 'website'; |
||
| 22 | |||
| 23 | /** |
||
| 24 | * Field Type Label |
||
| 25 | * |
||
| 26 | * @var string |
||
| 27 | * @since 2.0 |
||
| 28 | */ |
||
| 29 | public static $label = 'Website'; |
||
| 30 | |||
| 31 | /** |
||
| 32 | * Field Type Preparation |
||
| 33 | * |
||
| 34 | * @var string |
||
| 35 | * @since 2.0 |
||
| 36 | */ |
||
| 37 | public static $prepare = '%s'; |
||
| 38 | |||
| 39 | /** |
||
| 40 | * Do things like register/enqueue scripts and stylesheets |
||
| 41 | * |
||
| 42 | * @since 2.0 |
||
| 43 | */ |
||
| 44 | public function __construct () { |
||
| 49 | |||
| 50 | /** |
||
| 51 | * Add options and set defaults to |
||
| 52 | * |
||
| 53 | * @param array $options |
||
|
|
|||
| 54 | * |
||
| 55 | * @since 2.0 |
||
| 56 | */ |
||
| 57 | public function options () { |
||
| 117 | |||
| 118 | /** |
||
| 119 | * Define the current field's schema for DB table storage |
||
| 120 | * |
||
| 121 | * @param array $options |
||
| 122 | * |
||
| 123 | * @return array |
||
| 124 | * @since 2.0 |
||
| 125 | */ |
||
| 126 | View Code Duplication | public function schema ( $options = null ) { |
|
| 136 | |||
| 137 | /** |
||
| 138 | * Change the way the value of the field is displayed with Pods::get |
||
| 139 | * |
||
| 140 | * @param mixed $value |
||
| 141 | * @param string $name |
||
| 142 | * @param array $options |
||
| 143 | * @param array $pod |
||
| 144 | * @param int $id |
||
| 145 | * |
||
| 146 | * @return mixed|null |
||
| 147 | * @since 2.0 |
||
| 148 | */ |
||
| 149 | public function display ( $value = null, $name = null, $options = null, $pod = null, $id = null ) { |
||
| 167 | |||
| 168 | /** |
||
| 169 | * Customize output of the form field |
||
| 170 | * |
||
| 171 | * @param string $name |
||
| 172 | * @param mixed $value |
||
| 173 | * @param array $options |
||
| 174 | * @param array $pod |
||
| 175 | * @param int $id |
||
| 176 | * |
||
| 177 | * @since 2.0 |
||
| 178 | */ |
||
| 179 | public function input ( $name, $value = null, $options = null, $pod = null, $id = null ) { |
||
| 205 | |||
| 206 | /** |
||
| 207 | * Validate a value before it's saved |
||
| 208 | * |
||
| 209 | * @param mixed $value |
||
| 210 | * @param string $name |
||
| 211 | * @param array $options |
||
| 212 | * @param array $fields |
||
| 213 | * @param array $pod |
||
| 214 | * @param int $id |
||
| 215 | * |
||
| 216 | * @return bool|array |
||
| 217 | * |
||
| 218 | * @since 2.0 |
||
| 219 | */ |
||
| 220 | View Code Duplication | public function validate ( $value, $name = null, $options = null, $fields = null, $pod = null, $id = null, $params = null ) { |
|
| 243 | |||
| 244 | /** |
||
| 245 | * Change the value or perform actions after validation but before saving to the DB |
||
| 246 | * |
||
| 247 | * @param mixed $value |
||
| 248 | * @param int $id |
||
| 249 | * @param string $name |
||
| 250 | * @param array $options |
||
| 251 | * @param array $fields |
||
| 252 | * @param array $pod |
||
| 253 | * @param object $params |
||
| 254 | * |
||
| 255 | * @return string |
||
| 256 | * |
||
| 257 | * @since 2.0 |
||
| 258 | */ |
||
| 259 | public function pre_save ( $value, $id = null, $name = null, $options = null, $fields = null, $pod = null, $params = null ) { |
||
| 281 | |||
| 282 | /** |
||
| 283 | * Customize the Pods UI manage table column output |
||
| 284 | * |
||
| 285 | * @param int $id |
||
| 286 | * @param mixed $value |
||
| 287 | * @param string $name |
||
| 288 | * @param array $options |
||
| 289 | * @param array $fields |
||
| 290 | * @param array $pod |
||
| 291 | * |
||
| 292 | * @return string |
||
| 293 | * |
||
| 294 | * @since 2.0 |
||
| 295 | */ |
||
| 296 | public function ui ( $id, $value, $name = null, $options = null, $fields = null, $pod = null ) { |
||
| 301 | |||
| 302 | /** |
||
| 303 | * Validate an URL with the options |
||
| 304 | * |
||
| 305 | * @param string $value |
||
| 306 | * @param array $options |
||
| 307 | * |
||
| 308 | * @return string |
||
| 309 | * |
||
| 310 | * @since 2.7 |
||
| 311 | */ |
||
| 312 | public function validate_url( $value, $options = null ) { |
||
| 392 | |||
| 393 | /** |
||
| 394 | * Strip HTML based on options |
||
| 395 | * |
||
| 396 | * @param string $value |
||
| 397 | * @param array $options |
||
| 398 | * |
||
| 399 | * @return string |
||
| 400 | * |
||
| 401 | * @since 2.7 |
||
| 402 | */ |
||
| 403 | View Code Duplication | public function strip_html ( $value, $options = null ) { |
|
| 430 | |||
| 431 | /** |
||
| 432 | * Validate an target attribute with the options |
||
| 433 | * |
||
| 434 | * @param string $value |
||
| 435 | * |
||
| 436 | * @return string |
||
| 437 | * |
||
| 438 | * @since 2.7 |
||
| 439 | */ |
||
| 440 | public function validate_target( $value ) { |
||
| 448 | |||
| 449 | /** |
||
| 450 | * Build an url |
||
| 451 | * |
||
| 452 | * @param array|string $url |
||
| 453 | * |
||
| 454 | * @return string |
||
| 455 | */ |
||
| 456 | public function build_url ( $url ) { |
||
| 480 | |||
| 481 | } |
Loading history...
This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.
Consider the following example. The parameter
$italyis not defined by the methodfinale(...).The most likely cause is that the parameter was removed, but the annotation was not.