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 CMB2_hookup 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 CMB2_hookup, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
14 | class CMB2_hookup extends CMB2_Hookup_Base { |
||
|
|||
15 | |||
16 | /** |
||
17 | * Only allow JS registration once |
||
18 | * @var bool |
||
19 | * @since 2.0.7 |
||
20 | */ |
||
21 | protected static $js_registration_done = false; |
||
22 | |||
23 | /** |
||
24 | * Only allow CSS registration once |
||
25 | * @var bool |
||
26 | * @since 2.0.7 |
||
27 | */ |
||
28 | protected static $css_registration_done = false; |
||
29 | |||
30 | /** |
||
31 | * CMB taxonomies array for term meta |
||
32 | * @var array |
||
33 | * @since 2.2.0 |
||
34 | */ |
||
35 | protected $taxonomies = array(); |
||
36 | |||
37 | /** |
||
38 | * Custom field columns. |
||
39 | * @var array |
||
40 | * @since 2.2.2 |
||
41 | */ |
||
42 | protected $columns = array(); |
||
43 | |||
44 | /** |
||
45 | * Constructor |
||
46 | * @since 2.0.0 |
||
47 | * @param CMB2 $cmb The CMB2 object to hookup |
||
48 | */ |
||
49 | public function __construct( CMB2 $cmb ) { |
||
50 | $this->cmb = $cmb; |
||
51 | $this->object_type = $this->cmb->mb_object_type(); |
||
52 | |||
53 | $this->universal_hooks(); |
||
54 | |||
55 | if ( is_admin() ) { |
||
56 | |||
57 | switch ( $this->object_type ) { |
||
58 | case 'post': |
||
59 | return $this->post_hooks(); |
||
60 | case 'comment': |
||
61 | return $this->comment_hooks(); |
||
62 | case 'user': |
||
63 | return $this->user_hooks(); |
||
64 | case 'term': |
||
65 | return $this->term_hooks(); |
||
66 | } |
||
67 | |||
68 | } |
||
69 | } |
||
70 | |||
71 | public function universal_hooks() { |
||
72 | foreach ( get_class_methods( 'CMB2_Show_Filters' ) as $filter ) { |
||
73 | add_filter( 'cmb2_show_on', array( 'CMB2_Show_Filters', $filter ), 10, 3 ); |
||
74 | } |
||
75 | |||
76 | if ( is_admin() ) { |
||
77 | // register our scripts and styles for cmb |
||
78 | $this->once( 'admin_enqueue_scripts', array( __CLASS__, 'register_scripts' ), 8 ); |
||
79 | $this->once( 'admin_enqueue_scripts', array( $this, 'do_scripts' ) ); |
||
80 | |||
81 | $this->maybe_enqueue_column_display_styles(); |
||
82 | } |
||
83 | } |
||
84 | |||
85 | public function post_hooks() { |
||
98 | |||
99 | public function comment_hooks() { |
||
108 | |||
109 | public function user_hooks() { |
||
110 | $priority = $this->get_priority(); |
||
111 | |||
112 | add_action( 'show_user_profile', array( $this, 'user_metabox' ), $priority ); |
||
113 | add_action( 'edit_user_profile', array( $this, 'user_metabox' ), $priority ); |
||
114 | add_action( 'user_new_form', array( $this, 'user_new_metabox' ), $priority ); |
||
115 | |||
116 | add_action( 'personal_options_update', array( $this, 'save_user' ) ); |
||
117 | add_action( 'edit_user_profile_update', array( $this, 'save_user' ) ); |
||
118 | add_action( 'user_register', array( $this, 'save_user' ) ); |
||
119 | |||
120 | View Code Duplication | if ( $this->cmb->has_columns ) { |
|
121 | add_filter( 'manage_users_columns', array( $this, 'register_column_headers' ) ); |
||
122 | add_filter( 'manage_users_custom_column', array( $this, 'return_column_display' ), 10, 3 ); |
||
123 | } |
||
124 | } |
||
125 | |||
126 | public function term_hooks() { |
||
127 | if ( ! function_exists( 'get_term_meta' ) ) { |
||
128 | wp_die( __( 'Term Metadata is a WordPress > 4.4 feature. Please upgrade your WordPress install.', 'cmb2' ) ); |
||
129 | } |
||
130 | |||
131 | if ( ! $this->cmb->prop( 'taxonomies' ) ) { |
||
132 | wp_die( __( 'Term metaboxes configuration requires a \'taxonomies\' parameter', 'cmb2' ) ); |
||
133 | } |
||
134 | |||
135 | $this->taxonomies = (array) $this->cmb->prop( 'taxonomies' ); |
||
136 | $show_on_term_add = $this->cmb->prop( 'new_term_section' ); |
||
137 | $priority = $this->get_priority( 8 ); |
||
138 | |||
139 | foreach ( $this->taxonomies as $taxonomy ) { |
||
140 | // Display our form data |
||
141 | add_action( "{$taxonomy}_edit_form", array( $this, 'term_metabox' ), $priority, 2 ); |
||
142 | |||
143 | $show_on_add = is_array( $show_on_term_add ) |
||
144 | ? in_array( $taxonomy, $show_on_term_add ) |
||
145 | : (bool) $show_on_term_add; |
||
146 | |||
147 | $show_on_add = apply_filters( "cmb2_show_on_term_add_form_{$this->cmb->cmb_id}", $show_on_add, $this->cmb ); |
||
148 | |||
149 | // Display form in add-new section (unless specified not to) |
||
150 | if ( $show_on_add ) { |
||
151 | add_action( "{$taxonomy}_add_form_fields", array( $this, 'term_metabox' ), $priority, 2 ); |
||
152 | } |
||
153 | |||
154 | View Code Duplication | if ( $this->cmb->has_columns ) { |
|
155 | add_filter( "manage_edit-{$taxonomy}_columns", array( $this, 'register_column_headers' ) ); |
||
156 | add_filter( "manage_{$taxonomy}_custom_column", array( $this, 'return_column_display' ), 10, 3 ); |
||
157 | } |
||
158 | } |
||
159 | |||
160 | add_action( 'created_term', array( $this, 'save_term' ), 10, 3 ); |
||
161 | add_action( 'edited_terms', array( $this, 'save_term' ), 10, 2 ); |
||
162 | add_action( 'delete_term', array( $this, 'delete_term' ), 10, 3 ); |
||
163 | |||
164 | } |
||
165 | |||
166 | /** |
||
167 | * Registers styles for CMB2 |
||
168 | * @since 2.0.7 |
||
169 | */ |
||
170 | 1 | protected static function register_styles() { |
|
171 | 1 | if ( self::$css_registration_done ) { |
|
172 | return; |
||
173 | } |
||
174 | |||
175 | // Only use minified files if SCRIPT_DEBUG is off |
||
176 | 1 | $min = defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ? '' : '.min'; |
|
177 | 1 | $front = is_admin() ? '' : '-front'; |
|
178 | 1 | $rtl = is_rtl() ? '-rtl' : ''; |
|
179 | |||
180 | // Filter required styles and register stylesheet |
||
181 | 1 | $dependencies = apply_filters( 'cmb2_style_dependencies', array() ); |
|
182 | 1 | wp_register_style( 'cmb2-styles', cmb2_utils()->url( "css/cmb2{$front}{$rtl}{$min}.css" ), $dependencies ); |
|
183 | 1 | wp_register_style( 'cmb2-display-styles', cmb2_utils()->url( "css/cmb2-display{$rtl}{$min}.css" ), $dependencies ); |
|
184 | |||
185 | 1 | self::$css_registration_done = true; |
|
186 | 1 | } |
|
187 | |||
188 | /** |
||
189 | * Registers scripts for CMB2 |
||
190 | * @since 2.0.7 |
||
191 | */ |
||
192 | 1 | protected static function register_js() { |
|
202 | |||
203 | /** |
||
204 | * Registers scripts and styles for CMB2 |
||
205 | * @since 1.0.0 |
||
206 | */ |
||
207 | public static function register_scripts() { |
||
211 | |||
212 | /** |
||
213 | * Enqueues scripts and styles for CMB2 in admin_head. |
||
214 | * @since 1.0.0 |
||
215 | */ |
||
216 | public function do_scripts( $hook ) { |
||
240 | |||
241 | /** |
||
242 | * Register the CMB2 field column headers. |
||
243 | * @since 2.2.2 |
||
244 | */ |
||
245 | public function register_column_headers( $columns ) { |
||
272 | |||
273 | /** |
||
274 | * The CMB2 field column display output. |
||
275 | * @since 2.2.2 |
||
276 | */ |
||
277 | public function column_display( $column_name, $object_id ) { |
||
289 | |||
290 | /** |
||
291 | * Returns the column display. |
||
292 | * @since 2.2.2 |
||
293 | */ |
||
294 | public function return_column_display( $empty, $custom_column, $object_id ) { |
||
301 | |||
302 | /** |
||
303 | * Add metaboxes (to 'post' or 'comment' object types) |
||
304 | * @since 1.0.0 |
||
305 | */ |
||
306 | public function add_metaboxes() { |
||
337 | |||
338 | /** |
||
339 | * Remove the specified default taxonomy metaboxes for a post-type. |
||
340 | * @since 2.2.3 |
||
341 | * @param string $post_type Post type to remove the metabox for. |
||
342 | */ |
||
343 | protected function remove_default_tax_metaboxes( $post_type ) { |
||
353 | |||
354 | /** |
||
355 | * Add 'closed' class to metabox |
||
356 | * @since 2.0.0 |
||
357 | * @param array $classes Array of classes |
||
358 | * @return array Modified array of classes |
||
359 | */ |
||
360 | public function close_metabox_class( $classes ) { |
||
364 | |||
365 | /** |
||
366 | * Display metaboxes for a post or comment object |
||
367 | * @since 1.0.0 |
||
368 | */ |
||
369 | public function metabox_callback() { |
||
373 | |||
374 | /** |
||
375 | * Display metaboxes for new user page |
||
376 | * @since 1.0.0 |
||
377 | */ |
||
378 | public function user_new_metabox( $section ) { |
||
385 | |||
386 | /** |
||
387 | * Display metaboxes for a user object |
||
388 | * @since 1.0.0 |
||
389 | */ |
||
390 | public function user_metabox() { |
||
393 | |||
394 | /** |
||
395 | * Display metaboxes for a taxonomy term object |
||
396 | * @since 2.2.0 |
||
397 | */ |
||
398 | public function term_metabox() { |
||
401 | |||
402 | /** |
||
403 | * Display metaboxes for an object type |
||
404 | * @since 2.2.0 |
||
405 | * @param string $type Object type |
||
406 | * @return void |
||
407 | */ |
||
408 | public function show_form_for_type( $type ) { |
||
426 | |||
427 | /** |
||
428 | * Determines if metabox should be shown in current context |
||
429 | * @since 2.0.0 |
||
430 | * @return bool Whether metabox should be added/shown |
||
431 | */ |
||
432 | public function show_on() { |
||
447 | |||
448 | /** |
||
449 | * Get the CMB priority property set to numeric hook priority. |
||
450 | * @since 2.2.0 |
||
451 | * @param integer $default Default display hook priority. |
||
452 | * @return integer Hook priority. |
||
453 | */ |
||
454 | public function get_priority( $default = 10 ) { |
||
476 | |||
477 | /** |
||
478 | * Save data from post metabox |
||
479 | * @since 1.0.0 |
||
480 | * @param int $post_id Post ID |
||
481 | * @param mixed $post Post object |
||
482 | * @return null |
||
483 | */ |
||
484 | public function save_post( $post_id, $post = false ) { |
||
503 | |||
504 | /** |
||
505 | * Save data from comment metabox |
||
506 | * @since 2.0.9 |
||
507 | * @param int $comment_id Comment ID |
||
508 | * @return null |
||
509 | */ |
||
510 | public function save_comment( $comment_id ) { |
||
518 | |||
519 | /** |
||
520 | * Save data from user fields |
||
521 | * @since 1.0.x |
||
522 | * @param int $user_id User ID |
||
523 | * @return null |
||
524 | */ |
||
525 | public function save_user( $user_id ) { |
||
531 | |||
532 | /** |
||
533 | * Save data from term fields |
||
534 | * @since 2.2.0 |
||
535 | * @param int $term_id Term ID |
||
536 | * @param int $tt_id Term Taxonomy ID |
||
537 | * @param string $taxonomy Taxonomy |
||
538 | * @return null |
||
539 | */ |
||
540 | public function save_term( $term_id, $tt_id, $taxonomy = '' ) { |
||
548 | |||
549 | /** |
||
550 | * Delete term meta when a term is deleted. |
||
551 | * @since 2.2.0 |
||
552 | * @param int $term_id Term ID |
||
553 | * @param int $tt_id Term Taxonomy ID |
||
554 | * @param string $taxonomy Taxonomy |
||
555 | * @return null |
||
556 | */ |
||
557 | public function delete_term( $term_id, $tt_id, $taxonomy = '' ) { |
||
567 | |||
568 | /** |
||
569 | * Determines if the current object is able to be saved |
||
570 | * @since 2.0.9 |
||
571 | * @param string $type Current post_type or comment_type |
||
572 | * @return bool Whether object can be saved |
||
573 | */ |
||
574 | public function can_save( $type = '' ) { |
||
586 | |||
587 | /** |
||
588 | * Determine if taxonomy of term being modified is cmb2-editable. |
||
589 | * @since 2.2.0 |
||
590 | * @param string $taxonomy Taxonomy of term being modified. |
||
591 | * @return bool Whether taxonomy is editable. |
||
592 | */ |
||
593 | public function taxonomy_can_save( $taxonomy ) { |
||
606 | |||
607 | /** |
||
608 | * Enqueues the 'cmb2-display-styles' if the conditions match (has columns, on the right page, etc). |
||
609 | * @since 2.2.2.1 |
||
610 | */ |
||
611 | protected function maybe_enqueue_column_display_styles() { |
||
622 | |||
623 | /** |
||
624 | * Includes CMB2 styles |
||
625 | * @since 2.0.0 |
||
626 | */ |
||
627 | 1 | public static function enqueue_cmb_css( $handle = 'cmb2-styles' ) { |
|
640 | 1 | ||
641 | /** |
||
642 | * Includes CMB2 JS |
||
643 | * @since 2.0.0 |
||
644 | */ |
||
645 | public static function enqueue_cmb_js() { |
||
653 | |||
654 | } |
||
655 |
You can fix this by adding a namespace to your class:
When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries.