Complex classes like Jetpack_User_Agent_Info 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 Jetpack_User_Agent_Info, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
21 | class Jetpack_User_Agent_Info { |
||
22 | |||
23 | /** |
||
24 | * User_Agent_Info instance from the `jetpack-device-detection` package. |
||
25 | * |
||
26 | * @var User_Agent_Info |
||
27 | */ |
||
28 | private $ua_info; |
||
29 | |||
30 | /** |
||
31 | * The constructor. |
||
32 | * |
||
33 | * @param string $ua (Optional) User agent. |
||
34 | */ |
||
35 | public function __construct( $ua = '' ) { |
||
39 | |||
40 | /** |
||
41 | * This method detects the mobile User Agent name. |
||
42 | * |
||
43 | * @return string The matched User Agent name, false otherwise. |
||
44 | */ |
||
45 | public function get_mobile_user_agent_name() { |
||
49 | |||
50 | /** |
||
51 | * This method detects the mobile device's platform. All return strings are from the class constants. |
||
52 | * Note that this function returns the platform name, not the UA name/type. You should use a different function |
||
53 | * if you need to test the UA capabilites. |
||
54 | * |
||
55 | * @return string Name of the platform, false otherwise. |
||
56 | */ |
||
57 | public function get_platform() { |
||
61 | |||
62 | /** |
||
63 | * This method detects for UA which can display iPhone-optimized web content. |
||
64 | * Includes iPhone, iPod Touch, Android, WebOS, Fennec (Firefox mobile), etc. |
||
65 | */ |
||
66 | public function isTierIphone() { |
||
70 | |||
71 | /** |
||
72 | * This method detects for UA which are likely to be capable |
||
73 | * but may not necessarily support JavaScript. |
||
74 | * Excludes all iPhone Tier UA. |
||
75 | */ |
||
76 | public function isTierRichCss() { |
||
80 | |||
81 | /** |
||
82 | * Detects if the user is using a tablet. |
||
83 | * props Corey Gilmore, BGR.com |
||
84 | * |
||
85 | * @return bool |
||
86 | */ |
||
87 | public function is_tablet() { |
||
91 | |||
92 | /** |
||
93 | * Detects if the current UA is the default iPhone or iPod Touch Browser. |
||
94 | * |
||
95 | * DEPRECATED: use is_iphone_or_ipod |
||
96 | */ |
||
97 | public function is_iphoneOrIpod() { |
||
101 | |||
102 | |||
103 | /** |
||
104 | * Detects if the current UA is iPhone Mobile Safari or another iPhone or iPod Touch Browser. |
||
105 | * |
||
106 | * They type can check for any iPhone, an iPhone using Safari, or an iPhone using something other than Safari. |
||
107 | * |
||
108 | * Note: If you want to check for Opera mini, Opera mobile or Firefox mobile (or any 3rd party iPhone browser), |
||
109 | * you should put the check condition before the check for 'iphone-any' or 'iphone-not-safari'. |
||
110 | * Otherwise those browsers will be 'catched' by the iphone string. |
||
111 | * |
||
112 | * @param string $type Type of iPhone detection. |
||
113 | */ |
||
114 | public static function is_iphone_or_ipod( $type = 'iphone-any' ) { |
||
118 | |||
119 | /** |
||
120 | * Detects if the current UA is Chrome for iOS |
||
121 | * |
||
122 | * The User-Agent string in Chrome for iOS is the same as the Mobile Safari User-Agent, with CriOS/<ChromeRevision> instead of Version/<VersionNum>. |
||
123 | * - Mozilla/5.0 (iPhone; U; CPU iPhone OS 5_1_1 like Mac OS X; en) AppleWebKit/534.46.0 (KHTML, like Gecko) CriOS/19.0.1084.60 Mobile/9B206 Safari/7534.48.3 |
||
124 | */ |
||
125 | public static function is_chrome_for_iOS() { |
||
129 | |||
130 | /** |
||
131 | * Detects if the current UA is Twitter for iPhone |
||
132 | * |
||
133 | * Mozilla/5.0 (iPhone; U; CPU iPhone OS 4_3_5 like Mac OS X; nb-no) AppleWebKit/533.17.9 (KHTML, like Gecko) Mobile/8L1 Twitter for iPhone |
||
134 | * Mozilla/5.0 (iPhone; CPU iPhone OS 5_1_1 like Mac OS X) AppleWebKit/534.46 (KHTML, like Gecko) Mobile/9B206 Twitter for iPhone |
||
135 | */ |
||
136 | public static function is_twitter_for_iphone() { |
||
140 | |||
141 | /** |
||
142 | * Detects if the current UA is Twitter for iPad |
||
143 | * |
||
144 | * Old version 4.X - Mozilla/5.0 (iPad; U; CPU OS 4_3_5 like Mac OS X; en-us) AppleWebKit/533.17.9 (KHTML, like Gecko) Mobile/8L1 Twitter for iPad |
||
145 | * Ver 5.0 or Higher - Mozilla/5.0 (iPad; CPU OS 5_1_1 like Mac OS X) AppleWebKit/534.46 (KHTML, like Gecko) Mobile/9B206 Twitter for iPhone |
||
146 | */ |
||
147 | public static function is_twitter_for_ipad() { |
||
151 | |||
152 | /** |
||
153 | * Detects if the current UA is Facebook for iPhone |
||
154 | * - Facebook 4020.0 (iPhone; iPhone OS 5.0.1; fr_FR) |
||
155 | * - Mozilla/5.0 (iPhone; U; CPU iPhone OS 5_0 like Mac OS X; en_US) AppleWebKit (KHTML, like Gecko) Mobile [FBAN/FBForIPhone;FBAV/4.0.2;FBBV/4020.0;FBDV/iPhone3,1;FBMD/iPhone;FBSN/iPhone OS;FBSV/5.0;FBSS/2; FBCR/O2;FBID/phone;FBLC/en_US;FBSF/2.0] |
||
156 | * - Mozilla/5.0 (iPhone; CPU iPhone OS 5_1_1 like Mac OS X) AppleWebKit/534.46 (KHTML, like Gecko) Mobile/9B206 [FBAN/FBIOS;FBAV/5.0;FBBV/47423;FBDV/iPhone3,1;FBMD/iPhone;FBSN/iPhone OS;FBSV/5.1.1;FBSS/2; FBCR/3ITA;FBID/phone;FBLC/en_US] |
||
157 | */ |
||
158 | public static function is_facebook_for_iphone() { |
||
162 | |||
163 | /** |
||
164 | * Detects if the current UA is Facebook for iPad |
||
165 | * - Facebook 4020.0 (iPad; iPhone OS 5.0.1; en_US) |
||
166 | * - Mozilla/5.0 (iPad; U; CPU iPhone OS 5_0 like Mac OS X; en_US) AppleWebKit (KHTML, like Gecko) Mobile [FBAN/FBForIPhone;FBAV/4.0.2;FBBV/4020.0;FBDV/iPad2,1;FBMD/iPad;FBSN/iPhone OS;FBSV/5.0;FBSS/1; FBCR/;FBID/tablet;FBLC/en_US;FBSF/1.0] |
||
167 | * - Mozilla/5.0 (iPad; CPU OS 6_0 like Mac OS X) AppleWebKit/536.26 (KHTML, like Gecko) Mobile/10A403 [FBAN/FBIOS;FBAV/5.0;FBBV/47423;FBDV/iPad2,1;FBMD/iPad;FBSN/iPhone OS;FBSV/6.0;FBSS/1; FBCR/;FBID/tablet;FBLC/en_US] |
||
168 | */ |
||
169 | public static function is_facebook_for_ipad() { |
||
173 | |||
174 | /** |
||
175 | * Detects if the current UA is WordPress for iOS |
||
176 | */ |
||
177 | public static function is_wordpress_for_ios() { |
||
181 | |||
182 | /** |
||
183 | * Detects if the current device is an iPad. |
||
184 | * They type can check for any iPad, an iPad using Safari, or an iPad using something other than Safari. |
||
185 | * |
||
186 | * Note: If you want to check for Opera mini, Opera mobile or Firefox mobile (or any 3rd party iPad browser), |
||
187 | * you should put the check condition before the check for 'iphone-any' or 'iphone-not-safari'. |
||
188 | * Otherwise those browsers will be 'catched' by the ipad string. |
||
189 | * |
||
190 | * @param string $type iPad type. |
||
191 | */ |
||
192 | public static function is_ipad( $type = 'ipad-any' ) { |
||
196 | |||
197 | /** |
||
198 | * Detects if the current browser is Firefox Mobile (Fennec) |
||
199 | * |
||
200 | * See http://www.useragentstring.com/pages/Fennec/ |
||
201 | * Mozilla/5.0 (Windows NT 6.1; WOW64; rv:2.1.1) Gecko/20110415 Firefox/4.0.2pre Fennec/4.0.1 |
||
202 | * Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9.1b2pre) Gecko/20081015 Fennec/1.0a1 |
||
203 | */ |
||
204 | public static function is_firefox_mobile() { |
||
208 | |||
209 | /** |
||
210 | * Detects if the current browser is Firefox for desktop |
||
211 | * |
||
212 | * See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/User-Agent/Firefox |
||
213 | * Mozilla/5.0 (platform; rv:geckoversion) Gecko/geckotrail Firefox/firefoxversion |
||
214 | * The platform section will include 'Mobile' for phones and 'Tablet' for tablets. |
||
215 | */ |
||
216 | public static function is_firefox_desktop() { |
||
220 | |||
221 | /** |
||
222 | * Detects if the current browser is FirefoxOS Native browser |
||
223 | * |
||
224 | * Mozilla/5.0 (Mobile; rv:14.0) Gecko/14.0 Firefox/14.0 |
||
225 | */ |
||
226 | public static function is_firefox_os() { |
||
230 | |||
231 | /** |
||
232 | * Detects if the current browser is Opera Mobile |
||
233 | * |
||
234 | * What is the difference between Opera Mobile and Opera Mini? |
||
235 | * - Opera Mobile is a full Internet browser for mobile devices. |
||
236 | * - Opera Mini always uses a transcoder to convert the page for a small display. |
||
237 | * (it uses Opera advanced server compression technology to compress web content before it gets to a device. |
||
238 | * The rendering engine is on Opera's server.) |
||
239 | * |
||
240 | * Opera/9.80 (Windows NT 6.1; Opera Mobi/14316; U; en) Presto/2.7.81 Version/11.00" |
||
241 | * Opera/9.50 (Nintendo DSi; Opera/507; U; en-US) |
||
242 | */ |
||
243 | public static function is_opera_mobile() { |
||
247 | |||
248 | |||
249 | /** |
||
250 | * Detects if the current browser is Opera Mini |
||
251 | * |
||
252 | * Opera/8.01 (J2ME/MIDP; Opera Mini/3.0.6306/1528; en; U; ssr) |
||
253 | * Opera/9.80 (Android;Opera Mini/6.0.24212/24.746 U;en) Presto/2.5.25 Version/10.5454 |
||
254 | * Opera/9.80 (iPhone; Opera Mini/5.0.019802/18.738; U; en) Presto/2.4.15 |
||
255 | * Opera/9.80 (J2ME/iPhone;Opera Mini/5.0.019802/886; U; ja) Presto/2.4.15 |
||
256 | * Opera/9.80 (J2ME/iPhone;Opera Mini/5.0.019802/886; U; ja) Presto/2.4.15 |
||
257 | * Opera/9.80 (Series 60; Opera Mini/5.1.22783/23.334; U; en) Presto/2.5.25 Version/10.54 |
||
258 | * Opera/9.80 (BlackBerry; Opera Mini/5.1.22303/22.387; U; en) Presto/2.5.25 Version/10.54 |
||
259 | */ |
||
260 | public static function is_opera_mini() { |
||
264 | |||
265 | /** |
||
266 | * Detects if the current browser is Opera Mini, but not on a smart device OS(Android, iOS, etc) |
||
267 | * Used to send users on dumb devices to m.wor |
||
268 | */ |
||
269 | public static function is_opera_mini_dumb() { |
||
273 | |||
274 | /** |
||
275 | * Detects if the current browser is Opera Mobile or Mini. |
||
276 | * DEPRECATED: use is_opera_mobile or is_opera_mini |
||
277 | * |
||
278 | * Opera Mini 5 Beta: Opera/9.80 (J2ME/MIDP; Opera Mini/5.0.15650/756; U; en) Presto/2.2.0 |
||
279 | * Opera Mini 8: Opera/8.01 (J2ME/MIDP; Opera Mini/3.0.6306/1528; en; U; ssr) |
||
280 | */ |
||
281 | public static function is_OperaMobile() { |
||
285 | |||
286 | /** |
||
287 | * Detects if the current browser is a Windows Phone 7 device. |
||
288 | * ex: Mozilla/4.0 (compatible; MSIE 7.0; Windows Phone OS 7.0; Trident/3.1; IEMobile/7.0; LG; GW910) |
||
289 | */ |
||
290 | public static function is_WindowsPhone7() { |
||
294 | |||
295 | /** |
||
296 | * Detects if the current browser is a Windows Phone 8 device. |
||
297 | * ex: Mozilla/5.0 (compatible; MSIE 10.0; Windows Phone 8.0; Trident/6.0; ARM; Touch; IEMobile/10.0; <Manufacturer>; <Device> [;<Operator>]) |
||
298 | */ |
||
299 | public static function is_windows_phone_8() { |
||
303 | |||
304 | |||
305 | /** |
||
306 | * Detects if the current browser is on a Palm device running the new WebOS. This EXCLUDES TouchPad. |
||
307 | * |
||
308 | * Ex1: Mozilla/5.0 (webOS/1.4.0; U; en-US) AppleWebKit/532.2 (KHTML, like Gecko) Version/1.0 Safari/532.2 Pre/1.1 |
||
309 | * Ex2: Mozilla/5.0 (webOS/1.4.0; U; en-US) AppleWebKit/532.2 (KHTML, like Gecko) Version/1.0 Safari/532.2 Pixi/1.1 |
||
310 | */ |
||
311 | public static function is_PalmWebOS() { |
||
315 | |||
316 | /** |
||
317 | * Detects if the current browser is the HP TouchPad default browser. This excludes phones wt WebOS. |
||
318 | * |
||
319 | * TouchPad Emulator: Mozilla/5.0 (hp-desktop; Linux; hpwOS/2.0; U; it-IT) AppleWebKit/534.6 (KHTML, like Gecko) wOSBrowser/233.70 Safari/534.6 Desktop/1.0 |
||
320 | * TouchPad: Mozilla/5.0 (hp-tablet; Linux; hpwOS/3.0.0; U; en-US) AppleWebKit/534.6 (KHTML, like Gecko) wOSBrowser/233.70 Safari/534.6 TouchPad/1.0 |
||
321 | */ |
||
322 | public static function is_TouchPad() { |
||
326 | |||
327 | |||
328 | /** |
||
329 | * Detects if the current browser is the Series 60 Open Source Browser. |
||
330 | * |
||
331 | * OSS Browser 3.2 on E75: Mozilla/5.0 (SymbianOS/9.3; U; Series60/3.2 NokiaE75-1/110.48.125 Profile/MIDP-2.1 Configuration/CLDC-1.1 ) AppleWebKit/413 (KHTML, like Gecko) Safari/413 |
||
332 | * |
||
333 | * 7.0 Browser (Nokia 5800 XpressMusic (v21.0.025)) : Mozilla/5.0 (SymbianOS/9.4; U; Series60/5.0 Nokia5800d-1/21.0.025; Profile/MIDP-2.1 Configuration/CLDC-1.1 ) AppleWebKit/413 (KHTML, like Gecko) Safari/413 |
||
334 | * |
||
335 | * Browser 7.1 (Nokia N97 (v12.0.024)) : Mozilla/5.0 (SymbianOS/9.4; Series60/5.0 NokiaN97-1/12.0.024; Profile/MIDP-2.1 Configuration/CLDC-1.1; en-us) AppleWebKit/525 (KHTML, like Gecko) BrowserNG/7.1.12344 |
||
336 | */ |
||
337 | public static function is_S60_OSSBrowser() { |
||
341 | |||
342 | /** |
||
343 | * Detects if the device platform is the Symbian Series 60. |
||
344 | */ |
||
345 | public static function is_symbian_platform() { |
||
349 | |||
350 | /** |
||
351 | * Detects if the device platform is the Symbian Series 40. |
||
352 | * Nokia Browser for Series 40 is a proxy based browser, previously known as Ovi Browser. |
||
353 | * This browser will report 'NokiaBrowser' in the header, however some older version will also report 'OviBrowser'. |
||
354 | */ |
||
355 | public static function is_symbian_s40_platform() { |
||
359 | |||
360 | /** |
||
361 | * Returns if the device belongs to J2ME capable family. |
||
362 | * |
||
363 | * @return bool |
||
364 | */ |
||
365 | public static function is_J2ME_platform() { |
||
369 | |||
370 | |||
371 | /** |
||
372 | * Detects if the current UA is on one of the Maemo-based Nokia Internet Tablets. |
||
373 | */ |
||
374 | public static function is_MaemoTablet() { |
||
378 | |||
379 | /** |
||
380 | * Detects if the current UA is a MeeGo device (Nokia Smartphone). |
||
381 | */ |
||
382 | public static function is_MeeGo() { |
||
386 | |||
387 | |||
388 | /** |
||
389 | * The is_webkit() method can be used to check the User Agent for an webkit generic browser. |
||
390 | */ |
||
391 | public static function is_webkit() { |
||
395 | |||
396 | /** |
||
397 | * Detects if the current browser is the Native Android browser. |
||
398 | * |
||
399 | * @return boolean true if the browser is Android otherwise false |
||
400 | */ |
||
401 | public static function is_android() { |
||
405 | |||
406 | |||
407 | /** |
||
408 | * Detects if the current browser is the Native Android Tablet browser. |
||
409 | * Assumes 'Android' should be in the user agent, but not 'mobile' |
||
410 | * |
||
411 | * @return boolean true if the browser is Android and not 'mobile' otherwise false |
||
412 | */ |
||
413 | public static function is_android_tablet() { |
||
417 | |||
418 | /** |
||
419 | * Detects if the current browser is the Kindle Fire Native browser. |
||
420 | * |
||
421 | * Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_6_3; en-us; Silk/1.1.0-84) AppleWebKit/533.16 (KHTML, like Gecko) Version/5.0 Safari/533.16 Silk-Accelerated=true |
||
422 | * Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_6_3; en-us; Silk/1.1.0-84) AppleWebKit/533.16 (KHTML, like Gecko) Version/5.0 Safari/533.16 Silk-Accelerated=false |
||
423 | * |
||
424 | * @return boolean true if the browser is Kindle Fire Native browser otherwise false |
||
425 | */ |
||
426 | public static function is_kindle_fire() { |
||
430 | |||
431 | /** |
||
432 | * Detects if the current browser is the Kindle Touch Native browser |
||
433 | * |
||
434 | * Mozilla/5.0 (X11; U; Linux armv7l like Android; en-us) AppleWebKit/531.2+ (KHTML, like Gecko) Version/5.0 Safari/533.2+ Kindle/3.0+ |
||
435 | * |
||
436 | * @return boolean true if the browser is Kindle monochrome Native browser otherwise false |
||
437 | */ |
||
438 | public static function is_kindle_touch() { |
||
442 | |||
443 | |||
444 | /** |
||
445 | * Detect if user agent is the WordPress.com Windows 8 app (used ONLY on the custom oauth stylesheet) |
||
446 | */ |
||
447 | public static function is_windows8_auth() { |
||
451 | |||
452 | /** |
||
453 | * Detect if user agent is the WordPress.com Windows 8 app. |
||
454 | */ |
||
455 | public static function is_wordpress_for_win8() { |
||
459 | |||
460 | /** |
||
461 | * Detect if user agent is the WordPress.com Desktop app. |
||
462 | */ |
||
463 | public static function is_wordpress_desktop_app() { |
||
467 | |||
468 | /** |
||
469 | * The is_blackberry_tablet() method can be used to check the User Agent for a RIM blackberry tablet. |
||
470 | * The user agent of the BlackBerry® Tablet OS follows a format similar to the following: |
||
471 | * Mozilla/5.0 (PlayBook; U; RIM Tablet OS 1.0.0; en-US) AppleWebKit/534.8+ (KHTML, like Gecko) Version/0.0.1 Safari/534.8+ |
||
472 | */ |
||
473 | public static function is_blackberry_tablet() { |
||
477 | |||
478 | /** |
||
479 | * The is_blackbeberry() method can be used to check the User Agent for a blackberry device. |
||
480 | * Note that opera mini on BB matches this rule. |
||
481 | */ |
||
482 | public static function is_blackbeberry() { |
||
486 | |||
487 | /** |
||
488 | * The is_blackberry_10() method can be used to check the User Agent for a BlackBerry 10 device. |
||
489 | */ |
||
490 | public static function is_blackberry_10() { |
||
494 | |||
495 | /** |
||
496 | * Retrieve the blackberry OS version. |
||
497 | * |
||
498 | * Return strings are from the following list: |
||
499 | * - blackberry-10 |
||
500 | * - blackberry-7 |
||
501 | * - blackberry-6 |
||
502 | * - blackberry-torch //only the first edition. The 2nd edition has the OS7 onboard and doesn't need any special rule. |
||
503 | * - blackberry-5 |
||
504 | * - blackberry-4.7 |
||
505 | * - blackberry-4.6 |
||
506 | * - blackberry-4.5 |
||
507 | * |
||
508 | * @return string Version of the BB OS. |
||
509 | * If version is not found, get_blackbeberry_OS_version will return boolean false. |
||
510 | */ |
||
511 | public static function get_blackbeberry_OS_version() { |
||
515 | |||
516 | /** |
||
517 | * Retrieve the blackberry browser version. |
||
518 | * |
||
519 | * Return string are from the following list: |
||
520 | * - blackberry-10 |
||
521 | * - blackberry-webkit |
||
522 | * - blackberry-5 |
||
523 | * - blackberry-4.7 |
||
524 | * - blackberry-4.6 |
||
525 | * |
||
526 | * @return string Type of the BB browser. |
||
527 | * If browser's version is not found, detect_blackbeberry_browser_version will return boolean false. |
||
528 | */ |
||
529 | public static function detect_blackberry_browser_version() { |
||
533 | |||
534 | /** |
||
535 | * Checks if a visitor is coming from one of the WordPress mobile apps. |
||
536 | * |
||
537 | * @return bool |
||
538 | */ |
||
539 | public static function is_mobile_app() { |
||
543 | |||
544 | /** |
||
545 | * Detects if the current browser is Nintendo 3DS handheld. |
||
546 | * |
||
547 | * Example: Mozilla/5.0 (Nintendo 3DS; U; ; en) Version/1.7498.US |
||
548 | * can differ in language, version and region |
||
549 | */ |
||
550 | public static function is_Nintendo_3DS() { |
||
554 | |||
555 | /** |
||
556 | * Was the current request made by a known bot? |
||
557 | * |
||
558 | * @return boolean |
||
559 | */ |
||
560 | public static function is_bot() { |
||
564 | |||
565 | /** |
||
566 | * Is the given user-agent a known bot? |
||
567 | * If you want an is_bot check for the current request's UA, use is_bot() instead of passing a user-agent to this method. |
||
568 | * |
||
569 | * @param string $ua A user-agent string. |
||
|
|||
570 | * |
||
571 | * @return boolean |
||
572 | */ |
||
573 | public static function is_bot_user_agent( $ua = null ) { |
||
577 | } |
||
578 |
This check looks for
@param
annotations where the type inferred by our type inference engine differs from the declared type.It makes a suggestion as to what type it considers more descriptive.
Most often this is a case of a parameter that can be null in addition to its declared types.