ua-parser PHP Library

This is the PHP library for the uap-core project.

v3.4.1 Changes

• Fix a regex delimiter issue with uap-core
• Bundle regex.php with uap-php

v3.4 Changes

Move done to it’s own dedicated project. Now officially available via composer as ua-parser/uap-php

• Use peer_name instead of CN_match for PHP >=5.6
• Advertise Gitter chat for support requests
• Include uap-core as a git submodule

v3.3 Changes

v3.3 of the PHP library is no longer compatible with the previous version. It now supports composer, requires PHP 5.3 and has a slightly different API (see below).

• UAParser class is now UAParser\Parser
• Typed result objects: Parser::parse() returns UAParser\Result\Client, Client::$os is a UAParser\Result\OperatingSystem and Client::$device is a UAParser\Result\Device
• toString() and toVersion() are now methods
• Properties now use camelCase, not underscore_case.

v2.0 Changes

v2.0 of the PHP library, released in December 2012, marked a huge transition from the previous pseudo-port of ua-parser to a true port that matches up well with the other libraries in the ua-parser repo. The primary changes:

• the UAParser class is now dynamic
• properties are nested (e.g. $result->family is now $result->ua->family)
• a user agent string is now required when using parse(). the auto-magical "use the server provided UA" is no longer supported.
• uaParse(), osParse(), and deviceParse() are public and can be used to just return those select bits for a given user agent string.
• the is* boolean properties (e.g. isMobile) have been dropped. they now exist as part of the ua-classifier project.

Please refer to the CHANGELOG for the full list of changes.

Demo

You can test the PHP library with your browser.

Usage

Straightforward:

require_once 'vendor/autoload.php';
use UAParser\Parser;

$ua = "Mozilla/5.0 (Macintosh; Intel Ma...";

$parser = Parser::create();
$result = $parser->parse($ua);

print $result->ua->family;            // Safari
print $result->ua->major;             // 6
print $result->ua->minor;             // 0
print $result->ua->patch;             // 2
print $result->ua->toString();        // Safari 6.0.2
print $result->ua->toVersion();       // 6.0.2

print $result->os->family;            // Mac OS X
print $result->os->major;             // 10
print $result->os->minor;             // 7
print $result->os->patch;             // 5
print $result->os->patchMinor;        // [null]
print $result->os->toString();        // Mac OS X 10.7.5
print $result->os->toVersion();       // 10.7.5

print $result->device->family;        // Other

print $result->toString();            // Safari 6.0.2/Mac OS X 10.7.5
print $result->originalUserAgent;     // Mozilla/5.0 (Macintosh; Intel Ma...

Using Your Own Custom regexes.php File

You can use your own regexes.php file if you've customized the official file. I strongly encourage you to push back any changes you may have so others can benefit. That said, to use your own do the following:

require_once 'vendor/autoload.php';
use UAParser\Parser;

$parser = Parser::create("path/to/custom/regexes.php");

Using ua-parser PHP Library from the Command Line

A command line utility is now included with the PHP library. The following commands are supported:

Get Usage Info

Provides simple usage information:

php bin/uaparser.php

Update the regexes.php File

Fetches an updated YAML file for ua-parser and overwrites the current JSON file. You can use the following as part of a cron job that runs nightly.

php bin/uaparser.php ua-parser:update [--no-backup]

By default creates a backup file. Use --no-backup to turn that feature off.

Convert an Existing regexes.yaml File to regexes.php

With the change to v2.0 you may have an existing and customized YAML file for ua-parser. Use the following to convert it to JSON.

php bin/uaparser.php ua-parser:convert [file]

Grab Just the Latest regexes.yaml File From the Repository

If you need to add a new UA it's easier to edit the original YAML and then convert it to JSON.

php bin/uaparser.php ua-parser:fetch [file]

Fetches an updated YAML file. Warning: This method overwrites any existing regexes.yaml file.

Parse a Single User Agent String

Parses a user agent string and dumps the results as a list.

php bin/uaparser.php ua-parser:parse "your user agent string"

Parse a Webserver Log File

Parses the supplied log file or log directory to test ua-parser. Saves the UA to a file when the UA or OS family aren't recognized or when the UA is listed as a generic smartphone or as a generic feature phone.

php bin/uaparser.php ua-parser:logfile [-f /path/to/logfile] [-d /path/to/logdir] [--include "*.gz"] [--exclude "*.gz"] errors.log

Multiple --include and --exclude parameters are allowed.

Credits

Thanks to the original ua-parser team for making the YAML file available for others to build upon.

Also, many thanks to the following major contributors to the PHP library:

• Bryan Shelton
• Michael Bond
• @rjd22
• Timo Tijhof
• Marcus Bointon
• Ryan Parman
• Pravin Dahal

Licensing

• The library is licensed under the MIT license
• The user agents data from the ua-parser project is licensed under the Apache license
• The initial list of generic feature phones & smartphones came from Mobile Web OSP under the MIT license
• The initial list of spiders was taken from Yiibu's profile project under the MIT license.

Installation

Add ua-parser/uap-php to the require section of your composer.json file and run composer update.