Class: Browser

Source Location: /Libs/Browser.php

Class Browser

Class Overview

File: Browser.php

Author: Chris Schuld (http://chrisschuld.com/) Last Modified: August 20th, 2010

Located in /Libs/Browser.php [line 135]

Author(s):

Information Tags:

Version:

1.9

Properties

Methods

[ Top ]

Constant Summary

BROWSER_AMAYA
BROWSER_ANDROID
BROWSER_BLACKBERRY
BROWSER_CHROME
BROWSER_FIREBIRD
BROWSER_FIREFOX
BROWSER_GALEON
BROWSER_GOOGLEBOT
BROWSER_ICAB
BROWSER_ICECAT
BROWSER_ICEWEASEL
BROWSER_IE
BROWSER_IPAD
BROWSER_IPHONE
BROWSER_IPOD
BROWSER_KONQUEROR
BROWSER_LYNX
BROWSER_MOZILLA
BROWSER_MSN
BROWSER_MSNBOT
BROWSER_NETPOSITIVE
BROWSER_NETSCAPE_NAVIGATOR
BROWSER_NOKIA
BROWSER_NOKIA_S60
BROWSER_OMNIWEB
BROWSER_OPERA
BROWSER_OPERA_MINI
BROWSER_PHOENIX
BROWSER_POCKET_IE
BROWSER_SAFARI
BROWSER_SHIRETOKO
BROWSER_SLURP
BROWSER_UNKNOWN
BROWSER_W3CVALIDATOR
BROWSER_WEBTV
OPERATING_SYSTEM_UNKNOWN
PLATFORM_ANDROID
PLATFORM_APPLE
PLATFORM_BEOS
PLATFORM_BLACKBERRY
PLATFORM_FREEBSD
PLATFORM_IPAD
PLATFORM_IPHONE
PLATFORM_IPOD
PLATFORM_LINUX
PLATFORM_NETBSD
PLATFORM_NOKIA
PLATFORM_OPENBSD
PLATFORM_OPENSOLARIS
PLATFORM_OS2
PLATFORM_SUNOS
PLATFORM_UNKNOWN
PLATFORM_WINDOWS
PLATFORM_WINDOWS_CE
VERSION_UNKNOWN

[ Top ]

Property Summary

mixed	$_agent
mixed	$_aol_version
mixed	$_browser_name
mixed	$_is_aol
mixed	$_is_mobile
mixed	$_is_robot
mixed	$_os
mixed	$_platform
mixed	$_version

[ Top ]

Method Summary

Browser	Browser()
boolean	checkBrowserAmaya()	Determine if the browser is Amaya or not (last updated 1.7)
boolean	checkBrowserAndroid()	Determine if the browser is Android or not (last updated 1.7)
boolean	checkBrowserBlackBerry()	Determine if the user is using a BlackBerry (last updated 1.7)
boolean	checkBrowserChrome()	Determine if the browser is Chrome or not (last updated 1.7)
boolean	checkBrowserFirebird()	Determine if the browser is Firebird or not (last updated 1.7)
boolean	checkBrowserFirefox()	Determine if the browser is Firefox or not (last updated 1.7)
boolean	checkBrowserGaleon()	Determine if the browser is Galeon or not (last updated 1.7)
boolean	checkBrowserGoogleBot()	Determine if the browser is the GoogleBot or not (last updated 1.7)
boolean	checkBrowserIcab()	Determine if the browser is iCab or not (last updated 1.7)
boolean	checkBrowserIceCat()	Determine if the browser is Ice Cat or not (http://en.wikipedia.org/wiki/GNU_IceCat) (last updated 1.7)
boolean	checkBrowserIceweasel()	Determine if the browser is Firefox or not (last updated 1.7)
boolean	checkBrowserInternetExplorer()	Determine if the browser is Internet Explorer or not (last updated 1.7)
boolean	checkBrowseriPad()	Determine if the browser is iPod or not (last updated 1.7)
boolean	checkBrowseriPhone()	Determine if the browser is iPhone or not (last updated 1.7)
boolean	checkBrowseriPod()	Determine if the browser is iPod or not (last updated 1.7)
boolean	checkBrowserKonqueror()	Determine if the browser is Konqueror or not (last updated 1.7)
boolean	checkBrowserLynx()	Determine if the browser is Lynx or not (last updated 1.7)
boolean	checkBrowserMozilla()	Determine if the browser is Mozilla or not (last updated 1.7)
boolean	checkBrowserMSNBot()	Determine if the browser is the MSNBot or not (last updated 1.9)
boolean	checkBrowserNetPositive()	Determine if the browser is NetPositive or not (last updated 1.7)
boolean	checkBrowserNetscapeNavigator9Plus()	Determine if the browser is Netscape Navigator 9+ or not (last updated 1.7)
boolean	checkBrowserNokia()	Determine if the browser is Nokia or not (last updated 1.7)
boolean	checkBrowserOmniWeb()	Determine if the browser is OmniWeb or not (last updated 1.7)
boolean	checkBrowserOpera()	Determine if the browser is Opera or not (last updated 1.7)
boolean	checkBrowserPhoenix()	Determine if the browser is Phoenix or not (last updated 1.7)
boolean	checkBrowsers()	Protected routine to determine the browser type
boolean	checkBrowserSafari()	Determine if the browser is Safari or not (last updated 1.7)
boolean	checkBrowserShiretoko()	Determine if the browser is Shiretoko or not (https://wiki.mozilla.org/Projects/shiretoko) (last updated 1.7)
boolean	checkBrowserSlurp()	Determine if the browser is the Yahoo! Slurp Robot or not (last updated 1.7)
boolean	checkBrowserW3CValidator()	Determine if the browser is the W3C Validator or not (last updated 1.7)
boolean	checkBrowserWebTv()	Determine if the browser is WebTv or not (last updated 1.7)
boolean	checkForAol()	Determine if the user is using an AOL User Agent (last updated 1.7)
void	checkPlatform()	Determine the user's platform (last updated 1.7)
void	determine()	Protected routine to calculate and determine what the browser is in use (including platform)
string	getAolVersion()	The version of AOL.
string	getBrowser()	The name of the browser. All return types are from the class contants
string	getPlatform()	The name of the platform. All return types are from the class contants
string	getUserAgent()	Get the user agent value in use to determine the browser
string	getVersion()	The version of the browser.
boolean	isAol()	Is the browser from AOL?
True	isBrowser()	Check to see if the specific browser is valid
boolean	isChromeFrame()	Used to determine if the browser is actually "chromeframe"
boolean	isMobile()	Is the browser from a mobile device?
boolean	isRobot()	Is the browser from a robot (ex Slurp,GoogleBot)?
void	reset()	Reset all properties
void	setAol()	Set the browser to be from AOL
void	setAolVersion()	Set the version of AOL
void	setBrowser()	Set the name of the browser
void	setMobile()	Set the Browser to be mobile
void	setPlatform()	Set the name of the platform
void	setRobot()	Set the Browser to be a robot
void	setUserAgent()	Set the user agent value (the construction will use the HTTP header value - this will overwrite it)
void	setVersion()	Set the version of the browser
string	__toString()	Returns a formatted string with a summary of the details of the browser.

[ Top ]

Properties

mixed $_agent = '' [line 136]

API Tags:

Access:

private

[ Top ]

mixed $_aol_version = '' [line 144]

API Tags:

Access:

private

[ Top ]

mixed $_browser_name = '' [line 137]

API Tags:

Access:

private

[ Top ]

mixed $_is_aol = false [line 141]

API Tags:

Access:

private

[ Top ]

mixed $_is_mobile = false [line 142]

API Tags:

Access:

private

[ Top ]

mixed $_is_robot = false [line 143]

API Tags:

Access:

private

[ Top ]

mixed $_os = '' [line 140]

API Tags:

Access:

private

[ Top ]

mixed $_platform = '' [line 139]

API Tags:

Access:

private

[ Top ]

mixed $_version = '' [line 138]

API Tags:

Access:

private

[ Top ]

Methods

Constructor Browser [line 207]

Browser Browser(
[
$useragent = ""] 
)

Parameters:

$useragent:

API Tags:

Access:

public

[ Top ]

checkBrowserAmaya [line 878]

boolean checkBrowserAmaya(
)

Determine if the browser is Amaya or not (last updated 1.7)

API Tags:

Return:	True if the browser is Amaya otherwise false
Access:	protected

[ Top ]

checkBrowserAndroid [line 976]

boolean checkBrowserAndroid(
)

Determine if the browser is Android or not (last updated 1.7)

API Tags:

Return:	True if the browser is Android otherwise false
Access:	protected

[ Top ]

checkBrowserBlackBerry [line 411]

boolean checkBrowserBlackBerry(
)

Determine if the user is using a BlackBerry (last updated 1.7)

API Tags:

Return:	True if the browser is the BlackBerry browser otherwise false
Access:	protected

[ Top ]

checkBrowserChrome [line 606]

boolean checkBrowserChrome(
)

Determine if the browser is Chrome or not (last updated 1.7)

API Tags:

Return:	True if the browser is Chrome otherwise false
Access:	protected

[ Top ]

checkBrowserFirebird [line 725]

boolean checkBrowserFirebird(
)

Determine if the browser is Firebird or not (last updated 1.7)

API Tags:

Return:	True if the browser is Firebird otherwise false
Access:	protected

[ Top ]

checkBrowserFirefox [line 803]

boolean checkBrowserFirefox(
)

Determine if the browser is Firefox or not (last updated 1.7)

API Tags:

Return:	True if the browser is Firefox otherwise false
Access:	protected

[ Top ]

checkBrowserGaleon [line 652]

boolean checkBrowserGaleon(
)

Determine if the browser is Galeon or not (last updated 1.7)

API Tags:

Return:	True if the browser is Galeon otherwise false
Access:	protected

[ Top ]

checkBrowserGoogleBot [line 444]

boolean checkBrowserGoogleBot(
)

Determine if the browser is the GoogleBot or not (last updated 1.7)

API Tags:

Return:	True if the browser is the GoogletBot otherwise false
Access:	protected

[ Top ]

checkBrowserIcab [line 682]

boolean checkBrowserIcab(
)

Determine if the browser is iCab or not (last updated 1.7)

API Tags:

Return:	True if the browser is iCab otherwise false
Access:	protected

[ Top ]

checkBrowserIceCat [line 771]

boolean checkBrowserIceCat(
)

Determine if the browser is Ice Cat or not (http://en.wikipedia.org/wiki/GNU_IceCat) (last updated 1.7)

API Tags:

Return:	True if the browser is Ice Cat otherwise false
Access:	protected

[ Top ]

checkBrowserIceweasel [line 823]

boolean checkBrowserIceweasel(
)

Determine if the browser is Firefox or not (last updated 1.7)

API Tags:

Return:	True if the browser is Firefox otherwise false
Access:	protected

[ Top ]

checkBrowserInternetExplorer [line 517]

boolean checkBrowserInternetExplorer(
)

Determine if the browser is Internet Explorer or not (last updated 1.7)

API Tags:

Return:	True if the browser is Internet Explorer otherwise false
Access:	protected

[ Top ]

checkBrowseriPad [line 934]

boolean checkBrowseriPad(
)

Determine if the browser is iPod or not (last updated 1.7)

API Tags:

Return:	True if the browser is iPod otherwise false
Access:	protected

[ Top ]

checkBrowseriPhone [line 913]

boolean checkBrowseriPhone(
)

Determine if the browser is iPhone or not (last updated 1.7)

API Tags:

Return:	True if the browser is iPhone otherwise false
Access:	protected

[ Top ]

checkBrowseriPod [line 955]

boolean checkBrowseriPod(
)

Determine if the browser is iPod or not (last updated 1.7)

API Tags:

Return:	True if the browser is iPod otherwise false
Access:	protected

[ Top ]

checkBrowserKonqueror [line 667]

boolean checkBrowserKonqueror(
)

Determine if the browser is Konqueror or not (last updated 1.7)

API Tags:

Return:	True if the browser is Konqueror otherwise false
Access:	protected

[ Top ]

checkBrowserLynx [line 863]

boolean checkBrowserLynx(
)

Determine if the browser is Lynx or not (last updated 1.7)

API Tags:

Return:	True if the browser is Lynx otherwise false
Access:	protected

[ Top ]

checkBrowserMozilla [line 837]

boolean checkBrowserMozilla(
)

Determine if the browser is Mozilla or not (last updated 1.7)

API Tags:

Return:	True if the browser is Mozilla otherwise false
Access:	protected

[ Top ]

checkBrowserMSNBot [line 460]

boolean checkBrowserMSNBot(
)

Determine if the browser is the MSNBot or not (last updated 1.9)

API Tags:

Return:	True if the browser is the MSNBot otherwise false
Access:	protected

[ Top ]

checkBrowserNetPositive [line 637]

boolean checkBrowserNetPositive(
)

Determine if the browser is NetPositive or not (last updated 1.7)

API Tags:

Return:	True if the browser is NetPositive otherwise false
Access:	protected

[ Top ]

checkBrowserNetscapeNavigator9Plus [line 740]

boolean checkBrowserNetscapeNavigator9Plus(
)

Determine if the browser is Netscape Navigator 9+ or not (last updated 1.7)

NOTE: (http://browser.netscape.com/ - Official support ended on March 1st, 2008)

API Tags:

Return:	True if the browser is Netscape Navigator 9+ otherwise false
Access:	protected

[ Top ]

checkBrowserNokia [line 784]

boolean checkBrowserNokia(
)

Determine if the browser is Nokia or not (last updated 1.7)

API Tags:

Return:	True if the browser is Nokia otherwise false
Access:	protected

[ Top ]

checkBrowserOmniWeb [line 696]

boolean checkBrowserOmniWeb(
)

Determine if the browser is OmniWeb or not (last updated 1.7)

API Tags:

Return:	True if the browser is OmniWeb otherwise false
Access:	protected

[ Top ]

checkBrowserOpera [line 566]

boolean checkBrowserOpera(
)

Determine if the browser is Opera or not (last updated 1.7)

API Tags:

Return:	True if the browser is Opera otherwise false
Access:	protected

[ Top ]

checkBrowserPhoenix [line 711]

boolean checkBrowserPhoenix(
)

Determine if the browser is Phoenix or not (last updated 1.7)

API Tags:

Return:	True if the browser is Phoenix otherwise false
Access:	protected

[ Top ]

checkBrowsers [line 353]

boolean checkBrowsers(
)

Protected routine to determine the browser type

API Tags:

Return:	True if the browser was detected otherwise false
Access:	protected

[ Top ]

checkBrowserSafari [line 893]

boolean checkBrowserSafari(
)

Determine if the browser is Safari or not (last updated 1.7)

API Tags:

Return:	True if the browser is Safari otherwise false
Access:	protected

[ Top ]

checkBrowserShiretoko [line 758]

boolean checkBrowserShiretoko(
)

Determine if the browser is Shiretoko or not (https://wiki.mozilla.org/Projects/shiretoko) (last updated 1.7)

API Tags:

Return:	True if the browser is Shiretoko otherwise false
Access:	protected

[ Top ]

checkBrowserSlurp [line 500]

boolean checkBrowserSlurp(
)

Determine if the browser is the Yahoo! Slurp Robot or not (last updated 1.7)

API Tags:

Return:	True if the browser is the Yahoo! Slurp Robot otherwise false
Access:	protected

[ Top ]

checkBrowserW3CValidator [line 476]

boolean checkBrowserW3CValidator(
)

Determine if the browser is the W3C Validator or not (last updated 1.7)

API Tags:

Return:	True if the browser is the W3C Validator otherwise false
Access:	protected

[ Top ]

checkBrowserWebTv [line 622]

boolean checkBrowserWebTv(
)

Determine if the browser is WebTv or not (last updated 1.7)

API Tags:

Return:	True if the browser is WebTv otherwise false
Access:	protected

[ Top ]

checkForAol [line 427]

boolean checkForAol(
)

Determine if the user is using an AOL User Agent (last updated 1.7)

API Tags:

Return:	True if the browser is from AOL otherwise false
Access:	protected

[ Top ]

checkPlatform [line 996]

void checkPlatform(
)

Determine the user's platform (last updated 1.7)

API Tags:

Access:

protected

[ Top ]

determine [line 344]

void determine(
)

Protected routine to calculate and determine what the browser is in use (including platform)

API Tags:

Access:

protected

[ Top ]

getAolVersion [line 273]

string getAolVersion(
)

The version of AOL.

API Tags:

Return:	Version of AOL (will only contain alpha-numeric characters and a period)
Access:	public

[ Top ]

getBrowser [line 243]

string getBrowser(
)

The name of the browser. All return types are from the class contants

API Tags:

Return:	Name of the browser
Access:	public

[ Top ]

getPlatform [line 253]

string getPlatform(
)

The name of the platform. All return types are from the class contants

API Tags:

Return:	Name of the browser
Access:	public

[ Top ]

getUserAgent [line 313]

string getUserAgent(
)

Get the user agent value in use to determine the browser

API Tags:

Return:	The user agent from the HTTP header
Access:	public

[ Top ]

getVersion [line 263]

string getVersion(
)

The version of the browser.

API Tags:

Return:	Version of the browser (will only contain alpha-numeric characters and a period)
Access:	public

[ Top ]

isAol [line 283]

boolean isAol(
)

Is the browser from AOL?

API Tags:

Return:	True if the browser is from AOL otherwise false
Access:	public

[ Top ]

isBrowser [line 237]

True isBrowser(
string
$browserName 
)

Check to see if the specific browser is valid

Parameters:

string

$browserName:

API Tags:

Return:

if the browser is the specified browser

[ Top ]

isChromeFrame [line 328]

boolean isChromeFrame(
)

Used to determine if the browser is actually "chromeframe"

API Tags:

Return:	True if the browser is using chromeframe
Access:	public

Information Tags:

Since:

1.7

[ Top ]

isMobile [line 288]

boolean isMobile(
)

Is the browser from a mobile device?

API Tags:

Return:	True if the browser is from a mobile device otherwise false
Access:	public

[ Top ]

isRobot [line 293]

boolean isRobot(
)

Is the browser from a robot (ex Slurp,GoogleBot)?

API Tags:

Return:	True if the browser is from a robot otherwise false
Access:	public

[ Top ]

reset [line 220]

void reset(
)

Reset all properties

API Tags:

Access:

public

[ Top ]

setAol [line 298]

void setAol(
$isAol
$isAol 
)

Set the browser to be from AOL

Parameters:

$isAol

$isAol:

API Tags:

Access:

public

[ Top ]

setAolVersion [line 278]

void setAolVersion(
$version
$version 
)

Set the version of AOL

Parameters:

$version

$version:

The version of AOL

API Tags:

Access:

public

[ Top ]

setBrowser [line 248]

void setBrowser(
$browser
$browser 
)

Set the name of the browser

Parameters:

$browser

$browser:

The name of the Browser

API Tags:

Access:

public

[ Top ]

setMobile [line 303]

void setMobile(
[boolean
$value = true] 
)

Set the Browser to be mobile

Parameters:

boolean

$value:

is the browser a mobile brower or not

API Tags:

Access:

protected

[ Top ]

setPlatform [line 258]

void setPlatform(
$platform
$platform 
)

Set the name of the platform

Parameters:

$platform

$platform:

The name of the Platform

API Tags:

Access:

public

[ Top ]

setRobot [line 308]

void setRobot(
[boolean
$value = true] 
)

Set the Browser to be a robot

Parameters:

boolean

$value:

is the browser a robot or not

API Tags:

Access:

protected

[ Top ]

setUserAgent [line 318]

void setUserAgent(
$agent_string
$agent_string 
)

Set the user agent value (the construction will use the HTTP header value - this will overwrite it)

Parameters:

$agent_string

$agent_string:

The value for the User Agent

API Tags:

Access:

public

[ Top ]

setVersion [line 268]

void setVersion(
$version
$version 
)

Set the version of the browser

Parameters:

$version

$version:

The version of the Browser

API Tags:

Access:

public

[ Top ]

__toString [line 335]

string __toString(
)

Returns a formatted string with a summary of the details of the browser.

API Tags:

Return:	formatted string with a summary of the browser
Access:	public

[ Top ]

Constants

BROWSER_AMAYA = 'Amaya' [line 162]

[ Top ]

BROWSER_ANDROID = 'Android' [line 169]

[ Top ]

BROWSER_BLACKBERRY = 'BlackBerry' [line 173]

[ Top ]

BROWSER_CHROME = 'Chrome' [line 168]

[ Top ]

BROWSER_FIREBIRD = 'Firebird' [line 157]

[ Top ]

BROWSER_FIREFOX = 'Firefox' [line 158]

[ Top ]

BROWSER_GALEON = 'Galeon' [line 182]

[ Top ]

BROWSER_GOOGLEBOT = 'GoogleBot' [line 170]

[ Top ]

BROWSER_ICAB = 'iCab' [line 155]

[ Top ]

BROWSER_ICECAT = 'IceCat' [line 174]

[ Top ]

BROWSER_ICEWEASEL = 'Iceweasel' [line 159]

[ Top ]

BROWSER_IE = 'Internet Explorer' [line 152]

[ Top ]

BROWSER_IPAD = 'iPad' [line 167]

[ Top ]

BROWSER_IPHONE = 'iPhone' [line 165]

[ Top ]

BROWSER_IPOD = 'iPod' [line 166]

[ Top ]

BROWSER_KONQUEROR = 'Konqueror' [line 154]

[ Top ]

BROWSER_LYNX = 'Lynx' [line 163]

[ Top ]

BROWSER_MOZILLA = 'Mozilla' [line 161]

[ Top ]

BROWSER_MSN = 'MSN Browser' [line 177]

[ Top ]

BROWSER_MSNBOT = 'MSN Bot' [line 178]

[ Top ]

BROWSER_NETPOSITIVE = 'NetPositive' [line 183]

[ Top ]

BROWSER_NETSCAPE_NAVIGATOR = 'Netscape Navigator' [line 181]

[ Top ]

BROWSER_NOKIA = 'Nokia Browser' [line 176]

[ Top ]

BROWSER_NOKIA_S60 = 'Nokia S60 OSS Browser' [line 175]

[ Top ]

BROWSER_OMNIWEB = 'OmniWeb' [line 156]

[ Top ]

BROWSER_OPERA = 'Opera' [line 149]

[ Top ]

BROWSER_OPERA_MINI = 'Opera Mini' [line 150]

[ Top ]

BROWSER_PHOENIX = 'Phoenix' [line 184]

[ Top ]

BROWSER_POCKET_IE = 'Pocket Internet Explorer' [line 153]

[ Top ]

BROWSER_SAFARI = 'Safari' [line 164]

[ Top ]

BROWSER_SHIRETOKO = 'Shiretoko' [line 160]

[ Top ]

BROWSER_SLURP = 'Yahoo! Slurp' [line 171]

[ Top ]

BROWSER_UNKNOWN = 'unknown' [line 146]

[ Top ]

BROWSER_W3CVALIDATOR = 'W3C Validator' [line 172]

[ Top ]

BROWSER_WEBTV = 'WebTV' [line 151]

[ Top ]

OPERATING_SYSTEM_UNKNOWN = 'unknown' [line 205]

[ Top ]

PLATFORM_ANDROID = 'Android' [line 203]

[ Top ]

PLATFORM_APPLE = 'Apple' [line 189]

[ Top ]

PLATFORM_BEOS = 'BeOS' [line 192]

[ Top ]

PLATFORM_BLACKBERRY = 'BlackBerry' [line 196]

[ Top ]

PLATFORM_FREEBSD = 'FreeBSD' [line 198]

[ Top ]

PLATFORM_IPAD = 'iPad' [line 195]

[ Top ]

PLATFORM_IPHONE = 'iPhone' [line 193]

[ Top ]

PLATFORM_IPOD = 'iPod' [line 194]

[ Top ]

PLATFORM_LINUX = 'Linux' [line 190]

[ Top ]

PLATFORM_NETBSD = 'NetBSD' [line 200]

[ Top ]

PLATFORM_NOKIA = 'Nokia' [line 197]

[ Top ]

PLATFORM_OPENBSD = 'OpenBSD' [line 199]

[ Top ]

PLATFORM_OPENSOLARIS = 'OpenSolaris' [line 202]

[ Top ]

PLATFORM_OS2 = 'OS/2' [line 191]

[ Top ]

PLATFORM_SUNOS = 'SunOS' [line 201]

[ Top ]

PLATFORM_UNKNOWN = 'unknown' [line 186]

[ Top ]

PLATFORM_WINDOWS = 'Windows' [line 187]

[ Top ]

PLATFORM_WINDOWS_CE = 'Windows CE' [line 188]

[ Top ]

VERSION_UNKNOWN = 'unknown' [line 147]

[ Top ]

Documentation generated on Mon, 13 Aug 2012 23:01:06 +0200 by phpDocumentor 1.4.4

	PegasusPHP

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