Browser Capabilities Project
This tool is used to build and maintain browscap files.
Installation
$ git clone git://github.com/browscap/browscap.git
$ cd browscap
$ curl -s https://getcomposer.org/installer | php
$ php composer.phar install
What's changed in version 6028
BC breaks listed
- Interface changed for class \Browscap\Data\Factory\UserAgentFactory
What's changed in version 6027
BC breaks listed
- Strict type hints have been added throughout. This may break some type assumptions made in earlier versions.
- In many classes Setters and Getters have been removed, the parameters have been moved to the class constructor
- Some classes are now
final- use composition instead of inheritance
What's changed in version 6025
BC breaks listed
- The
grepcommand and thediffcommand were removed
Changes
- The tests for integration testing the source files are split from the other tests
- Tests on travis use the build pipeline now
Directory Structure
bin- Contains executable filesbuild- Contains various buildsresources- Files needed to build the various files, also used to validate the capabilitiessrc- The code of this project lives heretests- The testing code of this project lives here
the CLI commands
There is actually only one cli command available.
build
This command is used to build a set of defined browscap files.
bin/browscap build [version]
options
version(required) the name of the version that should be builtoutput(optional) the directory where the files should be createdresources(optional) the directory where the sources for the build are locatedcoverage(optional) if this option is set, during the build information is added which can be used to generate a coverage reportno-zip(optional) if this option is set, no zip file is generated during the build
For further documentation on the build command, see here.
CLI Examples
You can export a new set of browscap files:
$ bin/browscap build 5020-test
Resource folder:
Build folder:
Generating full_asp_browscap.ini [ASP/FULL]
Generating full_php_browscap.ini [PHP/FULL]
Generating browscap.ini [ASP]
Generating php_browscap.ini [PHP]
...
All done.
$
Now you if you look at browscap/browscap.ini you will see a new INI file has been generated.
Usage Examples
How to build a standard set of browscap files
This example assumes that you want to build all *php_browscap.ini files.
$logger = new \Monolog\Logger('browscap'); // or maybe any other PSR-3 compatible Logger
$format = \Browscap\Formatter\FormatterInterface::TYPE_PHP; // you may choose the output format you want, the format must be already supported
$resourceFolder = 'resources/'; // please point to the resources directory inside the project
$buildFolder = ''; // choose the directory where the generated file should be written to
// If you are using one of the predefined WriterFactories, you may not choose the file names
$writerCollection = (new \Browscap\Writer\Factory\PhpWriterFactory())->createCollection($logger, $buildFolder);
$dataCollectionFactory = new \Browscap\Data\Factory\DataCollectionFactory($logger);
$buildGenerator = new BuildGenerator(
$resourceFolder,
$buildFolder,
$logger,
$writerCollection,
$dataCollectionFactory
);
$version = ''; // what you want to be written into the generated file
$createZipFile = false; // It is not possible yet to create a zipped version of a custom named browscap file
$buildGenerator->run($version, $createZipFile);
How to build a custom set of browscap files
If you want to build a custom set of browscap files, you may not use the predefined WriterFactories.
$logger = new \Monolog\Logger('browscap'); // or maybe any other PSR-3 compatible Logger
$format = \Browscap\Formatter\FormatterInterface::TYPE_PHP; // you may choose the output format you want, the format must be already supported
$resourceFolder = 'resources/'; // please point to the resources directory inside the project
$buildFolder = ''; // choose the directory where the generated file should be written to
$propertyHolder = new \Browscap\Data\PropertyHolder();
// build a standard version browscap.json file
$jsonFormatter = new \Browscap\Formatter\JsonFormatter($propertyHolder);
$jsonFilter = new \Browscap\Filter\StandardFilter($propertyHolder);
$jsonWriter = new \Browscap\Writer\JsonWriter('relative path or name of the target file', $logger);
$jsonWriter->setFormatter($jsonFormatter);
$jsonWriter->setFilter($jsonFilter);
// build a lite version browscap.xml file
$xmlFormatter = new \Browscap\Formatter\XmlFormatter($propertyHolder);
$xmlFilter = new \Browscap\Filter\LiteFilter($propertyHolder);
$xmlWriter = new \Browscap\Writer\XmlWriter('relative path or name of the target file', $logger);
$xmlWriter->setFormatter($xmlFormatter);
$xmlWriter->setFilter($xmlFilter);
$writerCollection = new \Browscap\Writer\WriterCollection();
$writerCollection->addWriter($jsonWriter);
$writerCollection->addWriter($xmlWriter);
$dataCollectionFactory = new \Browscap\Data\Factory\DataCollectionFactory($logger);
$buildGenerator = new BuildGenerator(
$resourceFolder,
$buildFolder,
$logger,
$writerCollection,
$dataCollectionFactory
);
$version = ''; // what you want to be written into the generated file
$createZipFile = false; // It is not possible yet to create a zipped version of a custom named browscap file
$buildGenerator->run($version, $createZipFile);
How to build a custom browscap.ini
If you want to build a custom browscap file you may choose the file name and the fields which are included.
Note: It is not possible to build a custom browscap.ini file with the CLI command.
$logger = new \Monolog\Logger('browscap'); // or maybe any other PSR-3 compatible Logger
$format = \Browscap\Formatter\FormatterInterface::TYPE_PHP; // you may choose the output format you want, the format must be already supported
$file = null; // you may set a custom file name here
$fields = []; // choose the fields you want inside of your browscap file
$resourceFolder = 'resources/'; // please point to the resources directory inside the project
$buildFolder = ''; // choose the directory where the generated file should be written to
$writerCollection = (new \Browscap\Writer\Factory\CustomWriterFactory())->createCollection($logger, $buildFolder, $file, $fields);
$dataCollectionFactory = new \Browscap\Data\Factory\DataCollectionFactory($logger);
$buildGenerator = new BuildGenerator(
$resourceFolder,
$buildFolder,
$logger,
$writerCollection,
$dataCollectionFactory
);
$version = ''; // what you want to be written into the generated file
$createZipFile = false; // It is not possible yet to create a zipped version of a custom named browscap file
$buildGenerator->run($version, $createZipFile);
Issues and feature requests
Please report your issues and ask for new features on the GitHub Issue Tracker at https://github.com/browscap/browscap/issues
Contributing
For instructions on how to contribute see the CONTRIBUTE.md file.
License
See the LICENSE file.
3 Nov 24, 2022
195 Dec 24, 2022
2 Nov 17, 2022
25 Sep 18, 2022
6 Oct 7, 2022
2 Apr 7, 2021
690 Dec 28, 2022
1.1k Dec 21, 2022
530 Dec 27, 2022
4 Jan 15, 2022
2 Oct 18, 2021
798 Jan 8, 2023
133 Oct 26, 2022
3 Aug 9, 2022
2 Jun 18, 2022
837 Dec 14, 2022
202 Dec 22, 2022