Class JWebClient

Description

Class to model a Web Client.

  • since: 11.3

Located in /libraries/joomla/application/web/webclient.php (line 19)


	
			
Class Constant Summary
AMAYA = 16
ANDROID = 9
CHROME = 19
FIREFOX = 18
GECKO = 13
IE = 17
IPAD = 5
IPHONE = 4
IPOD = 6
KHTML = 15
LINUX = 10
MAC = 7
OPERA = 21
PRESTO = 14
SAFARI = 20
TRIDENT = 11
WEBKIT = 12
WINDOWS = 1
Variable Summary
integer $browser
array $detection
array $encodings
integer $engine
array $languages
boolean $mobile
integer $platform
string $userAgent
Method Summary
void detectBrowser (string $userAgent)
void detectEncoding (string $acceptEncoding)
void detectEngine (string $userAgent)
void detectLanguage (mixed $acceptLanguage)
void detectPlatform (string $userAgent)
JWebClient __construct ([mixed $userAgent = null], [mixed $acceptEncoding = null], [mixed $acceptLanguage = null])
mixed __get (string $name)
Variables
string $acceptEncoding (line 95)
  • var: The web client's accepted encoding string.
  • since: 11.3
  • access: protected
string $acceptLanguage (line 101)
  • var: The web client's accepted languages string.
  • since: 11.3
  • access: protected
integer $browser (line 65)
  • var: The detected browser used by the web client.
  • since: 11.3
  • access: protected
string $browserVersion (line 71)
  • var: The detected browser version used by the web client.
  • since: 11.3
  • access: protected
array $detection = array() (line 107)
  • var: An array of flags determining whether or not a detection routine has been run.
  • since: 11.3
  • access: protected
array $encodings = array() (line 83)
  • var: The priority order detected accepted encodings for the client.
  • since: 11.3
  • access: protected
integer $engine (line 59)
  • var: The detected rendering engine used by the web client.
  • since: 11.3
  • access: protected
array $languages = array() (line 77)
  • var: The priority order detected accepted languages for the client.
  • since: 11.3
  • access: protected
boolean $mobile = false (line 53)
  • var: True if the web client is a mobile device.
  • since: 11.3
  • access: protected
integer $platform (line 47)
  • var: The detected platform on which the web client runs.
  • since: 11.3
  • access: protected
string $userAgent (line 89)
  • var: The web client's user agent string.
  • since: 11.3
  • access: protected
Methods
detectBrowser (line 218)

Detects the client browser and version in a user agent string.

  • since: 11.3
  • access: protected
void detectBrowser (string $userAgent)
  • string $userAgent: The user-agent string to parse.
detectEncoding (line 291)

Method to detect the accepted response encoding by the client.

  • since: 11.3
  • access: protected
void detectEncoding (string $acceptEncoding)
  • string $acceptEncoding: The client accept encoding string to parse.
detectEngine (line 309)

Detects the client rendering engine in a user agent string.

  • since: 11.3
  • access: protected
void detectEngine (string $userAgent)
  • string $userAgent: The user-agent string to parse.
detectLanguage (line 355)

Method to detect the accepted languages by the client.

  • since: 11.3
  • access: protected
void detectLanguage (mixed $acceptLanguage)
  • mixed $acceptLanguage: The client accept language string to parse.
detectPlatform (line 373)

Detects the client platform in a user agent string.

  • since: 11.3
  • access: protected
void detectPlatform (string $userAgent)
  • string $userAgent: The user-agent string to parse.
Constructor __construct (line 118)

Class constructor.

  • since: 11.3
  • access: public
JWebClient __construct ([mixed $userAgent = null], [mixed $acceptEncoding = null], [mixed $acceptLanguage = null])
  • mixed $userAgent: The optional user-agent string to parse.
  • mixed $acceptEncoding: The optional client accept encoding string to parse.
  • mixed $acceptLanguage: The optional client accept language string to parse.
__get (line 160)

Magic method to get an object property's value by name.

  • return: The requested value if it exists.
  • since: 11.3
  • access: public
mixed __get (string $name)
  • string $name: Name of the property for which to return a value.
Class Constants
AMAYA = 16 (line 36)
ANDROID = 9 (line 29)
BLACKBERRY = 8 (line 28)
CHROME = 19 (line 39)
FIREFOX = 18 (line 38)
GECKO = 13 (line 33)
IE = 17 (line 37)
IPAD = 5 (line 25)
IPHONE = 4 (line 24)
IPOD = 6 (line 26)
KHTML = 15 (line 35)
LINUX = 10 (line 30)
MAC = 7 (line 27)
OPERA = 21 (line 41)
PRESTO = 14 (line 34)
SAFARI = 20 (line 40)
TRIDENT = 11 (line 31)
WEBKIT = 12 (line 32)
WINDOWS = 1 (line 21)
WINDOWS_CE = 3 (line 23)
WINDOWS_PHONE = 2 (line 22)

Documentation generated on Mon, 25 Jun 2012 14:01:31 -0500 by phpDocumentor 1.4.4