ua-parser PHP Library

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

Installation

composer require ua-parser/uap-php

Usage

Straightforward:

require_once'vendor/autoload.php';
useUAParser\Parser;
$ua = "Mozilla/5.0 (Macintosh; Intel Ma...";
$parser = Parser::create();
$result = $parser->parse($ua);
print$result->ua->family; // Safariprint$result->ua->major; // 6print$result->ua->minor; // 0print$result->ua->patch; // 2print$result->ua->toString(); // Safari 6.0.2print$result->ua->toVersion(); // 6.0.2print$result->os->family; // Mac OS Xprint$result->os->major; // 10print$result->os->minor; // 7print$result->os->patch; // 5print$result->os->patchMinor; // [null]print$result->os->toString(); // Mac OS X 10.7.5print$result->os->toVersion(); // 10.7.5print$result->device->family; // Otherprint$result->toString(); // Safari 6.0.2/Mac OS X 10.7.5print$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';
useUAParser\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

Update the regexes.php File

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

php bin/uaparser 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 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 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 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 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.