This is a userland replacement for PHP's native get_browser() function, which is officially supported by the Browser Capabilities Project.
Note that you are currently viewing the 4.x series. If you're looking for the unsupported 2.x version, please read the documentation for that branch here.
Run the command below to install via Composer
composer require browscap/browscap-php Then you may identify the current user agent this way:
$cache = new \Roave\DoctrineSimpleCache\SimpleCacheAdapter($doctrineFileCache); // or maybe any other PSR-16 compatible caches
$logger = new \Monolog\Logger('name'); // or maybe any other PSR-3 compatible logger
$browscap = new \BrowscapPHP\Browscap($cache, $logger);
$info = $browscap->getBrowser();Before you can start, you have to download the browscap.ini file and convert it into a cache. There are two ways.
a. Download the file and convert it in two steps. The downloaded file will be stored in a local file, but there is no check
if the remote file has changed. If your cache gets corrupted you only need to rerun the convert command.
vendor/bin/browscap-php browscap:fetch
vendor/bin/browscap-php browscap:convertb. Download the file and convert it in one step. The downloaded file will not be stored in a local file, but there is a check if the remote file has changed. If your cache gets corrupted you have clean the cache and restart the process.
vendor/bin/browscap-php browscap:updateIf you want to autoupdate the used cache, we recommend a separate cron job that calls the command listed above.
- Strict type hints have been added throughout. This may break some type assumptions made in earlier versions.
CheckUpdateCommand,ConvertCommand,LogfileCommand,ParserCommand,UpdateCommandremovedsetCachemethods so that caches must now be constructor-injected- Many classes are now
final- use composition instead of inheritance PropertyFormatternow assumes any non-truthy values arefalsecheckUpdatemethod now throws an exception if we could not determine the "remote" version, or if there is no version in cache already.logmethod was removed
- for caching the Doctrine Cache package is used
- Any other Cache compatible with PSR-16 could be used
- instead of the
debugflag for the CLI commands the verbose flag has to be used
- the namespace was changed to
BrowscapPHP - the
Browscapclass was split into pieces- for caching the WurflCache package is used
- for downloading the browscap.ini the Guzzle HTTP package is used
- the autoupdate function was removed
- all public properties were removed
- now it is possible to use other caches than the file cache (see the WurflCache package formore information)
- now it is possible to write your own formatter to change the output format
- now it is possbile to set a PSR-3 compatible logger
This is the base setup in version 3.x.
$bc = new \BrowscapPHP\Browscap();
$adapter = new \WurflCache\Adapter\File([\WurflCache\Adapter\File::DIR => $cacheDir]);
$bc->setCache($adapter);
$logger = new \Monolog\Logger('name');
$bc->setLogger($logger);
$result = $bc->getBrowser();Change this to the base setup for version 4.x. to use the current cache directory
$fileCache = new \Doctrine\Common\Cache\FilesystemCache($cacheDir);
$cache = new \Roave\DoctrineSimpleCache\SimpleCacheAdapter($fileCache);
$logger = new \Monolog\Logger('name');
$bc = new \BrowscapPHP\Browscap($cache, $logger);
$result = $bc->getBrowser();NOTE: You may use any other cache which implements the PSR-16 interface.
$bc = new \BrowscapPHP\BrowscapUpdater();
$bc->update(\BrowscapPHP\Helper\IniLoaderInterface::PHP_INI_FULL);If you are behind a proxy or need a spcific configuration, you have to set up a client instance. See into the Guzzle documentation for more information about this.
$proxyConfig = [
'proxy' => [
'http' => 'tcp://localhost:8125',
'https' => 'tcp://localhost:8124',
],
];
$client = new \GuzzleHttp\Client($proxyConfig);
$bcu = new BrowscapUpdater();
$bcu->setClient($client);$bc = new \BrowscapPHP\Browscap();
$current_browser = $bc->getBrowser();$bc = new \BrowscapPHP\Browscap($cache, $logger);
$current_browser = $bc->getBrowser($the_user_agent);NOTE: If you don't want to use a file cache, you could not use the CLI commands. It is not possible to use other caches there at the moment. NOTE: Each operation (fetch, update, check-update) which fetches data from the remote host browscap.org may run into the rate limit of that site. If this happens an Exception is thrown.
Each CLI command returns zero if everything went fine.
If you only want to check if a new version of the browscap.ini is available, you can use the check-update command.
vendor/bin/browscap-php browscap:check-updatecache(optional) the relative path to your cache directory
- 1: no cached version found
- 2: no new version availble
- 3: an error occured while checking the cached version
- 4: an error occured while fetching the remote version
- 5: an other error occured
The fetch command downloads an ini file from browscap.org.
vendor/bin/browscap-php browscap:fetchcache(optional) the relative path to your cache directoryremote-file(optional) only required if you dont want to download the standerd file, possible values arePHP_BrowscapINIdownloads the standard file (default)Lite_PHP_BrowscapINIdownloads the lite fileFull_PHP_BrowscapINIdownloads the full file
file(optional) the relative path to the local file where the remote content is stored
- 3: an error occured while checking the cached version
- 9: an error occured while fetching the remote data
- 10: an other error occured
The convert command reads a local stored browscap.ini file and writes the contents into a cache.
vendor/bin/browscap-php browscap:convertfile(optional) the relative path to the local file where the remote content is stored, this should be the same file as in the fetch commandcache(optional) the relative path to your cache directory
- 6: the name of the file to convert is missing
- 7: the file to convert is not available or not readable
- 8: an other error occured while reading the file
The update command downloads an ini file from browscap.org and writes the contents into a cache. No local files are created.
vendor/bin/browscap-php browscap:updateremote-file(optional) only required if you dont want to download the standerd file, possible values arePHP_BrowscapINIdownloads the standard file (default)Lite_PHP_BrowscapINIdownloads the lite fileFull_PHP_BrowscapINIdownloads the full file
cache(optional) the relative path to your cache directory
- 3: an error occured while checking the cached version
- 9: an error occured while fetching the remote data
- 10: an other error occured
The parse command parses a given user agent and writes the result to the console.
vendor/bin/browscap-php browscap:parseuser-agent(required) the user agent which should be parsedcache(optional) the relative path to your cache directory
- 11: an other error occured while parsing the useragent
Note: Both ways to create/update the cache will use the standard mode file as default.
If you want more detailed information you may change this with the remote-file option.
Please use the help function this parameter.
vendor/bin/browscap-php browscap:update --remote-file Full_PHP_BrowscapINIEach operation expect fetch uses a cache inside the resources directory inside the project. If you update this library with
composer, the cache is cleared also. If you want to avoid this and want to set your own cache folder,
you can use the cache option. If you do this, you have to set a Cache Instance for this this path.
vendor/bin/browscap-php browscap:update --cache ./browscap-cachePlease report your issues and ask for new features on the GitHub Issue Tracker at https://github.com/browscap/browscap-php/issues
Please report incorrectly identified User Agents and browser detect in the browscap.ini file here: https://github.com/browscap/browscap/issues