DETECTION_TYPE_MOBILE
DETECTION_TYPE_MOBILE = 'mobile'
Mobile detection type.
Mobile Detect Library Motto: "Every business should have a mobile detection script to detect mobile readers"
Mobile_Detect is a lightweight PHP class for detecting mobile devices (including tablets). It uses the User-Agent string combined with specific HTTP headers to detect the mobile environment.
Homepage: http://mobiledetect.net GitHub: https://github.com/serbanghita/Mobile-Detect README: https://github.com/serbanghita/Mobile-Detect/blob/master/README.md CONTRIBUTING: https://github.com/serbanghita/Mobile-Detect/blob/master/docs/CONTRIBUTING.md KNOWN LIMITATIONS: https://github.com/serbanghita/Mobile-Detect/blob/master/docs/KNOWN_LIMITATIONS.md EXAMPLES: https://github.com/serbanghita/Mobile-Detect/wiki/Code-examples
$cache : array
A cache for resolved matches
$userAgent : string
The User-Agent HTTP header is stored in here.
$httpHeaders : array
HTTP headers in the PHP-flavor. So HTTP_USER_AGENT and SERVER_SOFTWARE.
$cloudfrontHeaders : array
CloudFront headers. E.g. CloudFront-Is-Desktop-Viewer, CloudFront-Is-Mobile-Viewer & CloudFront-Is-Tablet-Viewer.
$matchingRegex : string
The matching Regex.
This is good for debug.
$matchesArray : string
The matches extracted from the regex expression.
This is good for debug.
$detectionType : string
The detection type, using self::DETECTION_TYPE_MOBILE or self::DETECTION_TYPE_EXTENDED.
$mobileHeaders : array
HTTP headers that trigger the 'isMobile' detection to be true.
$phoneDevices : array
List of mobile devices (phones).
$tabletDevices : array
List of tablet devices.
$operatingSystems : array
List of mobile Operating Systems.
$browsers : array
List of mobile User Agents.
IMPORTANT: This is a list of only mobile browsers. Mobile Detect 2.x supports only mobile browsers, it was never designed to detect all browsers. The change will come in 2017 in the 3.x release for PHP7.
$utilities : array
Utilities.
$uaHttpHeaders : array
All possible HTTP headers that represent the User-Agent string.
$properties : array
The individual segments that could exist in a User-Agent string. VER refers to the regular expression defined in the constant self::VER.
__construct(array $headers = null, string $userAgent = null) : mixed
Construct an instance of this class.
| array | $headers | Specify the headers as injection. Should be PHP _SERVER flavored. If left empty, will use the global SERVER['HTTP*'] vars instead. |
| string | $userAgent | Inject the User-Agent header. If null, will use HTTP_USER_AGENT from the $headers array instead. |
setHttpHeaders(array $httpHeaders = null) : mixed
Set the HTTP Headers. Must be PHP-flavored. This method will reset existing headers.
| array | $httpHeaders | The headers to set. If null, then using PHP's _SERVER to extract the headers. The default null is left for backwards compatibility. |
getHttpHeader(string $header) : string|null
Retrieves a particular header. If it doesn't exist, no exception/error is caused.
Simply null is returned.
| string | $header | The 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 separated awesomeness. |
The value of the header.
setCfHeaders(array $cfHeaders = null) : bool
Set CloudFront headers http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/header-caching.html#header-caching-web-device
| array | $cfHeaders | List of HTTP headers |
If there were CloudFront headers to be set
setDetectionType(string $type = null) : mixed
Set the detection type. Must be one of self::DETECTION_TYPE_MOBILE or self::DETECTION_TYPE_EXTENDED. Otherwise, nothing is set.
| string | $type | The type. Must be a self::DETECTION_TYPE_* constant. The default parameter is null which will default to self::DETECTION_TYPE_MOBILE. |
getMobileDetectionRulesExtended() : array
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.
All the rules + extended.
match( $regex, string $userAgent = null) : 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.
This method will be used to check custom regexes against the User-Agent string.
| $regex | ||
| string | $userAgent |
version(string $propertyName, string $type = self::VERSION_TYPE_STRING) : string|float|false
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 | $propertyName | The name of the property. See self::getProperties() array keys for all possible properties. |
| string | $type | Either 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. |
The version of the property we are trying to extract.