Browser_Detection
[ class tree: Browser_Detection ] [ index: Browser_Detection ] [ all elements ]

Class: BrowserDetection

Source Location: /BrowserDetection.php

Class Overview


The BrowserDetection class facilitates the identification of the user's environment such as Web browser, version, platform or if it's a mobile device.


Author(s):

  • Alexandre Valiquette, Chris Schuld, Gary White

Version:

  • 2.5.1

Copyright:

  • Copyright (c) 2016, Wolfcast

Variables

Constants

Methods



Class Details

[line 108]
The BrowserDetection class facilitates the identification of the user's environment such as Web browser, version, platform or if it's a mobile device.

Typical usage:

$browser = new BrowserDetection(); if ($browser->getName() == BrowserDetection::BROWSER_FIREFOX && $browser->compareVersions($browser->getVersion(), '5.0') >= 0) { echo 'You are using FireFox version 5 or greater.'; }

The class is an updated version of Chris Schuld's Browser class version 1.9 which is unmaintained since August 20th, 2010. Chris' class was based on the original work from Gary White.

Updates:

2016-11-28: Version 2.5.1

  • Better detection of 64-bit platforms.
2016-08-19: Version 2.5.0
  • Platform version and platform version name are now supported for Mac.
  • Fixed platform version name for Android.
2016-08-02: Version 2.4.0
  • Platform version and platform version name are now supported for Android.
  • Added support for the Samsung Internet browser.
  • Added support for the Vivaldi browser.
  • Better support for legacy Windows versions.
2016-02-11: Version 2.3.0
  • WARNING! Breaking change: public method getBrowser() is renamed to getName().
  • WARNING! Breaking change: changed the compareVersions() return values to be more in line with other libraries.
  • You can now get the exact platform version (name or version numbers) on which the browser is run on with getPlatformVersion(). Only working with Windows operating systems at the moment.
  • You can now determine if the browser is executed from a 64-bit platform with is64bitPlatform().
  • Better detection of mobile platform for Googlebot.
2016-01-04: Version 2.2.0
  • Added support for Microsoft Edge.
2014-12-30: Version 2.1.2
  • Better detection of Opera.
2014-07-11: Version 2.1.1
  • Better detection of mobile devices and platforms.
2014-06-04: Version 2.1.0
  • Added support for IE 11+.
2013-05-27: Version 2.0.0 which is (almost) a complete rewrite based on Chris Schuld's Browser class version 1.9 plus changes below.
  • Added support for Opera Mobile
  • Added support for the Windows Phone (formerly Windows Mobile) platform
  • Added support for BlackBerry Tablet OS and BlackBerry 10
  • Added support for the Symbian platform
  • Added support for Bingbot
  • Added support for the Yahoo! Multimedia crawler
  • Removed iPhone/iPad/iPod browsers since there are not browsers but platforms - test them with getPlatform()
  • Removed support for Shiretoko (Firefox 3.5 alpha/beta) and MSN Browser
  • Merged Nokia and Nokia S60
  • Updated some deprecated browser names
  • Many public methods are now protected
  • Documentation updated
2010-07-04:
  • Added detection of IE compatibility view - test with getIECompatibilityView()
  • Added support for all (deprecated) Netscape versions
  • Added support for Safari < 3.0
  • Better Firefox version parsing
  • Better Opera version parsing
  • Better Mozilla detection




Tags:

author:  Alexandre Valiquette, Chris Schuld, Gary White
version:  2.5.1
copyright:  Copyright (c) 2016, Wolfcast
link:  http://chrisschuld.com/
link:  http://wolfcast.com/open-source/browser-detection/tutorial.php
link:  http://wolfcast.com/
link:  http://www.apptools.com/phptools/browser/
last-modified:  November 28, 2016
license:  http://www.gnu.org/licenses/lgpl.html


[ Top ]


Class Variables

$_agent =  ''

[line 188]



Tags:

access:  private

Type:   string


[ Top ]

$_aolVersion =  ''

[line 194]



Tags:

access:  private

Type:   string


[ Top ]

$_browserName =  ''

[line 200]



Tags:

access:  private

Type:   string


[ Top ]

$_compatibilityViewName =  ''

[line 206]



Tags:

access:  private

Type:   string


[ Top ]

$_compatibilityViewVer =  ''

[line 212]



Tags:

access:  private

Type:   string


[ Top ]

$_is64bit =  false

[line 218]



Tags:

access:  private

Type:   boolean


[ Top ]

$_isAol =  false

[line 224]



Tags:

access:  private

Type:   boolean


[ Top ]

$_isMobile =  false

[line 230]



Tags:

access:  private

Type:   boolean


[ Top ]

$_isRobot =  false

[line 236]



Tags:

access:  private

Type:   boolean


[ Top ]

$_platform =  ''

[line 242]



Tags:

access:  private

Type:   string


[ Top ]

$_platformVersion =  ''

[line 248]



Tags:

access:  private

Type:   string


[ Top ]

$_version =  ''

[line 254]



Tags:

access:  private

Type:   string


[ Top ]



Class Methods


method androidVerToStr [line 551]

string androidVerToStr( string $androidVer)

Convert the Android version numbers to the operating system name. For instance '1.6' returns 'Donut'.



Tags:

return:  The operating system name or the constant PLATFORM_VERSION_UNKNOWN if nothing match the version numbers.
access:  protected


Parameters:

string   $androidVer   The Android version numbers as a string.

[ Top ]

constructor __construct [line 265]

BrowserDetection __construct( [string $useragent = ''])

BrowserDetection class constructor.



Tags:

access:  public


Parameters:

string   $useragent   (optional) The user agent to work with. Leave empty for the current user agent (contained in $_SERVER['HTTP_USER_AGENT']).

[ Top ]

method checkBrowserAmaya [line 590]

boolean checkBrowserAmaya( )

Determine if the browser is the Amaya Web editor or not.



Tags:

return:  Returns true if the browser is Amaya, false otherwise.
link:  http://www.w3.org/Amaya/
access:  protected


[ Top ]

method checkBrowserAndroid [line 601]

boolean checkBrowserAndroid( )

Determine if the browser is the Android browser (based on the WebKit layout engine and coupled with Chrome's JavaScript engine) or not.



Tags:

return:  Returns true if the browser is the Android browser, false otherwise.
access:  protected


[ Top ]

method checkBrowserBingbot [line 613]

boolean checkBrowserBingbot( )

Determine if the browser is the Bingbot crawler or not.



Tags:

return:  Returns true if the browser is Bingbot, false otherwise.
link:  http://www.bing.com/webmaster/help/which-crawlers-does-bing-use-8c184ec0
access:  protected


[ Top ]

method checkBrowserBlackBerry [line 624]

boolean checkBrowserBlackBerry( )

Determine if the browser is the BlackBerry browser or not.



Tags:

return:  Returns true if the browser is the BlackBerry browser, false otherwise.
link:  http://supportforums.blackberry.com/t5/Web-and-WebWorks-Development/How-to-detect-the-BlackBerry-Browser/ta-p/559862
access:  protected


[ Top ]

method checkBrowserChrome [line 660]

boolean checkBrowserChrome( )

Determine if the browser is Chrome or not.



Tags:

return:  Returns true if the browser is Chrome, false otherwise.
link:  http://www.google.com/chrome/
access:  protected


[ Top ]

method checkBrowserEdge [line 670]

boolean checkBrowserEdge( )

Determine if the browser is Edge or not.



Tags:

return:  Returns true if the browser is Edge, false otherwise.
access:  protected


[ Top ]

method checkBrowserFirebird [line 680]

boolean checkBrowserFirebird( )

Determine if the browser is Firebird or not. Firebird was the name of Firefox from version 0.6 to 0.7.1.



Tags:

return:  Returns true if the browser is Firebird, false otherwise.
access:  protected


[ Top ]

method checkBrowserFirefox [line 691]

boolean checkBrowserFirefox( )

Determine if the browser is Firefox or not.



Tags:

return:  Returns true if the browser is Firefox, false otherwise.
link:  http://www.mozilla.org/en-US/firefox/new/
access:  protected


[ Top ]

method checkBrowserGaleon [line 713]

boolean checkBrowserGaleon( )

Determine if the browser is Galeon or not. The browser was discontinued on September 27, 2008.



Tags:

return:  Returns true if the browser is Galeon, false otherwise.
link:  http://en.wikipedia.org/wiki/Galeon
access:  protected


[ Top ]

method checkBrowserGooglebot [line 723]

boolean checkBrowserGooglebot( )

Determine if the browser is the Googlebot crawler or not.



Tags:

return:  Returns true if the browser is Googlebot, false otherwise.
access:  protected


[ Top ]

method checkBrowserIcab [line 742]

boolean checkBrowserIcab( )

Determine if the browser is iCab or not.



Tags:

return:  Returns true if the browser is iCab, false otherwise.
link:  http://www.icab.de/
access:  protected


[ Top ]

method checkBrowserIceCat [line 754]

boolean checkBrowserIceCat( )

Determine if the browser is GNU IceCat (formerly known as GNU IceWeasel) or not.



Tags:

return:  Returns true if the browser is GNU IceCat, false otherwise.
link:  http://www.gnu.org/software/gnuzilla/
access:  protected


[ Top ]

method checkBrowserIceWeasel [line 765]

boolean checkBrowserIceWeasel( )

Determine if the browser is GNU IceWeasel (now know as GNU IceCat) or not.



Tags:

return:  Returns true if the browser is GNU IceWeasel, false otherwise.
see:  BrowserDetection::checkBrowserIceCat()
access:  protected


[ Top ]

method checkBrowserInternetExplorer [line 777]

boolean checkBrowserInternetExplorer( )

Determine if the browser is Internet Explorer or not.



Tags:

return:  Returns true if the browser is Internet Explorer, false otherwise.
link:  http://www.microsoft.com/ie/
link:  http://en.wikipedia.org/wiki/Internet_Explorer_Mobile
access:  protected


[ Top ]

method checkBrowserKonqueror [line 868]

boolean checkBrowserKonqueror( )

Determine if the browser is Konqueror or not.



Tags:

return:  Returns true if the browser is Konqueror, false otherwise.
link:  http://www.konqueror.org/
access:  protected


[ Top ]

method checkBrowserLynx [line 880]

boolean checkBrowserLynx( )

Determine if the browser is Lynx or not. It is the oldest web browser currently in general use and development.

It is a text-based only Web browser.




Tags:

return:  Returns true if the browser is Lynx, false otherwise.
link:  http://en.wikipedia.org/wiki/Lynx
access:  protected


[ Top ]

method checkBrowserMozilla [line 890]

boolean checkBrowserMozilla( )

Determine if the browser is Mozilla or not.



Tags:

return:  Returns true if the browser is Mozilla, false otherwise.
access:  protected


[ Top ]

method checkBrowserMsnBot [line 901]

boolean checkBrowserMsnBot( )

Determine if the browser is the MSNBot crawler or not. In October 2010 it was replaced by the Bingbot robot.



Tags:

return:  Returns true if the browser is MSNBot, false otherwise.
see:  BrowserDetection::checkBrowserBingbot()
access:  protected


[ Top ]

method checkBrowserMsnTv [line 912]

boolean checkBrowserMsnTv( )

Determine if the browser is MSN TV (formerly WebTV) or not.



Tags:

return:  Returns true if the browser is WebTv, false otherwise.
link:  http://en.wikipedia.org/wiki/MSN_TV
access:  protected


[ Top ]

method checkBrowserNetPositive [line 923]

boolean checkBrowserNetPositive( )

Determine if the browser is NetPositive or not. The browser is discontinued since November 2001.



Tags:

return:  Returns true if the browser is NetPositive, false otherwise.
link:  http://en.wikipedia.org/wiki/NetPositive
access:  protected


[ Top ]

method checkBrowserNetscape [line 934]

boolean checkBrowserNetscape( )

Determine if the browser is Netscape or not. Official support for this browser ended on March 1st, 2008.



Tags:

return:  Returns true if the browser is Netscape, false otherwise.
link:  http://en.wikipedia.org/wiki/Netscape
access:  protected


[ Top ]

method checkBrowserNokia [line 987]

boolean checkBrowserNokia( )

Determine if the browser is a Nokia browser or not.



Tags:

return:  Returns true if the browser is a Nokia browser, false otherwise.
link:  http://www.developer.nokia.com/Community/Wiki/User-Agent_headers_for_Nokia_devices
access:  protected


[ Top ]

method checkBrowserOmniWeb [line 1011]

boolean checkBrowserOmniWeb( )

Determine if the browser is OmniWeb or not.



Tags:

return:  Returns true if the browser is OmniWeb, false otherwise.
link:  http://www.omnigroup.com/products/omniweb/
access:  protected


[ Top ]

method checkBrowserOpera [line 1033]

boolean checkBrowserOpera( )

Determine if the browser is Opera or not.



Tags:

return:  Returns true if the browser is Opera, false otherwise.
link:  http://my.opera.com/community/openweb/idopera/
link:  http://www.opera.com/
link:  http://www.opera.com/mobile/
link:  http://www.opera.com/mini/
access:  protected


[ Top ]

method checkBrowserPhoenix [line 1069]

boolean checkBrowserPhoenix( )

Determine if the browser is Phoenix or not. Phoenix was the name of Firefox from version 0.1 to 0.5.



Tags:

return:  Returns true if the browser is Phoenix, false otherwise.
access:  protected


[ Top ]

method checkBrowsers [line 1079]

boolean checkBrowsers( )

Determine what is the browser used by the user.



Tags:

return:  Returns true if the browser has been identified, false otherwise.
access:  protected


[ Top ]

method checkBrowserSafari [line 1131]

boolean checkBrowserSafari( )

Determine if the browser is Safari or not.



Tags:



[ Top ]

method checkBrowserSamsung [line 1170]

boolean checkBrowserSamsung( )

Determine if the browser is the Samsung Internet browser or not.



Tags:

return:  Returns true if the browser is the the Samsung Internet browser, false otherwise.
access:  protected


[ Top ]

method checkBrowserSlurp [line 1180]

boolean checkBrowserSlurp( )

Determine if the browser is the Yahoo! Slurp crawler or not.



Tags:

return:  Returns true if the browser is Yahoo! Slurp, false otherwise.
access:  protected


[ Top ]

method checkBrowserUAWithVersion [line 1197]

boolean checkBrowserUAWithVersion( mixed $uaNameToLookFor, string $userAgent, string $browserName, [boolean $isMobile = false], [boolean $isRobot = false])

Test the user agent for a specific browser that use a "Version" string (like Safari and Opera). The user agent should look like: "Version/1.0 Browser name/123.456" or "Browser name/123.456 Version/1.0".



Tags:

return:  Returns true if we found the browser we were looking for, false otherwise.
access:  protected


Parameters:

mixed   $uaNameToLookFor   The string (or array of strings) representing the browser name to find in the user agent.
string   $userAgent   The user agent string to work with.
string   $browserName   The literal browser name. Always use a class constant!
boolean   $isMobile   (optional) Determines if the browser is from a mobile device.
boolean   $isRobot   (optional) Determines if the browser is a robot or not.

[ Top ]

method checkBrowserVivaldi [line 1230]

boolean checkBrowserVivaldi( )

Determine if the browser is Vivaldi or not.



Tags:

return:  Returns true if the browser is Vivaldi, false otherwise.
access:  protected


[ Top ]

method checkBrowserW3CValidator [line 1241]

boolean checkBrowserW3CValidator( )

Determine if the browser is the W3C Validator or not.



Tags:

return:  Returns true if the browser is the W3C Validator, false otherwise.
link:  http://validator.w3.org/
access:  protected


[ Top ]

method checkBrowserYahooMultimedia [line 1278]

boolean checkBrowserYahooMultimedia( )

Determine if the browser is the Yahoo! multimedia crawler or not.



Tags:

return:  Returns true if the browser is the Yahoo! multimedia crawler, false otherwise.
access:  protected


[ Top ]

method checkForAol [line 1288]

boolean checkForAol( )

Determine if the user is using an AOL "optimized" browser or not.



Tags:

return:  Returns true if the browser is AOL optimized, false otherwise.
access:  protected


[ Top ]

method checkPlatform [line 1315]

void checkPlatform( )

Determine the user's platform.



Tags:

access:  protected


[ Top ]

method checkPlatformVersion [line 1390]

void checkPlatformVersion( )

Determine the user's platform version.



Tags:

access:  protected


[ Top ]

method checkSimpleBrowserUA [line 1452]

boolean checkSimpleBrowserUA( mixed $uaNameToLookFor, string $userAgent, string $browserName, [boolean $isMobile = false], [boolean $isRobot = false], [string $separator = '/'])

Test the user agent for a specific browser where the browser name is immediately followed by the version number.

The user agent should look like: "Browser name/1.0" or "Browser 1.0;".




Tags:

return:  Returns true if we found the browser we were looking for, false otherwise.
access:  protected


Parameters:

mixed   $uaNameToLookFor   The string (or array of strings) representing the browser name to find in the user agent.
string   $userAgent   The user agent string to work with.
string   $browserName   The literal browser name. Always use a class constant!
boolean   $isMobile   (optional) Determines if the browser is from a mobile device.
boolean   $isRobot   (optional) Determines if the browser is a robot or not.
string   $separator   (optional) The separator string used to split the browser name and the version number in the user agent.

[ Top ]

method cleanVersion [line 1533]

string cleanVersion( string $version)

Clean a version string from unwanted characters.



Tags:

return:  Returns the cleaned version number string.
access:  protected


Parameters:

string   $version   The version string to clean.

[ Top ]

method compareVersions [line 312]

int compareVersions( string $sourceVer, string $compareVer)

Compare two version number strings.



Tags:

return:  Returns -1 if $sourceVer < $compareVer, 0 if $sourceVer == $compareVer or 1 if $sourceVer > $compareVer.
access:  public


Parameters:

string   $sourceVer   The source version number.
string   $compareVer   The version number to compare with the source version number.

[ Top ]

method containString [line 1495]

boolean containString( string $haystack, mixed $needle, [boolean $insensitive = true])

Find if one or more substring is contained in a string.



Tags:

return:  Returns true if the needle (or one of the needles) has been found in the haystack, false otherwise.
access:  protected


Parameters:

string   $haystack   The string to search in.
mixed   $needle   The string to search for. Can be a string or an array of strings if multiples values are to be searched.
boolean   $insensitive   (optional) Determines if we do a case-sensitive search (false) or a case-insensitive one (true).

[ Top ]

method detect [line 1520]

void detect( )

Detect the user environment from the details in the user agent string.



Tags:

access:  protected


[ Top ]

method getAolVersion [line 354]

string getAolVersion( )

Get the version of AOL (if any). AOL releases "optimized" Internet Explorer and Firefox versions. In the making they add their version number in the user agent string of these browsers.



Tags:

return:  Returns the version of AOL or an empty string if no AOL version was found.
access:  public


[ Top ]

method getIECompatibilityView [line 379]

mixed getIECompatibilityView( [boolean $asArray = false])

Get the name and version of the browser emulated in the compatibility view mode (if any). Since Internet Explorer 8, IE can be put in compatibility mode to make websites that were created for older browsers, especially IE 6 and 7, look better in IE 8+ which renders web pages closer to the standards and thus differently from those older versions of IE.



Tags:

return:  If a string was requested, the function returns the name and version of the browser emulated in the compatibility view mode or an empty string if the browser is not in compatibility view mode. If an array was requested, an array with the keys 'browser' and 'version' is returned.
access:  public


Parameters:

boolean   $asArray   (optional) Determines if the return value must be an array (true) or a string (false).

[ Top ]

method getName [line 364]

string getName( )

Get the name of the browser. All of the return values are class constants. You can compare them like this: $myBrowserInstance->getName() == BrowserDetection::BROWSER_FIREFOX.



Tags:

return:  Returns the name of the browser.
access:  public


[ Top ]

method getPlatform [line 394]

string getPlatform( )

Get the name of the platform family on which the browser is run on (such as Windows, Apple, iPhone, etc.). All of the return values are class constants. You can compare them like this: $myBrowserInstance->getPlatform() == BrowserDetection::PLATFORM_ANDROID.



Tags:

return:  Returns the name of the platform or BrowserDetection::PLATFORM_UNKNOWN if unknown.
access:  public


[ Top ]

method getPlatformVersion [line 412]

string getPlatformVersion( [boolean $returnVersionNumbers = false], [boolean $returnServerFlavor = false])

Get the platform version on which the browser is run on. It can be returned as a string number like 'NT 6.3' or as a name like 'Windows 8.1'. When returning version string numbers for Windows NT OS families the number is prefixed by 'NT ' to differentiate from older Windows 3.x & 9x release. At the moment only the Windows and Android operating systems are supported.



Tags:

return:  Returns the version name/version numbers of the platform or the constant PLATFORM_VERSION_UNKNOWN if unknown.
access:  public


Parameters:

boolean   $returnVersionNumbers   (optional) Determines if the return value must be versions numbers as a string (true) or the version name (false).
boolean   $returnServerFlavor   (optional) Since some Windows NT versions have the same values, this flag determines if the Server flavor is returned or not. For instance Windows 8.1 and Windows Server 2012 R2 both use version 6.3. This parameter is only useful when testing for Windows.

[ Top ]

method getUserAgent [line 447]

string getUserAgent( )

Get the user agent value used by the class to determine the browser details.



Tags:

return:  The user agent string.
access:  public


[ Top ]

method getVersion [line 456]

string getVersion( )

Get the version of the browser.



Tags:

return:  Returns the version of the browser or BrowserDetection::VERSION_UNKNOWN if unknown.
access:  public


[ Top ]

method is64bitPlatform [line 466]

boolean is64bitPlatform( )

Determine if the browser is executed from a 64-bit platform. Keep in mind that not all platforms/browsers report this and the result may not always be accurate.



Tags:

return:  Returns true if the browser is executed from a 64-bit platform.
access:  public


[ Top ]

method isAol [line 476]

boolean isAol( )

Determine if the browser is from AOL. AOL releases "optimized" Internet Explorer and Firefox versions. In the making they add their details in the user agent string of these browsers.



Tags:

return:  Returns true if the browser is from AOL, false otherwise.
access:  public


[ Top ]

method isChromeFrame [line 486]

boolean isChromeFrame( )

Determine if the browser runs Google Chrome Frame (it's a plug-in designed for Internet Explorer 6+ based on the open-source Chromium project - it's like a Chrome browser within IE).



Tags:

return:  Returns true if the browser is using Google Chrome Frame, false otherwise.
access:  public


[ Top ]

method isInIECompatibilityView [line 497]

boolean isInIECompatibilityView( )

Determine if the browser is in compatibility view or not. Since Internet Explorer 8, IE can be put in compatibility mode to make websites that were created for older browsers, especially IE 6 and 7, look better in IE 8+ which renders web pages closer to the standards and thus differently from those older versions of IE.



Tags:

return:  Returns true if the browser is in compatibility view, false otherwise.
access:  public


[ Top ]

method isMobile [line 506]

boolean isMobile( )

Determine if the browser is from a mobile device or not.



Tags:

return:  Returns true if the browser is from a mobile device, false otherwise.
access:  public


[ Top ]

method isRobot [line 515]

boolean isRobot( )

Determine if the browser is a robot (Googlebot, Bingbot, Yahoo! Slurp...) or not.



Tags:

return:  Returns true if the browser is a robot, false otherwise.
access:  public


[ Top ]

method macVerToStr [line 1556]

string macVerToStr( string $macVer)

Convert the macOS version numbers to the operating system name. For instance '10.7' returns 'Mac OS X Lion'.



Tags:

return:  The operating system name or the constant PLATFORM_VERSION_UNKNOWN if nothing match the version numbers.
access:  protected


Parameters:

string   $macVer   The macOS version numbers as a string.

[ Top ]

method parseInt [line 1599]

int parseInt( string $intStr)

Get the integer value of a string variable.



Tags:

return:  The integer value of $intStr on success, or 0 on failure.
access:  protected


Parameters:

string   $intStr   The scalar value being converted to an integer.

[ Top ]

method reset [line 1608]

void reset( )

Reset all the properties of the class.



Tags:

access:  protected


[ Top ]

method safariBuildToSafariVer [line 1632]

string safariBuildToSafariVer( string $version)

Convert a Safari build number to a Safari version number.



Tags:

return:  Returns the Safari version string. If the version can't be determined, an empty string is returned.
link:  http://web.archive.org/web/20080514173941/http://developer.apple.com/internet/safari/uamatrix.html
access:  protected


Parameters:

string   $version   A string representing the version number.

[ Top ]

method set64bit [line 1726]

void set64bit( boolean $is64bit)

Set if the browser is executed from a 64-bit platform.



Tags:

access:  protected


Parameters:

boolean   $is64bit   Value that tells if the browser is executed from a 64-bit platform.

[ Top ]

method setAol [line 1736]

void setAol( boolean $isAol)

Set the browser to be from AOL or not.



Tags:

access:  protected


Parameters:

boolean   $isAol   Value that tells if the browser is AOL or not.

[ Top ]

method setAolVersion [line 1746]

void setAolVersion( string $version)

Set the version of AOL.



Tags:

access:  protected


Parameters:

string   $version   The version of AOL (will be cleaned).

[ Top ]

method setBrowser [line 1758]

void setBrowser( string $browserName)

Set the name of the browser.



Tags:

access:  protected


Parameters:

string   $browserName   The name of the browser.

[ Top ]

method setMobile [line 1768]

void setMobile( [boolean $isMobile = true])

Set the browser to be from a mobile device or not.



Tags:

access:  protected


Parameters:

boolean   $isMobile   (optional) Value that tells if the browser is on a mobile device or not.

[ Top ]

method setPlatform [line 1778]

void setPlatform( string $platform)

Set the platform on which the browser is on.



Tags:

access:  protected


Parameters:

string   $platform   The name of the platform.

[ Top ]

method setPlatformVersion [line 1788]

void setPlatformVersion( string $platformVer)

Set the platform version on which the browser is on.



Tags:

access:  protected


Parameters:

string   $platformVer   The version numbers of the platform.

[ Top ]

method setRobot [line 1798]

void setRobot( [boolean $isRobot = true])

Set the browser to be a robot (crawler) or not.



Tags:

access:  protected


Parameters:

boolean   $isRobot   (optional) Value that tells if the browser is a robot or not.

[ Top ]

method setUserAgent [line 525]

void setUserAgent( [string $agentString = ''])

Set the user agent to use with the class.



Tags:

access:  public


Parameters:

string   $agentString   (optional) The value of the user agent. If an empty string is sent (default), $_SERVER['HTTP_USER_AGENT'] will be used.

[ Top ]

method setVersion [line 1808]

void setVersion( string $version)

Set the version of the browser.



Tags:

access:  protected


Parameters:

string   $version   The version of the browser.

[ Top ]

method webKitBuildToSafariVer [line 1827]

string webKitBuildToSafariVer( string $version)

Convert a WebKit build number to a Safari version number.



Tags:

return:  Returns the Safari version string. If the version can't be determined, an empty string is returned.
link:  http://web.archive.org/web/20080514173941/http://developer.apple.com/internet/safari/uamatrix.html
access:  protected


Parameters:

string   $version   A string representing the version number.

[ Top ]

method windowsNTVerToStr [line 1936]

string windowsNTVerToStr( string $winVer, [boolean $returnServerFlavor = false])

Convert the Windows NT family version numbers to the operating system name. For instance '5.1' returns 'Windows XP'.



Tags:

return:  The operating system name or the constant PLATFORM_VERSION_UNKNOWN if nothing match the version numbers.
access:  protected


Parameters:

string   $winVer   The Windows NT family version numbers as a string.
boolean   $returnServerFlavor   (optional) Since some Windows NT versions have the same values, this flag determines if the Server flavor is returned or not. For instance Windows 8.1 and Windows Server 2012 R2 both use version 6.3.

[ Top ]

method windowsVerToStr [line 1983]

string windowsVerToStr( string $winVer)

Convert the Windows 3.x & 9x family version numbers to the operating system name. For instance '4.10.1998' returns 'Windows 98'.



Tags:

return:  The operating system name or the constant PLATFORM_VERSION_UNKNOWN if nothing match the version numbers.
access:  protected


Parameters:

string   $winVer   The Windows 3.x or 9x family version numbers as a string.

[ Top ]

method __toString [line 274]

string __toString( )

Determine how the class will react when it is treated like a string.



Tags:

return:  Returns an HTML formatted string with a summary of the browser informations.
access:  public


[ Top ]


Class Constants

BROWSER_AMAYA =  'Amaya'

[line 114]

Constant for the name of the Web browser.


[ Top ]

BROWSER_ANDROID =  'Android'

[line 115]

Constant for the name of the Web browser.


[ Top ]

BROWSER_BINGBOT =  'Bingbot'

[line 116]

Constant for the name of the Web browser.


[ Top ]

BROWSER_BLACKBERRY =  'BlackBerry'

[line 117]

Constant for the name of the Web browser.


[ Top ]

BROWSER_CHROME =  'Chrome'

[line 118]

Constant for the name of the Web browser.


[ Top ]

BROWSER_EDGE =  'Edge'

[line 119]

Constant for the name of the Web browser.


[ Top ]

BROWSER_FIREBIRD =  'Firebird'

[line 120]

Constant for the name of the Web browser.


[ Top ]

BROWSER_FIREFOX =  'Firefox'

[line 121]

Constant for the name of the Web browser.


[ Top ]

BROWSER_GALEON =  'Galeon'

[line 122]

Constant for the name of the Web browser.


[ Top ]

BROWSER_GOOGLEBOT =  'Googlebot'

[line 123]

Constant for the name of the Web browser.


[ Top ]

BROWSER_ICAB =  'iCab'

[line 124]

Constant for the name of the Web browser.


[ Top ]

BROWSER_ICECAT =  'GNU IceCat'

[line 125]

Constant for the name of the Web browser.


[ Top ]

BROWSER_ICEWEASEL =  'GNU IceWeasel'

[line 126]

Constant for the name of the Web browser.


[ Top ]

BROWSER_IE =  'Internet Explorer'

[line 127]

Constant for the name of the Web browser.


[ Top ]

BROWSER_IE_MOBILE =  'Internet Explorer Mobile'

[line 128]

Constant for the name of the Web browser.


[ Top ]

BROWSER_KONQUEROR =  'Konqueror'

[line 129]

Constant for the name of the Web browser.


[ Top ]

BROWSER_LYNX =  'Lynx'

[line 130]

Constant for the name of the Web browser.


[ Top ]

BROWSER_MOZILLA =  'Mozilla'

[line 131]

Constant for the name of the Web browser.


[ Top ]

BROWSER_MSNBOT =  'MSNBot'

[line 132]

Constant for the name of the Web browser.


[ Top ]

BROWSER_MSNTV =  'MSN TV'

[line 133]

Constant for the name of the Web browser.


[ Top ]

BROWSER_NETPOSITIVE =  'NetPositive'

[line 134]

Constant for the name of the Web browser.


[ Top ]

BROWSER_NETSCAPE =  'Netscape'

[line 135]

Constant for the name of the Web browser.


[ Top ]

BROWSER_NOKIA =  'Nokia Browser'

[line 136]

Constant for the name of the Web browser.


[ Top ]

BROWSER_OMNIWEB =  'OmniWeb'

[line 137]

Constant for the name of the Web browser.


[ Top ]

BROWSER_OPERA =  'Opera'

[line 138]

Constant for the name of the Web browser.


[ Top ]

BROWSER_OPERA_MINI =  'Opera Mini'

[line 139]

Constant for the name of the Web browser.


[ Top ]

BROWSER_OPERA_MOBILE =  'Opera Mobile'

[line 140]

Constant for the name of the Web browser.


[ Top ]

BROWSER_PHOENIX =  'Phoenix'

[line 141]

Constant for the name of the Web browser.


[ Top ]

BROWSER_SAFARI =  'Safari'

[line 142]

Constant for the name of the Web browser.


[ Top ]

BROWSER_SAMSUNG =  'Samsung Internet'

[line 143]

Constant for the name of the Web browser.


[ Top ]

BROWSER_SLURP =  'Yahoo! Slurp'

[line 144]

Constant for the name of the Web browser.


[ Top ]

BROWSER_TABLET_OS =  'BlackBerry Tablet OS'

[line 145]

Constant for the name of the Web browser.


[ Top ]

BROWSER_UNKNOWN =  'unknown'

[line 146]

Constant for the name of the Web browser.


[ Top ]

BROWSER_VIVALDI =  'Vivaldi'

[line 147]

Constant for the name of the Web browser.


[ Top ]

BROWSER_W3CVALIDATOR =  'W3C Validator'

[line 148]

Constant for the name of the Web browser.


[ Top ]

BROWSER_YAHOO_MM =  'Yahoo! Multimedia'

[line 149]

Constant for the name of the Web browser.


[ Top ]

PLATFORM_ANDROID =  'Android'

[line 155]

Constant for the name of the platform of the Web browser.


[ Top ]

PLATFORM_BEOS =  'BeOS'

[line 156]

Constant for the name of the platform of the Web browser.


[ Top ]

PLATFORM_BLACKBERRY =  'BlackBerry'

[line 157]

Constant for the name of the platform of the Web browser.


[ Top ]

PLATFORM_FREEBSD =  'FreeBSD'

[line 158]

Constant for the name of the platform of the Web browser.


[ Top ]

PLATFORM_IPAD =  'iPad'

[line 159]

Constant for the name of the platform of the Web browser.


[ Top ]

PLATFORM_IPHONE =  'iPhone'

[line 160]

Constant for the name of the platform of the Web browser.


[ Top ]

PLATFORM_IPOD =  'iPod'

[line 161]

Constant for the name of the platform of the Web browser.


[ Top ]

PLATFORM_LINUX =  'Linux'

[line 162]

Constant for the name of the platform of the Web browser.


[ Top ]

PLATFORM_MACINTOSH =  'Macintosh'

[line 163]

Constant for the name of the platform of the Web browser.


[ Top ]

PLATFORM_NETBSD =  'NetBSD'

[line 164]

Constant for the name of the platform of the Web browser.


[ Top ]

PLATFORM_NOKIA =  'Nokia'

[line 165]

Constant for the name of the platform of the Web browser.


[ Top ]

PLATFORM_OPENBSD =  'OpenBSD'

[line 166]

Constant for the name of the platform of the Web browser.


[ Top ]

PLATFORM_OPENSOLARIS =  'OpenSolaris'

[line 167]

Constant for the name of the platform of the Web browser.


[ Top ]

PLATFORM_OS2 =  'OS/2'

[line 168]

Constant for the name of the platform of the Web browser.


[ Top ]

PLATFORM_SUNOS =  'SunOS'

[line 169]

Constant for the name of the platform of the Web browser.


[ Top ]

PLATFORM_SYMBIAN =  'Symbian'

[line 170]

Constant for the name of the platform of the Web browser.


[ Top ]

PLATFORM_UNKNOWN =  'unknown'

[line 171]

Constant for the name of the platform of the Web browser.


[ Top ]

PLATFORM_VERSION_UNKNOWN =  'unknown'

[line 172]

Constant for the name of the platform of the Web browser.


[ Top ]

PLATFORM_WINDOWS =  'Windows'

[line 173]

Constant for the name of the platform of the Web browser.


[ Top ]

PLATFORM_WINDOWS_CE =  'Windows CE'

[line 174]

Constant for the name of the platform of the Web browser.


[ Top ]

PLATFORM_WINDOWS_PHONE =  'Windows Phone'

[line 175]

Constant for the name of the platform of the Web browser.


[ Top ]

VERSION_UNKNOWN =  'unknown'

[line 181]

Version unknown constant.


[ Top ]



Documentation generated on Mon, 28 Nov 2016 10:05:56 -0500 by phpDocumentor 1.4.3