spunQ_IHttpClientBrowserInformation Interface Reference

Information about the browser of an HTTP client. More...

Inheritance diagram for spunQ_IHttpClientBrowserInformation:

spunQ_HttpClientBrowserInformation

List of all members.

Public Member Functions

 getBrand ()
 The browser type.
 getVersionString ()
 The whole version string.
 getMajorversion ()
 Major version of the browser.
 isBot ()
 Whether the 'browser' is actually a web crawler.

Public Attributes

const BROWSER_UNKNOWN = 0
 Unidentified browser.
const BROWSER_IE = 1
 Internet explorer.
const BROWSER_FIREFOX = 2
 Mozilla Firefox.
const BROWSER_SAFARI = 3
 Safari.
const BROWSER_CHROME = 4
 Google Chrome.
const BROWSER_OPERA = 5
 Opera.


Detailed Description

Information about the browser of an HTTP client.

Definition at line 6 of file IHttpClientBrowserInformation.interface.php.


Member Function Documentation

spunQ_IHttpClientBrowserInformation::getBrand (  ) 

The browser type.

Returns:
integer Either of the BROWSER_* constants.

Implemented in spunQ_HttpClientBrowserInformation.

spunQ_IHttpClientBrowserInformation::getMajorversion (  ) 

Major version of the browser.

Some browser don't have a minor version (*cough* explorer *cough*), while others use obscure versioning strings that are incompatible with the actual browser version (*choke* safari). This is why the major version is the only part common to all browsers.

Type:
integer

Implemented in spunQ_HttpClientBrowserInformation.

spunQ_IHttpClientBrowserInformation::getVersionString (  ) 

The whole version string.

Note that version string need not contain its major version number.

Type:
string

Implemented in spunQ_HttpClientBrowserInformation.

spunQ_IHttpClientBrowserInformation::isBot (  ) 

Whether the 'browser' is actually a web crawler.

We can be quite sure that a client is a browser, but we cannot know if a malicious bot is not spoofing its user-agent string, so don't trust this value too much.

Returns:
boolean

Implemented in spunQ_HttpClientBrowserInformation.


The documentation for this interface was generated from the following file:

Generated on Fri Jul 1 11:12:41 2011 for spunQ3 by  doxygen 1.5.9