htmlburger /
carbon-fields
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 Association_Field 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 Association_Field, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 16 | class Association_Field extends Relationship_Field { |
||
| 17 | |||
| 18 | /** |
||
| 19 | * WP_Toolset instance |
||
| 20 | * @var Carbon_Fields\Toolset\WP_Toolset |
||
| 21 | */ |
||
| 22 | protected $wp_toolset; |
||
| 23 | |||
| 24 | /** |
||
| 25 | * Types of entries to associate with. |
||
| 26 | * @var array |
||
| 27 | */ |
||
| 28 | protected $types = array( |
||
| 29 | array( |
||
| 30 | 'type' => 'post', |
||
| 31 | 'post_type' => 'post', |
||
| 32 | ), |
||
| 33 | ); |
||
| 34 | |||
| 35 | /** |
||
| 36 | * Create a field from a certain type with the specified label. |
||
| 37 | * @param string $name Field name |
||
| 38 | * @param string $label Field label |
||
| 39 | */ |
||
| 40 | protected function __construct( $name, $label ) { |
||
| 41 | $this->wp_toolset = App::resolve( 'wp_toolset' ); |
||
| 42 | $this->value = new Value_Set( Value_Set::TYPE_VALUE_SET, array( 'type' => '', 'subtype' => '', 'object_id' => 0 ) ); |
||
| 43 | Field::__construct( $name, $label ); |
||
| 44 | } |
||
| 45 | |||
| 46 | /** |
||
| 47 | * Alias for $this->value()->set( $value ); |
||
| 48 | **/ |
||
| 49 | public function set_value( $value ) { |
||
| 53 | |||
| 54 | /** |
||
| 55 | * Return a differently formatted value for end-users |
||
| 56 | * |
||
| 57 | * @return mixed |
||
| 58 | **/ |
||
| 59 | public function get_formatted_value() { |
||
| 62 | |||
| 63 | /** |
||
| 64 | * Convert a colo:separated:string into it's expected components |
||
| 65 | * Used for backwards compatibility to CF 1.5 |
||
| 66 | * |
||
| 67 | * @param string $value_string |
||
| 68 | * @return array |
||
| 69 | */ |
||
| 70 | protected function value_string_to_property_array( $value_string ) { |
||
| 80 | |||
| 81 | /** |
||
| 82 | * Convert a colon:separated:string into it's expected components |
||
| 83 | * Used for backwards compatibility to CF 1.5 |
||
| 84 | * |
||
| 85 | * @param array $value_string_array |
||
| 86 | * @return array<array> |
||
| 87 | */ |
||
| 88 | protected function value_string_array_to_value_set( $value_string_array ) { |
||
| 107 | |||
| 108 | /** |
||
| 109 | * Used to get the title of an item. |
||
| 110 | * |
||
| 111 | * Can be overriden or extended by the `carbon_association_title` filter. |
||
| 112 | * |
||
| 113 | * @param int $id The database ID of the item. |
||
| 114 | * @param string $type Item type (post, term, user, comment, or a custom one). |
||
| 115 | * @param string $subtype The subtype - "page", "post", "category", etc. |
||
| 116 | * @return string $title The title of the item. |
||
| 117 | */ |
||
| 118 | protected function get_title_by_type( $id, $type, $subtype = '' ) { |
||
| 151 | |||
| 152 | /** |
||
| 153 | * Used to get the label of an item. |
||
| 154 | * |
||
| 155 | * Can be overriden or extended by the `carbon_association_item_label` filter. |
||
| 156 | * |
||
| 157 | * @param int $id The database ID of the item. |
||
| 158 | * @param string $type Item type (post, term, user, comment, or a custom one). |
||
| 159 | * @param string $subtype Subtype - "page", "post", "category", etc. |
||
| 160 | * @return string $label The label of the item. |
||
| 161 | */ |
||
| 162 | protected function get_item_label( $id, $type, $subtype = '' ) { |
||
| 184 | |||
| 185 | /** |
||
| 186 | * Get post options |
||
| 187 | * |
||
| 188 | * @return array $options |
||
| 189 | */ |
||
| 190 | protected function get_post_options( $type ) { |
||
| 219 | |||
| 220 | /** |
||
| 221 | * Get term options |
||
| 222 | * |
||
| 223 | * @return array $options |
||
| 224 | */ |
||
| 225 | protected function get_term_options( $type ) { |
||
| 252 | |||
| 253 | /** |
||
| 254 | * Get user options |
||
| 255 | * |
||
| 256 | * @return array $options |
||
| 257 | */ |
||
| 258 | View Code Duplication | protected function get_user_options( $type ) { |
|
| 284 | |||
| 285 | /** |
||
| 286 | * Get comment options |
||
| 287 | * |
||
| 288 | * @return array $options |
||
| 289 | */ |
||
| 290 | View Code Duplication | protected function get_comment_options( $type ) { |
|
| 316 | |||
| 317 | /** |
||
| 318 | * Generate the item options. |
||
| 319 | * |
||
| 320 | * @return array $options The selectable options of the association field. |
||
| 321 | */ |
||
| 322 | public function get_options() { |
||
| 343 | |||
| 344 | /** |
||
| 345 | * Retrieve the edit link of a particular object. |
||
| 346 | * |
||
| 347 | * @param string $type Object type. |
||
| 348 | * @param int $id ID of the object. |
||
| 349 | * @return string URL of the edit link. |
||
| 350 | */ |
||
| 351 | protected function get_object_edit_link( $type, $id ) { |
||
| 377 | |||
| 378 | /** |
||
| 379 | * Modify the types. |
||
| 380 | * @param array $types New types |
||
| 381 | */ |
||
| 382 | public function set_types( $types ) { |
||
| 386 | |||
| 387 | /** |
||
| 388 | * Converts the field values into a usable associative array. |
||
| 389 | * |
||
| 390 | * The association data is saved in the database in the following format: |
||
| 391 | * array ( |
||
| 392 | * 0 => 'post:page:4', |
||
| 393 | * 1 => 'term:category:2', |
||
| 394 | * 2 => 'user:user:1', |
||
| 395 | * ) |
||
| 396 | * where the value of each array item contains: |
||
| 397 | * - Type of data (post, term, user or comment) |
||
| 398 | * - Subtype of data (the particular post type or taxonomy) |
||
| 399 | * - ID of the item (the database ID of the item) |
||
| 400 | */ |
||
| 401 | protected function value_to_json() { |
||
| 417 | |||
| 418 | /** |
||
| 419 | * Convert the field data into JSON representation. |
||
| 420 | * @param bool $load Whether to load data from the datastore. |
||
| 421 | * @return mixed The JSON field data. |
||
| 422 | */ |
||
| 423 | public function to_json( $load ) { |
||
| 442 | |||
| 443 | /** |
||
| 444 | * Serves as a backbone template for the association items. |
||
| 445 | * Used for both the selected and the selectable options. |
||
| 446 | * |
||
| 447 | * @param bool $display_input Whether to display the selected item input field. |
||
| 448 | */ |
||
| 449 | public function item_template( $display_input = true ) { |
||
| 470 | } |
||
| 471 |
Loading history...
Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.
You can also find more detailed suggestions in the “Code” section of your repository.