CodeIgniter v3.0.0 API
\

\CI_User_agent

User Agent Class

Identifies the platform, browser, robot, or mobile device of the browsing agent

Summary

Methods
Properties
Constants
__construct()
is_browser()
is_robot()
is_mobile()
is_referral()
agent_string()
platform()
browser()
version()
robot()
mobile()
referrer()
languages()
charsets()
accept_lang()
accept_charset()
parse()
$agent
$is_browser
$is_robot
$is_mobile
$languages
$charsets
$platforms
$browsers
$mobiles
$robots
$platform
$browser
$version
$mobile
$robot
$referer
No constants found
_load_agent_file()
_compile_data()
_set_platform()
_set_browser()
_set_robot()
_set_mobile()
_set_languages()
_set_charsets()
No protected properties found
N/A
No private methods found
No private properties found
N/A

Properties

$agent

$agent : string

Current user-agent

Type

string

$is_browser

$is_browser : boolean

Flag for if the user-agent belongs to a browser

Type

boolean

$is_robot

$is_robot : boolean

Flag for if the user-agent is a robot

Type

boolean

$is_mobile

$is_mobile : boolean

Flag for if the user-agent is a mobile browser

Type

boolean

$languages

$languages : array

Languages accepted by the current user agent

Type

array

$charsets

$charsets : array

Character sets accepted by the current user agent

Type

array

$platforms

$platforms : array

List of platforms to compare against current user agent

Type

array

$browsers

$browsers : array

List of browsers to compare against current user agent

Type

array

$mobiles

$mobiles : array

List of mobile browsers to compare against current user agent

Type

array

$robots

$robots : array

List of robots to compare against current user agent

Type

array

$platform

$platform : string

Current user-agent platform

Type

string

$browser

$browser : string

Current user-agent browser

Type

string

$version

$version : string

Current user-agent version

Type

string

$mobile

$mobile : string

Current user-agent mobile name

Type

string

$robot

$robot : string

Current user-agent robot name

Type

string

$referer

$referer : mixed

HTTP Referer

Type

mixed

Methods

__construct()

__construct() : void

Constructor

Sets the User Agent and runs the compilation routine

is_browser()

is_browser(string  $key = NULL) : boolean

Is Browser

Parameters

string $key

Returns

boolean

is_robot()

is_robot(string  $key = NULL) : boolean

Is Robot

Parameters

string $key

Returns

boolean

is_mobile()

is_mobile(string  $key = NULL) : boolean

Is Mobile

Parameters

string $key

Returns

boolean

is_referral()

is_referral() : boolean

Is this a referral from another site?

Returns

boolean

agent_string()

agent_string() : string

Agent String

Returns

string

platform()

platform() : string

Get Platform

Returns

string

browser()

browser() : string

Get Browser Name

Returns

string

version()

version() : string

Get the Browser Version

Returns

string

robot()

robot() : string

Get The Robot Name

Returns

string

mobile()

mobile() : string

Get the Mobile Device

Returns

string

referrer()

referrer() : boolean

Get the referrer

Returns

boolean

languages()

languages() : array

Get the accepted languages

Returns

array

charsets()

charsets() : array

Get the accepted Character Sets

Returns

array

accept_lang()

accept_lang(string  $lang = 'en') : boolean

Test for a particular language

Parameters

string $lang

Returns

boolean

accept_charset()

accept_charset(string  $charset = 'utf-8') : boolean

Test for a particular character set

Parameters

string $charset

Returns

boolean

parse()

parse(string  $string) : void

Parse a custom user-agent string

Parameters

string $string

_load_agent_file()

_load_agent_file() : boolean

Compile the User Agent Data

Returns

boolean

_compile_data()

_compile_data() : boolean

Compile the User Agent Data

Returns

boolean

_set_platform()

_set_platform() : boolean

Set the Platform

Returns

boolean

_set_browser()

_set_browser() : boolean

Set the Browser

Returns

boolean

_set_robot()

_set_robot() : boolean

Set the Robot

Returns

boolean

_set_mobile()

_set_mobile() : boolean

Set the Mobile Device

Returns

boolean

_set_languages()

_set_languages() : void

Set the accepted languages

_set_charsets()

_set_charsets() : void

Set the accepted character sets