This example shows how to use the 51Degrees Cloud service to determine details about a device based on its User-Agent and User-Agent Client Hint HTTP header values.
You will learn:
- How to create a Pipeline that uses the 51Degrees cloud service
- How to pass input data (evidence) to the Pipeline
- How to retrieve the results
This example is available in full on GitHub.
To run this example, you will need to create a resource key. The resource key is used as shorthand to store the particular set of properties you are interested in as well as any associated license keys that entitle you to increased request limits and/or paid-for properties.
You can create a resource key using the 51Degrees Configurator.
Required Composer Dependencies:
- 51degrees/fiftyone.devicedetection
<?php
/* *********************************************************************
* This Original Work is copyright of 51 Degrees Mobile Experts Limited.
* Copyright 2023 51 Degrees Mobile Experts Limited, Davidson House,
* Forbury Square, Reading, Berkshire, United Kingdom RG1 3EU.
*
* This Original Work is licensed under the European Union Public Licence
* (EUPL) v.1.2 and is subject to its terms as set out below.
*
* If a copy of the EUPL was not distributed with this file, You can obtain
* one at https://opensource.org/licenses/EUPL-1.2.
*
* The 'Compatible Licences' set out in the Appendix to the EUPL (as may be
* amended by the European Commission) shall be deemed incompatible for
* the purposes of the Work and the provisions of the compatibility
* clause in Article 5 of the EUPL shall not apply.
*
* If using the Work as, or as part of, a network application, by
* including the attribution notice(s) required under Article 5 of the EUPL
* in the end user terms of the application under an appropriate heading,
* such notice(s) shall fulfill the requirements of that article.
* ********************************************************************* */
require_once(__DIR__ . "/../../vendor/autoload.php");
use fiftyone\pipeline\core\Logger;
// Only declare and call the main function if this is being run directly.
// This prevents main from being run where examples are run as part of
// PHPUnit tests.
if (basename(__FILE__) == basename($_SERVER["SCRIPT_FILENAME"]))
{
function main($argv)
{
// Configure a logger to output to the console
$logger = new Logger("info");
// Load the configuration file
$config = json_decode(file_get_contents(__DIR__."/gettingStartedConsole.json"), true);
// Get the resource key from command line args
$resourceKey = ExampleUtils::getResourceKeyFromCliArgs($argv);
// Otherwise, get the resource key from the environment variable
if (empty($resourceKey)) {
$resourceKey = ExampleUtils::getResourceKeyFromEnv();
}
// Otherwise, get the resource key from the config file
if (empty($resourceKey)) {
$resourceKey = ExampleUtils::getResourceKeyFromConfig($config);
}
if (empty($resourceKey)) {
$message = "No resource key specified in CLI args, environment variable '" .
ExampleUtils::RESOURCE_KEY_ENV_VAR . "', or configuration file." . PHP_EOL .
"The 51Degrees cloud service is accessed using a 'ResourceKey'. " .
"For more detail see " .
"http://51degrees.com/documentation/4.3/_info__resource_keys.html. " .
"A resource key with the properties required by this " .
"example can be created for free at " .
"https://configure.51degrees.com/g3gMZdPY. " .
"Once complete, populated the environment variable " .
"mentioned at the start of this message with the key.";
ExampleUtils::logErrorAndExit($logger, $message);
}
ExampleUtils::setResourceKeyInConfig($config, $resourceKey);
(new GettingStartedConsole())->run($config, $logger, [ExampleUtils::class, 'output']);
}
main(isset($argv) ? array_slice($argv, 1) : null);
}