Documentation

Mobile_Detect

in package

• Application

Mobile Detect Library Motto: "Every business should have a mobile detection script to detect mobile readers"

Tags

license

https://github.com/serbanghita/Mobile-Detect/blob/master/LICENSE.txt MIT License

author

Serban Ghita serbanghita@gmail.com

author

Nick Ilyin nick.ilyin@gmail.com Original author: Victor Stanciu vic.stanciu@gmail.com

version

2.8.33

Table of Contents

DETECTION_TYPE_EXTENDED  = 'extended'

Extended detection type.

DETECTION_TYPE_MOBILE  = 'mobile'

Mobile detection type.

MOBILE_GRADE_A  = 'A'

Top-level device.

MOBILE_GRADE_B  = 'B'

Mid-level device.

MOBILE_GRADE_C  = 'C'

Low-level device.

VER  = '([\w._\+]+)'

A frequently used regular expression to extract version #s.

VERSION  = '2.8.33'

Stores the version number of the current release.

VERSION_TYPE_FLOAT  = 'float'

A type for the version() method indicating a float return value.

VERSION_TYPE_STRING  = 'text'

A type for the version() method indicating a string return value.

$browsers  : array<string|int, mixed>

List of mobile User Agents.

$cache  : array<string|int, mixed>

A cache for resolved matches

$cloudfrontHeaders  : array<string|int, mixed>

CloudFront headers. E.g. CloudFront-Is-Desktop-Viewer, CloudFront-Is-Mobile-Viewer & CloudFront-Is-Tablet-Viewer.

$detectionType  : string

The detection type, using self::DETECTION_TYPE_MOBILE or self::DETECTION_TYPE_EXTENDED.

$httpHeaders  : array<string|int, mixed>

HTTP headers in the PHP-flavor. So HTTP_USER_AGENT and SERVER_SOFTWARE.

$matchesArray  : string

The matches extracted from the regex expression.

$matchingRegex  : string

The matching Regex.

$mobileHeaders  : array<string|int, mixed>

HTTP headers that trigger the 'isMobile' detection to be true.

$operatingSystems  : array<string|int, mixed>

List of mobile Operating Systems.

$phoneDevices  : array<string|int, mixed>

List of mobile devices (phones).

$properties  : array<string|int, mixed>

The individual segments that could exist in a User-Agent string. VER refers to the regular expression defined in the constant self::VER.

$tabletDevices  : array<string|int, mixed>

List of tablet devices.

$uaHttpHeaders  : array<string|int, mixed>

All possible HTTP headers that represent the User-Agent string.

$userAgent  : string

The User-Agent HTTP header is stored in here.

$utilities  : array<string|int, mixed>

Utilities.

__call()  : mixed

Magic overloading method.

__construct()  : mixed

Construct an instance of this class.

checkHttpHeadersForMobile()  : bool

Check the HTTP headers for signs of mobile.

getBrowsers()  : array<string|int, mixed>

Retrieve the list of known browsers. Specifically, the user agents.

getCfHeaders()  : array<string|int, mixed>

Retrieves the cloudfront headers.

getHttpHeader()  : string|null

Retrieves a particular header. If it doesn't exist, no exception/error is caused.

getHttpHeaders()  : array<string|int, mixed>

Retrieves the HTTP headers.

getMatchesArray()  : mixed

getMatchingRegex()  : mixed

getMobileDetectionRules()  : array<string|int, mixed>

Method gets the mobile detection rules. This method is used for the magic methods $detect->is*().

getMobileDetectionRulesExtended()  : array<string|int, mixed>

Method gets the mobile detection rules + utilities.

getMobileHeaders()  : mixed

getOperatingSystems()  : array<string|int, mixed>

Retrieve the list of mobile operating systems.

getPhoneDevices()  : array<string|int, mixed>

Retrieve the list of known phone devices.

getProperties()  : array<string|int, mixed>

Get the properties array.

getRules()  : array<string|int, mixed>

Retrieve the current set of rules.

getScriptVersion()  : string

Get the current script version.

getTabletDevices()  : array<string|int, mixed>

Retrieve the list of known tablet devices.

getUaHttpHeaders()  : array<string|int, mixed>

Get all possible HTTP headers that can contain the User-Agent string.

getUserAgent()  : string|null

Retrieve the User-Agent.

getUserAgents()  : array<string|int, mixed>

Alias for getBrowsers() method.

getUtilities()  : array<string|int, mixed>

Retrieve the list of known utilities.

is()  : bool|int|null

This method checks for a certain property in the userAgent.

isMobile()  : bool

Check if the device is mobile.

isTablet()  : bool

Check if the device is a tablet.

match()  : bool

Some detection rules are relative (not standard), because of the diversity of devices, vendors and their conventions in representing the User-Agent or the HTTP headers.

mobileGrade()  : string

Retrieve the mobile grading, using self::MOBILE_GRADE_* constants.

prepareVersionNo()  : float

Prepare the version number.

setCfHeaders()  : bool

Set CloudFront headers http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/header-caching.html#header-caching-web-device

setDetectionType()  : mixed

Set the detection type. Must be one of self::DETECTION_TYPE_MOBILE or self::DETECTION_TYPE_EXTENDED. Otherwise, nothing is set.

setHttpHeaders()  : mixed

Set the HTTP Headers. Must be PHP-flavored. This method will reset existing headers.

setUserAgent()  : string|null

Set the User-Agent to be used.

version()  : string|float

Check the version of the given property in the User-Agent.

matchDetectionRulesAgainstUA()  : bool

Find a detection rule that matches the current User-agent.

matchUAAgainstKey()  : bool

Search for a certain key in the rules array.

prepareUserAgent()  : string