Total Complexity | 43 |
Total Lines | 260 |
Duplicated Lines | 0 % |
Changes | 6 | ||
Bugs | 1 | Features | 0 |
Complex classes like Settings 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.
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 Settings, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
9 | class Settings { |
||
10 | |||
11 | /** |
||
12 | * Holds class instance |
||
13 | * |
||
14 | * @since 1.0.0 |
||
15 | * |
||
16 | * @var object \lsx\sharing\classes\admin\Settings() |
||
17 | */ |
||
18 | protected static $instance = null; |
||
19 | |||
20 | /** |
||
21 | * Contructor |
||
22 | */ |
||
23 | public function __construct() { |
||
24 | add_action( 'cmb2_admin_init', array( $this, 'register_settings_page' ) ); |
||
|
|||
25 | add_action( 'lsx_sharing_settings_page', array( $this, 'configure_general_fields' ), 15, 1 ); |
||
26 | add_action( 'lsx_sharing_settings_page', array( $this, 'configure_archive_fields' ), 15, 1 ); |
||
27 | add_action( 'admin_enqueue_scripts', array( $this, 'assets' ) ); |
||
28 | } |
||
29 | |||
30 | /** |
||
31 | * Return an instance of this class. |
||
32 | * |
||
33 | * @since 1.0.0 |
||
34 | * |
||
35 | * @return object \lsx\sharing\classes\admin\Settings() A single instance of this class. |
||
36 | */ |
||
37 | public static function get_instance() { |
||
38 | // If the single instance hasn't been set, set it now. |
||
39 | if ( null == self::$instance ) { |
||
40 | self::$instance = new self(); |
||
41 | } |
||
42 | return self::$instance; |
||
43 | } |
||
44 | |||
45 | /** |
||
46 | * Configure fields for the Settings page. |
||
47 | * |
||
48 | * @return void |
||
49 | */ |
||
50 | public function register_settings_page() { |
||
62 | } |
||
63 | |||
64 | /** |
||
65 | * Enqueue JS and CSS. |
||
66 | */ |
||
67 | public function assets( $hook ) { |
||
70 | } |
||
71 | |||
72 | /** |
||
73 | * Enable Business Directory Search settings only if LSX Search plugin is enabled. |
||
74 | * |
||
75 | * @return void |
||
76 | */ |
||
77 | public function configure_general_fields( $cmb ) { |
||
83 | } |
||
84 | |||
85 | /** |
||
86 | * Enable Sharing settings only if LSX Search plugin is enabled. |
||
87 | * |
||
88 | * @param object $cmb The CMB2() class. |
||
89 | * @param string $position either top of bottom. |
||
90 | * @return void |
||
91 | */ |
||
92 | public function configure_archive_fields( $cmb ) { |
||
93 | $archives = array(); |
||
94 | $post_type_args = array( |
||
95 | 'public' => true, |
||
96 | ); |
||
97 | $post_types = get_post_types( $post_type_args ); |
||
98 | if ( ! empty( $post_types ) ) { |
||
99 | foreach ( $post_types as $post_type_key => $post_type_value ) { |
||
100 | switch ( $post_type_key ) { |
||
101 | case 'post': |
||
102 | $page_url = home_url(); |
||
103 | $page_title = __( 'Home', 'lsx-search' ); |
||
104 | $show_on_front = get_option( 'show_on_front' ); |
||
105 | if ( 'page' === $show_on_front ) { |
||
106 | $page_for_posts = get_option( 'page_for_posts' ); |
||
107 | if ( '' !== $page_for_posts ) { |
||
108 | $page_title = get_the_title( $page_for_posts ); |
||
109 | $page_url = get_permalink( $page_for_posts ); |
||
110 | } |
||
111 | } |
||
112 | $description = sprintf( |
||
113 | /* translators: %s: The subscription info */ |
||
114 | __( 'Control the filters which show on your <a target="_blank" href="%1$s">%2$s</a> posts.', 'lsx-search' ), |
||
115 | $page_url, |
||
116 | $page_title |
||
117 | ); |
||
118 | $archives[ $post_type_key ] = array( |
||
119 | 'title' => __( 'Blog', 'lsx-search' ), |
||
120 | 'desc' => $description, |
||
121 | ); |
||
122 | break; |
||
123 | |||
124 | case 'product': |
||
125 | $page_url = home_url(); |
||
126 | $page_title = __( 'Shop', 'lsx-search' ); |
||
127 | if ( function_exists( 'wc_get_page_id' ) ) { |
||
128 | $shop_page = wc_get_page_id( 'shop' ); |
||
129 | $page_url = get_permalink( $shop_page ); |
||
130 | $page_title = get_the_title( $shop_page ); |
||
131 | } |
||
132 | $description = sprintf( |
||
133 | /* translators: %s: The subscription info */ |
||
134 | __( 'Control the filters which show on your <a target="_blank" href="%1$s">%2$s</a> product pages.', 'lsx-search' ), |
||
135 | $page_url, |
||
136 | $page_title |
||
137 | ); |
||
138 | $archives[ $post_type_key ] = array( |
||
139 | 'title' => __( 'Shop', 'lsx-search' ), |
||
140 | 'desc' => $description, |
||
141 | ); |
||
142 | break; |
||
143 | |||
144 | case 'page': |
||
145 | case 'attachment': |
||
146 | case 'forum': |
||
147 | case 'topic': |
||
148 | case 'lesson': |
||
149 | case 'quiz': |
||
150 | case 'question': |
||
151 | case 'reply': |
||
152 | case 'popup': |
||
153 | case 'sensei_message': |
||
154 | case 'envira': |
||
155 | case 'soliloquy': |
||
156 | case 'certificate_template': |
||
157 | case 'certificate': |
||
158 | case 'project': |
||
159 | break; |
||
160 | |||
161 | default: |
||
162 | $temp_post_type = get_post_type_object( $post_type_key ); |
||
163 | if ( ! is_wp_error( $temp_post_type ) ) { |
||
164 | $page_url = get_post_type_archive_link( $temp_post_type->name ); |
||
165 | $description = sprintf( |
||
166 | /* translators: %s: The subscription info */ |
||
167 | __( 'Control the filters which show on your <a target="_blank" href="%1$s">%2$s</a> singles.', 'lsx-search' ), |
||
168 | $page_url, |
||
169 | $temp_post_type->label |
||
170 | ); |
||
171 | |||
172 | $archives[ $post_type_key ] = array( |
||
173 | 'title' => $temp_post_type->label, |
||
174 | 'desc' => $description, |
||
175 | ); |
||
176 | } |
||
177 | break; |
||
178 | } |
||
179 | } |
||
180 | } |
||
181 | if ( ! empty( $archives ) ) { |
||
182 | foreach ( $archives as $archive_key => $archive_args ) { |
||
183 | $this->get_fields( $cmb, $archive_key, $archive_args ); |
||
184 | } |
||
185 | } |
||
186 | } |
||
187 | /** |
||
188 | * Gets the sharing fields and loops through them. |
||
189 | * |
||
190 | * @param object $cmb |
||
191 | * @param string $section |
||
192 | * @param array $args |
||
193 | * @return void |
||
194 | */ |
||
195 | public function get_fields( $cmb, $section, $args ) { |
||
269 | ) |
||
270 | ); |
||
273 |