\r\n

51Degrees Device Detection PHP  4.4

Device detection services for 51Degrees Pipeline

cloud/tacLookupConsole.php

This example shows how to use the 51Degrees Cloud service to lookup the details of a device based on a given 'TAC'. More background information on TACs can be found through various online sources such as Wikipedia.

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 2019 51 Degrees Mobile Experts Limited, 5 Charlotte Close,
* Caversham, Reading, Berkshire, United Kingdom RG4 7BY.
*
* 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__ . "/exampleUtils.php");
require_once(__DIR__ . "/../../vendor/autoload.php");
{
public function run($config, $logger, callable $output, $cloudEndPoint = "")
{
$output("This example shows the details of devices " .
"associated with a given 'Type Allocation Code' or 'TAC'.");
$output("More background information on TACs can be " .
"found through various online sources such as Wikipedia: " .
"https://en.wikipedia.org/wiki/Type_Allocation_Code");
$output("----------------------------------------");
// In this example, we use the PipelineBuilder and configure it from a file.
// For a demonstration of how to do this in code instead, see the
// NativeModelLookup example.
// For more information about builders in general see the documentation at
// http://51degrees.com/documentation/_concepts__configuration__builders__index.html
// Create the pipeline using the service provider and the configured options.
$pipeline = (new PipelineBuilder())
->buildFromConfig($config)
->addLogger($logger)
->build();
// Pass a TAC into the pipeline and list the matching devices.
$this->analyseTac($this->tac1, $pipeline, $output);
// Repeat for an alternative TAC.
$this->analyseTac($this->tac2, $pipeline, $output);
}
private function analyseTac($tac, $pipeline, callable $output)
{
// Create the FlowData instance.
$data = $pipeline->createFlowData();
// Add the TAC as evidence.
$data->evidence->set(CloudConstants::EVIDENCE_QUERY_TAC_KEY, $tac);
// Process the supplied evidence.
$data->process();
// Get result data from the flow data.
$result = $data->hardware;
$output("Which devices are associated with the " .
"TAC '".$tac."'?");
// The 'hardware.profiles' object contains one or more devices.
// This is the same interface used for standard device detection, so we have
// access to all the same properties.
forEach($result->profiles as $profile) {
$vendor = ExampleUtils::getHumanReadable($profile, "hardwarevendor");
$name = ExampleUtils::getHumanReadable($profile, "hardwarename");
$model = ExampleUtils::getHumanReadable($profile, "hardwaremodel");
$output("\t".$vendor." ".$name." (".$model.")");
}
}
// Example values to use when looking up device details from TACs.
private $tac1 = "35925406";
private $tac2 = "86386802";
}
// 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)
{
// Use the command line args to get the resource key if present.
// Otherwise, get it from the environment variable.
$resourceKey = isset($argv) && count($argv) > 0 ? $argv[0] : ExampleUtils::getResourceKey();
// Configure a logger to output to the console.
$logger = new Logger("info");
// Load the configuration file
$config = json_decode(file_get_contents(__DIR__."/tacLookupConsole.json"), true);
// Get the resource key setting from the config file.
$resourceKeyFromConfig = ExampleUtils::getResourceKeyFromConfig($config);
$configHasKey = empty($resourceKeyFromConfig) == false && strpos($resourceKeyFromConfig, "!!") !== 0;
// If no resource key is specified in the config file then override it with the key
// from the environment variable / command line.
if ($configHasKey === false)
{
ExampleUtils::setResourceKeyInConfig($config, $resourceKey);
}
if (empty($resourceKey) == false)
{
(new TacLookupConsole())->run($config, $logger, ['ExampleUtils', 'output']);
}
else
{
$logger->log("error",
"No resource key specified on the command line or in " .
"the environment variable '".ExampleUtils::RESOURCE_KEY_ENV_VAR."'. " .
"The 51Degrees cloud service is accessed using a 'ResourceKey'. " .
"For more information see " .
"http://51degrees.com/documentation/_info__resource_keys.html. " .
"TAC lookup is not available as a free service. This means " .
"that you will first need a license key, which can be purchased " .
"from our pricing page: http://51degrees.com/pricing. Once this is " .
"done, a resource key with the properties required by this example " .
"can be created at https://configure.51degrees.com/QKyYH5XT. You " .
"can now populate the environment variable mentioned at the start " .
"of this message with the resource key or pass it as the first " .
"argument on the command line.");
}
}
main(isset($argv) ? array_slice($argv, 1) : null);
}