The cloud service exposes meta data that can provide additional information about the various properties that might be returned.This example shows how to access this data and display the values available.
A list of the properties will be displayed, along with some additional information about each property. Note that this is the list of properties used by the supplied resource key, rather than all properties that can be returned by the cloud service.
In addition, the evidence keys that are accepted by the service are listed. These are the keys that, when added to the evidence collection in flow data, could have some impact on the result that is returned.
Bear in mind that this is a list of ALL evidence keys accepted by all products offered by the cloud. If you are only using a single product (for example - device detection) then not all of these keys will be relevant.
<?php
require_once(__DIR__ . "/exampleUtils.php");
require_once(__DIR__ . "/../../vendor/autoload.php");
{
public function run($resourceKey, $logger, callable $output)
{
$pipeline = (new DeviceDetectionPipelineBuilder(array("resourceKey" => $resourceKey)))
->addLogger($logger)
->build();
$this->outputProperties($pipeline->getElement("device"), $output);
$this->outputEvidenceKeyDetails($pipeline->getElement("cloud"), $output);
}
private function outputEvidenceKeyDetails($engine, callable $output)
{
$output("");
if (is_a($engine->getEvidenceKeyFilter(), "fiftyone\\pipeline\\core\\BasicListEvidenceKeyFilter"))
{
$filter = $engine->getEvidenceKeyFilter();
$output("Accepted evidence keys:");
foreach ($filter->getList() as $key)
{
$output("\t$key");
}
}
else
{
output("The evidence key filter has type " .
$engine->getEvidenceKeyFilter().". As this does not extend " .
"BasicListEvidenceKeyFilter, a list of accepted values cannot be " .
"displayed. As an alternative, you can pass evidence keys to " .
"filter->filterEvidenceKey(string) to see if a particular key will be included " .
"or not.");
output("For example, header.user-agent is " .
($engine->getEvidenceKeyFilter().filterEvidenceKey("header.user-agent") ? "" : "not ") .
"accepted.");
}
}
private function outputProperties($engine, callable $output)
{
foreach ($engine->getProperties() as $property)
{
$output("Property - ".$property["name"] . " " .
"[Category: ".$property["category"]."] (".$property["type"].")");
}
}
};
if (basename(__FILE__) == basename($_SERVER["SCRIPT_FILENAME"]))
{
function main($argv)
{
$resourceKey = isset($argv) && count($argv) > 0 ? $argv[0] : ExampleUtils::getResourceKey();
$logger = new Logger("info");
if (empty($resourceKey) == false)
{
(
new MetaDataConsole())->run($resourceKey, $logger, [
"ExampleUtils",
"output"]);
}
else
{
$logger->log("error",
"No resource key specified in environment variable " .
"'".ExampleUtils::RESOURCE_KEY_ENV_VAR."'. 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/1QWJwHxl. " .
"Once complete, populate the environment variable " .
"mentioned at the start of this message with the key.");
}
}
main(isset($argv) ? array_slice($argv, 1) : null);
}