UserAgent class

Framework\HTTP\UserAgent

Class UserAgent.

Implements: JsonSerializable, Stringable

Defined in libraries/http/src/UserAgent.php

Properties #

$agent
-
$browser
-
$browserVersion
-
$mobile
-
$platform
-
$robot
-
$isBrowser
-
$isMobile
-
$isRobot
-
$config
-

$agent

protected ?string $agent = NULL

$browser

protected ?string $browser = NULL

$browserVersion

protected ?string $browserVersion = NULL

$mobile

protected ?string $mobile = NULL

$platform

protected ?string $platform = NULL

$robot

protected ?string $robot = NULL

$isBrowser

protected bool $isBrowser = false

$isMobile

protected bool $isMobile = false

$isRobot

protected bool $isRobot = false

$config

protected static array $config = array ( 'platforms' => array ( 'windows nt 10.0' => 'Windows 10', 'windows nt 6.3' => 'Windows 8.1', 'windows nt 6.2' => 'Windows 8', 'windows nt 6.1' => 'Windows 7', 'windows nt 6.0' => 'Windows Vista', 'windows nt 5.2' => 'Windows 2003', 'windows nt 5.1' => 'Windows XP', 'windows nt 5.0' => 'Windows 2000', 'windows nt 4.0' => 'Windows NT 4.0', 'winnt4.0' => 'Windows NT 4.0', 'winnt 4.0' => 'Windows NT', 'winnt' => 'Windows NT', 'windows 98' => 'Windows 98', 'win98' => 'Windows 98', 'windows 95' => 'Windows 95', 'win95' => 'Windows 95', 'windows phone' => 'Windows Phone', 'windows' => 'Unknown Windows OS', 'android' => 'Android', 'blackberry' => 'BlackBerry', 'iphone' => 'iOS', 'ipad' => 'iOS', 'ipod' => 'iOS', 'os x' => 'Mac OS X', 'ppc mac' => 'Power PC Mac', 'freebsd' => 'FreeBSD', 'ppc' => 'Macintosh', 'ubuntu' => 'Ubuntu', 'debian' => 'Debian', 'fedora' => 'Fedora', 'linux' => 'Linux', 'sunos' => 'Sun Solaris', 'beos' => 'BeOS', 'apachebench' => 'ApacheBench', 'aix' => 'AIX', 'irix' => 'Irix', 'osf' => 'DEC OSF', 'hp-ux' => 'HP-UX', 'netbsd' => 'NetBSD', 'bsdi' => 'BSDi', 'openbsd' => 'OpenBSD', 'gnu' => 'GNU/Linux', 'unix' => 'Unknown Unix OS', 'symbian' => 'Symbian OS', ), 'browsers' => array ( 'curl' => 'Curl', 'PostmanRuntime' => 'Postman', 'OPR' => 'Opera', 'Flock' => 'Flock', 'Edge' => 'Spartan', 'Edg' => 'Edge', 'EdgA' => 'Edge', 'Chrome' => 'Chrome', 'Opera.*?Version' => 'Opera', 'Opera' => 'Opera', 'MSIE' => 'Internet Explorer', 'Internet Explorer' => 'Internet Explorer', 'Trident.* rv' => 'Internet Explorer', 'Shiira' => 'Shiira', 'Firefox' => 'Firefox', 'Chimera' => 'Chimera', 'Phoenix' => 'Phoenix', 'Firebird' => 'Firebird', 'Camino' => 'Camino', 'Netscape' => 'Netscape', 'OmniWeb' => 'OmniWeb', 'Safari' => 'Safari', 'Mozilla' => 'Mozilla', 'Konqueror' => 'Konqueror', 'icab' => 'iCab', 'Lynx' => 'Lynx', 'Links' => 'Links', 'hotjava' => 'HotJava', 'amaya' => 'Amaya', 'IBrowse' => 'IBrowse', 'Maxthon' => 'Maxthon', 'Ubuntu' => 'Ubuntu Web Browser', 'Vivaldi' => 'Vivaldi', ), 'mobiles' => array ( 'mobileexplorer' => 'Mobile Explorer', 'palmsource' => 'Palm', 'palmscape' => 'Palmscape', 'motorola' => 'Motorola', 'nokia' => 'Nokia', 'palm' => 'Palm', 'iphone' => 'Apple iPhone', 'ipad' => 'iPad', 'ipod' => 'Apple iPod Touch', 'sony' => 'Sony Ericsson', 'ericsson' => 'Sony Ericsson', 'blackberry' => 'BlackBerry', 'cocoon' => 'O2 Cocoon', 'blazer' => 'Treo', 'lg' => 'LG', 'amoi' => 'Amoi', 'xda' => 'XDA', 'mda' => 'MDA', 'vario' => 'Vario', 'htc' => 'HTC', 'samsung' => 'Samsung', 'sharp' => 'Sharp', 'sie-' => 'Siemens', 'alcatel' => 'Alcatel', 'benq' => 'BenQ', 'ipaq' => 'HP iPaq', 'mot-' => 'Motorola', 'playstation portable' => 'PlayStation Portable', 'playstation 3' => 'PlayStation 3', 'playstation vita' => 'PlayStation Vita', 'hiptop' => 'Danger Hiptop', 'nec-' => 'NEC', 'panasonic' => 'Panasonic', 'philips' => 'Philips', 'sagem' => 'Sagem', 'sanyo' => 'Sanyo', 'spv' => 'SPV', 'zte' => 'ZTE', 'sendo' => 'Sendo', 'nintendo dsi' => 'Nintendo DSi', 'nintendo ds' => 'Nintendo DS', 'nintendo 3ds' => 'Nintendo 3DS', 'wii' => 'Nintendo Wii', 'open web' => 'Open Web', 'openweb' => 'OpenWeb', 'android' => 'Android', 'symbian' => 'Symbian', 'SymbianOS' => 'SymbianOS', 'elaine' => 'Palm', 'series60' => 'Symbian S60', 'windows ce' => 'Windows CE', 'obigo' => 'Obigo', 'netfront' => 'Netfront Browser', 'openwave' => 'Openwave Browser', 'mobilexplorer' => 'Mobile Explorer', 'operamini' => 'Opera Mini', 'opera mini' => 'Opera Mini', 'opera mobi' => 'Opera Mobile', 'fennec' => 'Firefox Mobile', 'digital paths' => 'Digital Paths', 'avantgo' => 'AvantGo', 'xiino' => 'Xiino', 'novarra' => 'Novarra Transcoder', 'vodafone' => 'Vodafone', 'docomo' => 'NTT DoCoMo', 'o2' => 'O2', 'mobile' => 'Generic Mobile', 'wireless' => 'Generic Mobile', 'j2me' => 'Generic Mobile', 'midp' => 'Generic Mobile', 'cldc' => 'Generic Mobile', 'up.link' => 'Generic Mobile', 'up.browser' => 'Generic Mobile', 'smartphone' => 'Generic Mobile', 'cellphone' => 'Generic Mobile', ), 'robots' => array ( 'googlebot' => 'Googlebot', 'msnbot' => 'MSNBot', 'baiduspider' => 'Baiduspider', 'bingbot' => 'Bing', 'slurp' => 'Inktomi Slurp', 'yahoo' => 'Yahoo', 'ask jeeves' => 'Ask Jeeves', 'fastcrawler' => 'FastCrawler', 'infoseek' => 'InfoSeek Robot 1.0', 'lycos' => 'Lycos', 'yandex' => 'YandexBot', 'mediapartners-google' => 'MediaPartners Google', 'CRAZYWEBCRAWLER' => 'Crazy Webcrawler', 'adsbot-google' => 'AdsBot Google', 'feedfetcher-google' => 'Feedfetcher Google', 'curious george' => 'Curious George', 'ia_archiver' => 'Alexa Crawler', 'MJ12bot' => 'Majestic-12', 'Uptimebot' => 'Uptimebot', ), )

Methods #

__construct()
UserAgent constructor.
__toString()
-
getBrowser()
Gets the Browser name.
getBrowserVersion()
Gets the Browser Version.
getMobile()
Gets the Mobile device.
getName()
-
getPlatform()
Gets the OS Platform.
getRobot()
Gets the Robot name.
getType()
-
isBrowser()
Is Browser.
isMobile()
Is Mobile.
isRobot()
Is Robot.
jsonSerialize()
-
toString()
Get the User-Agent as string.
compileData()
-
parse()
-
setBrowser()
-
setMobile()
-
setPlatform()
-
setRobot()
-

__construct()

public function __construct(string $userAgent)

UserAgent constructor.

Parameters
  • string $userAgent - User-Agent string

__toString()

public function __toString(): string
Returns string

getBrowser()

public function getBrowser(): ?string

Gets the Browser name.

Returns ?string

getBrowserVersion()

public function getBrowserVersion(): ?string

Gets the Browser Version.

Returns ?string

getMobile()

public function getMobile(): ?string

Gets the Mobile device.

Returns ?string

getName()

public function getName(): string
Returns string

getPlatform()

public function getPlatform(): ?string

Gets the OS Platform.

Returns ?string

getRobot()

public function getRobot(): ?string

Gets the Robot name.

Returns ?string

getType()

public function getType(): string
Returns string

isBrowser()

public function isBrowser(?string $key = NULL): bool

Is Browser.

Parameters
  • ?string $key
Returns bool

isMobile()

public function isMobile(?string $key = NULL): bool

Is Mobile.

Parameters
  • ?string $key
Returns bool

isRobot()

public function isRobot(?string $key = NULL): bool

Is Robot.

Parameters
  • ?string $key
Returns bool

jsonSerialize()

public function jsonSerialize(): string
Returns string

toString()

public function toString(): string

Get the User-Agent as string.

Returns string

compileData()

protected function compileData(): void
Returns void

parse()

protected function parse(string $string): static
Parameters
  • string $string
Returns static

setBrowser()

protected function setBrowser(): bool
Returns bool

setMobile()

protected function setMobile(): bool
Returns bool

setPlatform()

protected function setPlatform(): bool
Returns bool

setRobot()

protected function setRobot(): bool
Returns bool