128 lines
3.7 KiB
Markdown
128 lines
3.7 KiB
Markdown
|
# PHP User Agent Parser
|
||
|
|
|
||
|
|
[](https://gitter.im/PhpUserAgentParser/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
||
|
|
|
||
|
|
[](https://packagist.org/packages/donatj/phpuseragentparser) [](https://packagist.org/packages/donatj/phpuseragentparser) [](https://packagist.org/packages/donatj/phpuseragentparser) [](https://packagist.org/packages/donatj/phpuseragentparser)
|
||
|
|
[](https://travis-ci.org/donatj/PhpUserAgent)
|
||
|
|
|
||
|
|
## What It Is
|
||
|
|
|
||
|
|
A simple, streamlined PHP user-agent parser!
|
||
|
|
|
||
|
|
Licensed under the MIT license: http://www.opensource.org/licenses/mit-license.php
|
||
|
|
|
||
|
|
|
||
|
|
## Why Use This
|
||
|
|
|
||
|
|
You have your choice in user-agent parsers. This one detects **all modern browsers** in a very light, quick, understandable fashion.
|
||
|
|
It is less than 200 lines of code, and consists of just three regular expressions!
|
||
|
|
It can also correctly identify exotic versions of IE others fail on.
|
||
|
|
|
||
|
|
It offers 100% unit test coverage, is installable via Composer, and is very easy to use.
|
||
|
|
|
||
|
|
## What It Does Not Do
|
||
|
|
|
||
|
|
This is not meant as a browser "knowledge engine" but rather a simple parser. Anything not adequately provided directly by the user agent string itself will simply not be provided by this.
|
||
|
|
|
||
|
|
### OS Versions
|
||
|
|
|
||
|
|
User-agent strings **are not** a reliable source of OS Version!
|
||
|
|
|
||
|
|
- Many agents simply don't send the information.
|
||
|
|
- Others provide varying levels of accuracy.
|
||
|
|
- Parsing Windows versions alone almost nearly doubles the size of the code.
|
||
|
|
|
||
|
|
I'm much more interested in keeping this thing *tiny* and accurate than adding niché features and would rather focus on things that can be **done well**.
|
||
|
|
|
||
|
|
All that said, there is the start of a [branch to do it](https://github.com/donatj/PhpUserAgent/tree/os_version_detection) I created for a client if you want to poke it, I update it from time to time, but frankly if you need to *reliably detect OS Version*, using user-agent isn't the way to do it. I'd go with JavaScript.
|
||
|
|
|
||
|
|
### Undetectable Browsers
|
||
|
|
|
||
|
|
- **Brave** - Brave is simply not differentiable from Chrome. This was a design descision on their part.
|
||
|
|
|
||
|
|
## Requirements
|
||
|
|
|
||
|
|
- PHP 5.3.0+
|
||
|
|
|
||
|
|
## Installing
|
||
|
|
|
||
|
|
PHP User Agent is available through Packagist via Composer.
|
||
|
|
|
||
|
|
```json
|
||
|
|
{
|
||
|
|
"require": {
|
||
|
|
"donatj/phpuseragentparser": "*"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
## Sample Usage
|
||
|
|
|
||
|
|
```php
|
||
|
|
$ua_info = parse_user_agent();
|
||
|
|
/*
|
||
|
|
array(
|
||
|
|
'platform' => '[Detected Platform]',
|
||
|
|
'browser' => '[Detected Browser]',
|
||
|
|
'version' => '[Detected Browser Version]',
|
||
|
|
);
|
||
|
|
*/
|
||
|
|
```
|
||
|
|
|
||
|
|
## Currently Detected Platforms
|
||
|
|
|
||
|
|
- Desktop
|
||
|
|
- Windows
|
||
|
|
- Linux
|
||
|
|
- Macintosh
|
||
|
|
- Chrome OS
|
||
|
|
- Mobile
|
||
|
|
- Android
|
||
|
|
- iPhone
|
||
|
|
- iPad / iPod Touch
|
||
|
|
- Windows Phone OS
|
||
|
|
- Kindle
|
||
|
|
- Kindle Fire
|
||
|
|
- BlackBerry
|
||
|
|
- Playbook
|
||
|
|
- Tizen
|
||
|
|
- Console
|
||
|
|
- Oculus
|
||
|
|
- Nintendo 3DS
|
||
|
|
- New Nintendo 3DS
|
||
|
|
- Nintendo Wii
|
||
|
|
- Nintendo WiiU
|
||
|
|
- PlayStation 3
|
||
|
|
- PlayStation 4
|
||
|
|
- PlayStation Vita
|
||
|
|
- Xbox 360
|
||
|
|
- Xbox One
|
||
|
|
|
||
|
|
## Currently Detected Browsers
|
||
|
|
|
||
|
|
- Android Browser
|
||
|
|
- BlackBerry Browser
|
||
|
|
- Camino
|
||
|
|
- Kindle / Silk
|
||
|
|
- Firefox / IceWeasel / IceCat
|
||
|
|
- Safari
|
||
|
|
- Internet Explorer / Edge
|
||
|
|
- IEMobile
|
||
|
|
- Chrome / HeadlessChrome
|
||
|
|
- Yandex Browser
|
||
|
|
- Opera
|
||
|
|
- Midori
|
||
|
|
- Vivaldi
|
||
|
|
- TizenBrowser
|
||
|
|
- OculusBrowser
|
||
|
|
- SamsungBrowser
|
||
|
|
- UC Browser
|
||
|
|
- Lynx
|
||
|
|
- Wget
|
||
|
|
- Curl
|
||
|
|
- Puffin
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
More information is available at [Donat Studios](http://donatstudios.com/PHP-Parser-HTTP_USER_AGENT).
|