Total Complexity | 41 |
Total Lines | 294 |
Duplicated Lines | 0 % |
Changes | 1 | ||
Bugs | 0 | Features | 0 |
Complex classes like MonsterInsights_Tracking_Analytics 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 MonsterInsights_Tracking_Analytics, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
16 | class MonsterInsights_Tracking_Analytics extends MonsterInsights_Tracking_Abstract { |
||
17 | |||
18 | /** |
||
19 | * Holds the name of the tracking type. |
||
20 | * |
||
21 | * @since 6.0.0 |
||
22 | * @access public |
||
23 | * |
||
24 | * @var string $name Name of the tracking type. |
||
25 | */ |
||
26 | public $name = 'analytics'; |
||
27 | |||
28 | /** |
||
29 | * Version of the tracking class. |
||
30 | * |
||
31 | * @since 6.0.0 |
||
32 | * @access public |
||
33 | * |
||
34 | * @var string $version Version of the tracking class. |
||
35 | */ |
||
36 | public $version = '1.0.0'; |
||
37 | |||
38 | /** |
||
39 | * Primary class constructor. |
||
40 | * |
||
41 | * @since 6.0.0 |
||
42 | * @access public |
||
43 | */ |
||
44 | public function __construct() { |
||
45 | |||
46 | } |
||
47 | |||
48 | /** |
||
49 | * Get frontend tracking options. |
||
50 | * |
||
51 | * This function is used to return an array of parameters |
||
52 | * for the frontend_output() function to output. These are |
||
53 | * generally dimensions and turned on GA features. |
||
54 | * |
||
55 | * @since 6.0.0 |
||
56 | * @access public |
||
57 | * |
||
58 | * @return array Array of the options to use. |
||
59 | */ |
||
60 | public function frontend_tracking_options( ) { |
||
162 | } |
||
163 | |||
164 | /** |
||
165 | * Get frontend output. |
||
166 | * |
||
167 | * This function is used to return the Javascript |
||
168 | * to output in the head of the page for the given |
||
169 | * tracking method. |
||
170 | * |
||
171 | * @since 6.0.0 |
||
172 | * @access public |
||
173 | * |
||
174 | * @return string Javascript to output. |
||
175 | */ |
||
176 | public function frontend_output( ) { |
||
177 | $options = $this->frontend_tracking_options(); |
||
178 | $is_debug_mode = monsterinsights_is_debug_mode(); |
||
179 | $src = apply_filters( 'monsterinsights_frontend_output_analytics_src', '//www.google-analytics.com/analytics.js' ); |
||
180 | if ( current_user_can( 'manage_options' ) && $is_debug_mode ) { |
||
181 | $src = apply_filters( 'monsterinsights_frontend_output_analytics_src', '//www.google-analytics.com/analytics_debug.js' ); |
||
182 | } |
||
183 | $compat = monsterinsights_get_option( 'gatracker_compatibility_mode', false ); |
||
184 | $compat = $compat ? 'window.ga = __gaTracker;' : ''; |
||
185 | $track_user = monsterinsights_track_user(); |
||
186 | $ua = monsterinsights_get_ua(); |
||
187 | $output = ''; |
||
188 | $reason = ''; |
||
189 | ob_start(); |
||
190 | ?> |
||
191 | <!-- This site uses the Google Analytics by MonsterInsights plugin v<?php echo MONSTERINSIGHTS_VERSION; ?> - Using Analytics tracking - https://www.monsterinsights.com/ --> |
||
192 | <?php if ( ! $track_user ) { |
||
193 | if ( empty( $ua ) ) { |
||
194 | $reason = __( 'Note: MonsterInsights is not currently configured on this site. The site owner needs to authenticate with Google Analytics in the MonsterInsights settings panel.', 'google-analytics-for-wordpress' ); |
||
195 | $output .= '<!-- ' . esc_html( $reason ) . ' -->' . PHP_EOL; |
||
196 | } else if ( current_user_can( 'monsterinsights_save_settings' ) ) { |
||
197 | $reason = __( 'Note: MonsterInsights does not track you as a logged in site administrator to prevent site owners from accidentally skewing their own Google Analytics data.'. PHP_EOL . 'If you are testing Google Analytics code, please do so either logged out or in the private browsing/incognito mode of your web browser.', 'google-analytics-for-wordpress' ); |
||
198 | $output .= '<!-- ' . esc_html( $reason ) . ' -->' . PHP_EOL; |
||
199 | } else { |
||
200 | $reason = __( 'Note: The site owner has disabled Google Analytics tracking for your user role.', 'google-analytics-for-wordpress' ); |
||
201 | $output .= '<!-- ' . esc_html( $reason ) . ' -->' . PHP_EOL; |
||
202 | } |
||
203 | echo $output; |
||
204 | } ?> |
||
205 | <?php if ( $ua ) { ?> |
||
206 | <script type="text/javascript" data-cfasync="false"> |
||
207 | var mi_track_user = <?php echo ( $track_user ? 'true' : 'false' ); ?>; |
||
208 | <?php if ( $this->should_do_optout() ) { ?> |
||
209 | var disableStr = 'ga-disable-<?php echo monsterinsights_get_ua(); ?>'; |
||
210 | |||
211 | /* Function to detect opted out users */ |
||
212 | function __gaTrackerIsOptedOut() { |
||
213 | return document.cookie.indexOf(disableStr + '=true') > -1; |
||
214 | } |
||
215 | |||
216 | /* Disable tracking if the opt-out cookie exists. */ |
||
217 | if ( __gaTrackerIsOptedOut() ) { |
||
218 | window[disableStr] = true; |
||
219 | } |
||
220 | |||
221 | /* Opt-out function */ |
||
222 | function __gaTrackerOptout() { |
||
223 | document.cookie = disableStr + '=true; expires=Thu, 31 Dec 2099 23:59:59 UTC; path=/'; |
||
224 | window[disableStr] = true; |
||
225 | } |
||
226 | <?php } ?> |
||
227 | |||
228 | if ( mi_track_user ) { |
||
229 | (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ |
||
230 | (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), |
||
231 | m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) |
||
232 | })(window,document,'script','<?php echo $src; ?>','__gaTracker'); |
||
233 | |||
234 | <?php |
||
235 | if ( current_user_can( 'manage_options' ) && $is_debug_mode ) { |
||
236 | echo 'window.ga_debug = {trace: true};'; |
||
237 | } |
||
238 | |||
239 | echo $compat; |
||
240 | |||
241 | if ( count( $options ) >= 1 ) { |
||
242 | foreach ( $options as $item ) { |
||
243 | if ( ! is_array( $item ) ) { |
||
244 | echo ' __gaTracker(' . $item . ");\n"; |
||
245 | } else if ( ! empty ( $item['value'] ) ) { |
||
246 | echo ' ' . $item['value'] . "\n"; |
||
247 | } |
||
248 | } |
||
249 | } |
||
250 | ?> |
||
251 | } else { |
||
252 | <?php if ( $this->should_do_optout() ) { ?> |
||
253 | console.log( "<?php echo esc_js( $reason );?>" ); |
||
254 | (function() { |
||
255 | /* https://developers.google.com/analytics/devguides/collection/analyticsjs/ */ |
||
256 | var noopfn = function() { |
||
257 | return null; |
||
258 | }; |
||
259 | var noopnullfn = function() { |
||
260 | return null; |
||
261 | }; |
||
262 | var Tracker = function() { |
||
263 | return null; |
||
264 | }; |
||
265 | var p = Tracker.prototype; |
||
266 | p.get = noopfn; |
||
267 | p.set = noopfn; |
||
268 | p.send = noopfn; |
||
269 | var __gaTracker = function() { |
||
270 | var len = arguments.length; |
||
271 | if ( len === 0 ) { |
||
272 | return; |
||
273 | } |
||
274 | var f = arguments[len-1]; |
||
275 | if ( typeof f !== 'object' || f === null || typeof f.hitCallback !== 'function' ) { |
||
276 | console.log( '<?php echo esc_js( __('Not running function', 'google-analytics-for-wordpress' ) );?> __gaTracker(' + arguments[0] + " ....) <?php echo esc_js( sprintf( __( "because you're not being tracked. %s", 'google-analytics-for-wordpress' ), $reason ) );?>"); |
||
277 | return; |
||
278 | } |
||
279 | try { |
||
280 | f.hitCallback(); |
||
281 | } catch (ex) { |
||
282 | |||
283 | } |
||
284 | }; |
||
285 | __gaTracker.create = function() { |
||
286 | return new Tracker(); |
||
287 | }; |
||
288 | __gaTracker.getByName = noopnullfn; |
||
289 | __gaTracker.getAll = function() { |
||
290 | return []; |
||
291 | }; |
||
292 | __gaTracker.remove = noopfn; |
||
293 | window['__gaTracker'] = __gaTracker; |
||
294 | })(); |
||
295 | <?php } ?> |
||
296 | } |
||
297 | </script> |
||
298 | <?php } else { ?> |
||
299 | <!-- No UA code set --> |
||
300 | <?php } ?> |
||
301 | <!-- / Google Analytics by MonsterInsights --> |
||
302 | <?php |
||
303 | $output = ob_get_contents(); |
||
304 | ob_end_clean(); |
||
305 | return $output; |
||
306 | } |
||
307 | |||
308 | public function should_do_optout() { |
||
310 | } |
||
311 | } |
||
312 |