Bitrix-D7 23.9
 
Загрузка...
Поиск...
Не найдено
Класс MobileDetect

Открытые члены

 __construct (array $headers=null, $userAgent=null)
 
 setHttpHeaders ($httpHeaders=null)
 
 getHttpHeaders ()
 
 getHttpHeader ($header)
 
 getMobileHeaders ()
 
 getUaHttpHeaders ()
 
 setUserAgent ($userAgent=null)
 
 getUserAgent ()
 
 setDetectionType ($type=null)
 
 getMatchingRegex ()
 
 getMatchesArray ()
 
 getMobileDetectionRulesExtended ()
 
 getRules ()
 
 checkHttpHeadersForMobile ()
 
 __call ($name, $arguments)
 
 isMobile ($userAgent=null, $httpHeaders=null)
 
 isTablet ($userAgent=null, $httpHeaders=null)
 
 is ($key, $userAgent=null, $httpHeaders=null)
 
 match ($regex, $userAgent=null)
 
 prepareVersionNo ($ver)
 
 version ($propertyName, $type=self::VERSION_TYPE_STRING)
 
 mobileGrade ()
 

Открытые статические члены

static getScriptVersion ()
 
static getPhoneDevices ()
 
static getTabletDevices ()
 
static getUserAgents ()
 
static getBrowsers ()
 
static getUtilities ()
 
static getMobileDetectionRules ()
 
static getOperatingSystems ()
 
static getProperties ()
 

Открытые атрибуты

const DETECTION_TYPE_MOBILE = 'mobile'
 
const DETECTION_TYPE_EXTENDED = 'extended'
 
const VER = '([\w._\+]+)'
 
const MOBILE_GRADE_A = 'A'
 
const MOBILE_GRADE_B = 'B'
 
const MOBILE_GRADE_C = 'C'
 
const VERSION = '2.8.13'
 
const VERSION_TYPE_STRING = 'text'
 
const VERSION_TYPE_FLOAT = 'float'
 

Защищенные члены

 matchDetectionRulesAgainstUA ($userAgent=null)
 
 matchUAAgainstKey ($key)
 

Защищенные данные

 $cache = array()
 
 $userAgent = null
 
 $httpHeaders = array()
 
 $matchingRegex = null
 
 $matchesArray = null
 
 $detectionType = self::DETECTION_TYPE_MOBILE
 

Статические защищенные данные

static $mobileHeaders
 
static $phoneDevices
 
static $tabletDevices
 
static $operatingSystems
 
static $browsers
 
static $utilities
 
static $uaHttpHeaders
 
static $properties
 

Подробное описание

См. определение в файле mobiledetect.php строка 32

Конструктор(ы)

◆ __construct()

__construct ( array $headers = null,
$userAgent = null )

Construct an instance of this class.

Аргументы
array$headersSpecify the headers as injection. Should be PHP SERVER flavored. If left empty, will use the global _SERVER['HTTP*'] vars instead.
string$userAgentInject the User-Agent header. If null, will use HTTP_USER_AGENT from the $headers array instead.

См. определение в файле mobiledetect.php строка 643

Методы

◆ __call()

__call ( $name,
$arguments )

Magic overloading method.

@method boolean is[...]()

Аргументы
string$name
array$arguments
Возвращает
mixed
Исключения
BadMethodCallExceptionwhen the method doesn't exist and doesn't start with 'is'

См. определение в файле mobiledetect.php строка 982

◆ checkHttpHeadersForMobile()

checkHttpHeadersForMobile ( )

Check the HTTP headers for signs of mobile. This is the fastest mobile check possible; it's used inside isMobile() method.

Возвращает
bool

См. определение в файле mobiledetect.php строка 950

◆ getBrowsers()

static getBrowsers ( )
static

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

Возвращает
array List of browsers / user agents.

См. определение в файле mobiledetect.php строка 850

◆ getHttpHeader()

getHttpHeader ( $header)

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

Аргументы
string$headerThe name of the header to retrieve. Can be HTTP compliant such as "User-Agent" or "X-Device-User-Agent" or can be php-esque with the all-caps, HTTP_ prefixed, underscore seperated awesomeness.
Возвращает
string|null The value of the header.

См. определение в файле mobiledetect.php строка 709

◆ getHttpHeaders()

getHttpHeaders ( )

Retrieves the HTTP headers.

Возвращает
array

См. определение в файле mobiledetect.php строка 694

◆ getMatchesArray()

getMatchesArray ( )

См. определение в файле mobiledetect.php строка 810

◆ getMatchingRegex()

getMatchingRegex ( )

См. определение в файле mobiledetect.php строка 805

◆ getMobileDetectionRules()

static getMobileDetectionRules ( )
static

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

Возвращает
array All the rules (but not extended).

См. определение в файле mobiledetect.php строка 872

◆ getMobileDetectionRulesExtended()

getMobileDetectionRulesExtended ( )

Method gets the mobile detection rules + utilities. The reason this is separate is because utilities rules don't necessary imply mobile. This method is used inside the new $detect->is('stuff') method.

Возвращает
array All the rules + extended.

См. определение в файле mobiledetect.php строка 899

◆ getMobileHeaders()

getMobileHeaders ( )

См. определение в файле mobiledetect.php строка 730

◆ getOperatingSystems()

static getOperatingSystems ( )
static

Retrieve the list of mobile operating systems.

Возвращает
array The list of mobile operating systems.

См. определение в файле mobiledetect.php строка 938

◆ getPhoneDevices()

static getPhoneDevices ( )
static

Retrieve the list of known phone devices.

Возвращает
array List of phone devices.

См. определение в файле mobiledetect.php строка 820

◆ getProperties()

static getProperties ( )
static

Get the properties array.

Возвращает
array

См. определение в файле mobiledetect.php строка 1155

◆ getRules()

getRules ( )

Retrieve the current set of rules.

Возвращает
array

См. определение в файле mobiledetect.php строка 924

◆ getScriptVersion()

static getScriptVersion ( )
static

Get the current script version. This is useful for the demo.php file, so people can check on what version they are testing for mobile devices.

Возвращает
string The version number in semantic version format.

См. определение в файле mobiledetect.php строка 659

◆ getTabletDevices()

static getTabletDevices ( )
static

Retrieve the list of known tablet devices.

Возвращает
array List of tablet devices.

См. определение в файле mobiledetect.php строка 830

◆ getUaHttpHeaders()

getUaHttpHeaders ( )

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

Возвращает
array List of HTTP headers.

См. определение в файле mobiledetect.php строка 741

◆ getUserAgent()

getUserAgent ( )

Retrieve the User-Agent.

Возвращает
string|null The user agent if it's set.

См. определение в файле mobiledetect.php строка 778

◆ getUserAgents()

static getUserAgents ( )
static

Alias for getBrowsers() method.

Возвращает
array List of user agents.

См. определение в файле mobiledetect.php строка 840

◆ getUtilities()

static getUtilities ( )
static

Retrieve the list of known utilities.

Возвращает
array List of utilities.

См. определение в файле mobiledetect.php строка 860

◆ is()

is ( $key,
$userAgent = null,
$httpHeaders = null )

This method checks for a certain property in the userAgent.

Аргументы
string$key
string$userAgentdeprecated
string$httpHeadersdeprecated
Возвращает
bool|int|null

См. определение в файле mobiledetect.php строка 1107

◆ isMobile()

isMobile ( $userAgent = null,
$httpHeaders = null )

Check if the device is mobile. Returns true if any type of mobile device detected, including special ones

Аргументы
null$userAgentdeprecated
null$httpHeadersdeprecated
Возвращает
bool

См. определение в файле mobiledetect.php строка 1055

◆ isTablet()

isTablet ( $userAgent = null,
$httpHeaders = null )

Check if the device is a tablet. Return true if any type of tablet device is detected.

Аргументы
string$userAgentdeprecated
array$httpHeadersdeprecated
Возвращает
bool

См. определение в файле mobiledetect.php строка 1084

◆ match()

match ( $regex,
$userAgent = null )

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.

This method will be used to check custom regexes against the User-Agent string.

Аргументы
$regex
string$userAgent
Возвращает
bool

См. определение в файле mobiledetect.php строка 1138

◆ matchDetectionRulesAgainstUA()

matchDetectionRulesAgainstUA ( $userAgent = null)
protected

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

Аргументы
null$userAgentdeprecated
Возвращает
boolean

См. определение в файле mobiledetect.php строка 1002

◆ matchUAAgainstKey()

matchUAAgainstKey ( $key)
protected

Search for a certain key in the rules array. If the key is found the try to match the corresponding regex against the User-Agent.

Аргументы
string$key
Возвращает
boolean

См. определение в файле mobiledetect.php строка 1027

◆ mobileGrade()

mobileGrade ( )

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

Возвращает
string One of the self::MOBILE_GRADE_* constants.

См. определение в файле mobiledetect.php строка 1239

◆ prepareVersionNo()

prepareVersionNo ( $ver)

Prepare the version number.

Аргументы
string$verThe string version, like "2.6.21.2152";
Возвращает
float

См. определение в файле mobiledetect.php строка 1169

◆ setDetectionType()

setDetectionType ( $type = null)

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

Аргументы
string$typeThe type. Must be a self::DETECTION_TYPE_* constant. The default parameter is null which will default to self::DETECTION_TYPE_MOBILE.

См. определение в файле mobiledetect.php строка 792

◆ setHttpHeaders()

setHttpHeaders ( $httpHeaders = null)

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

Аргументы
array$httpHeadersThe headers to set. If null, then using PHP's _SERVER to extract the headers. The default null is left for backwards compatibilty.

См. определение в файле mobiledetect.php строка 670

◆ setUserAgent()

setUserAgent ( $userAgent = null)

Set the User-Agent to be used.

Аргументы
string$userAgentThe user agent string to set.
Возвращает
string|null

См. определение в файле mobiledetect.php строка 753

◆ version()

version ( $propertyName,
$type = self::VERSION_TYPE_STRING )

Check the version of the given property in the User-Agent. Will return a float number. (eg. 2_0 will return 2.0, 4.3.1 will return 4.31)

Аргументы
string$propertyNameThe name of the property. See self::getProperties() array keys for all possible properties.
string$typeEither self::VERSION_TYPE_STRING to get a string value or self::VERSION_TYPE_FLOAT indicating a float value. This parameter is optional and defaults to self::VERSION_TYPE_STRING. Passing an invalid parameter will default to the this type as well.
Возвращает
string|float The version of the property we are trying to extract.

См. определение в файле mobiledetect.php строка 1194

Данные класса

◆ $browsers

$browsers
staticprotected

См. определение в файле mobiledetect.php строка 489

◆ $cache

$cache = array()
protected

См. определение в файле mobiledetect.php строка 89

◆ $detectionType

$detectionType = self::DETECTION_TYPE_MOBILE
protected

См. определение в файле mobiledetect.php строка 124

◆ $httpHeaders

$httpHeaders = array()
protected

См. определение в файле mobiledetect.php строка 101

◆ $matchesArray

$matchesArray = null
protected

См. определение в файле mobiledetect.php строка 115

◆ $matchingRegex

$matchingRegex = null
protected

См. определение в файле mobiledetect.php строка 108

◆ $mobileHeaders

$mobileHeaders
staticprotected
Инициализатор
= array(
'HTTP_ACCEPT' => array('matches' => array(
'application/x-obml2d',
'application/vnd.rim.html',
'text/vnd.wap.wml',
'application/vnd.wap.xhtml+xml'
)),
'HTTP_X_WAP_PROFILE' => null,
'HTTP_X_WAP_CLIENTID' => null,
'HTTP_WAP_CONNECTION' => null,
'HTTP_PROFILE' => null,
'HTTP_X_OPERAMINI_PHONE_UA' => null,
'HTTP_X_NOKIA_GATEWAY_ID' => null,
'HTTP_X_ORANGE_ID' => null,
'HTTP_X_VODAFONE_3GPDPCONTEXT' => null,
'HTTP_X_HUAWEI_USERID' => null,
'HTTP_UA_OS' => null,
'HTTP_X_MOBILE_GATEWAY' => null,
'HTTP_X_ATT_DEVICEID' => null,
'HTTP_UA_CPU' => array('matches' => array('ARM')),
)

См. определение в файле mobiledetect.php строка 132

◆ $operatingSystems

$operatingSystems
staticprotected
Инициализатор
= array(
'AndroidOS' => 'Android',
'BlackBerryOS' => 'blackberry|\bBB10\b|rim tablet os',
'PalmOS' => 'PalmOS|avantgo|blazer|elaine|hiptop|palm|plucker|xiino',
'SymbianOS' => 'Symbian|SymbOS|Series60|Series40|SYB-[0-9]+|\bS60\b',
'WindowsMobileOS' => 'Windows CE.*(PPC|Smartphone|Mobile|[0-9]{3}x[0-9]{3})|Window Mobile|Windows Phone [0-9.]+|WCE;',
'WindowsPhoneOS' => 'Windows Phone 8.1|Windows Phone 8.0|Windows Phone OS|XBLWP7|ZuneWP7|Windows NT 6.[23]; ARM;',
'iOS' => '\biPhone.*Mobile|\biPod|\biPad',
'MeeGoOS' => 'MeeGo',
'MaemoOS' => 'Maemo',
'JavaOS' => 'J2ME/|\bMIDP\b|\bCLDC\b',
'webOS' => 'webOS|hpwOS',
'badaOS' => '\bBada\b',
'BREWOS' => 'BREW',
)

См. определение в файле mobiledetect.php строка 459

◆ $phoneDevices

$phoneDevices
staticprotected

См. определение в файле mobiledetect.php строка 167

◆ $properties

$properties
staticprotected

См. определение в файле mobiledetect.php строка 569

◆ $tabletDevices

$tabletDevices
staticprotected

См. определение в файле mobiledetect.php строка 214

◆ $uaHttpHeaders

$uaHttpHeaders
staticprotected
Инициализатор
= array(
'HTTP_USER_AGENT',
'HTTP_X_OPERAMINI_PHONE_UA',
'HTTP_X_DEVICE_USER_AGENT',
'HTTP_X_ORIGINAL_USER_AGENT',
'HTTP_X_SKYFIRE_PHONE',
'HTTP_X_BOLT_PHONE_UA',
'HTTP_DEVICE_STOCK_UA',
'HTTP_X_UCBROWSER_DEVICE_UA'
)

См. определение в файле mobiledetect.php строка 549

◆ $userAgent

$userAgent = null
protected

См. определение в файле mobiledetect.php строка 95

◆ $utilities

$utilities
staticprotected
Инициализатор
= array(
'Bot' => 'Googlebot|facebookexternalhit|AdsBot-Google|Google Keyword Suggestion|Facebot|YandexBot|bingbot|ia_archiver|AhrefsBot|Ezooms|GSLFbot|WBSearchBot|Twitterbot|TweetmemeBot|Twikle|PaperLiBot|Wotbox|UnwindFetchor',
'MobileBot' => 'Googlebot-Mobile|AdsBot-Google-Mobile|YahooSeeker/M1A1-R2D2',
'DesktopMode' => 'WPDesktop',
'TV' => 'SonyDTV|HbbTV',
'WebKit' => '(webkit)[ /]([\w.]+)',
'Console' => '\b(Nintendo|Nintendo WiiU|Nintendo 3DS|PLAYSTATION|Xbox)\b',
'Watch' => 'SM-V700',
)

См. определение в файле mobiledetect.php строка 528

◆ DETECTION_TYPE_EXTENDED

const DETECTION_TYPE_EXTENDED = 'extended'

Extended detection type.

См. определение в файле mobiledetect.php строка 46

◆ DETECTION_TYPE_MOBILE

const DETECTION_TYPE_MOBILE = 'mobile'

Mobile detection type.

См. определение в файле mobiledetect.php строка 39

◆ MOBILE_GRADE_A

const MOBILE_GRADE_A = 'A'

Top-level device.

См. определение в файле mobiledetect.php строка 58

◆ MOBILE_GRADE_B

const MOBILE_GRADE_B = 'B'

Mid-level device.

См. определение в файле mobiledetect.php строка 63

◆ MOBILE_GRADE_C

const MOBILE_GRADE_C = 'C'

Low-level device.

См. определение в файле mobiledetect.php строка 68

◆ VER

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

A frequently used regular expression to extract version #s.

См. определение в файле mobiledetect.php строка 53

◆ VERSION

const VERSION = '2.8.13'

Stores the version number of the current release.

См. определение в файле mobiledetect.php строка 73

◆ VERSION_TYPE_FLOAT

const VERSION_TYPE_FLOAT = 'float'

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

См. определение в файле mobiledetect.php строка 83

◆ VERSION_TYPE_STRING

const VERSION_TYPE_STRING = 'text'

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

См. определение в файле mobiledetect.php строка 78