PHP - Device Detection Example
getMatch($_SERVER['HTTP_USER_AGENT']);
printArrayToTable($match_ua, $properties, $isPattern, "ua");
printHttpHeaders($allHttpHeaders, "HTTP Headers");
$httpHeaders = "";
//Get all HTTP headers from $_SERVER
foreach ($_SERVER as $key => $value) {
if (strpos($key, "HTTP_") !== false) {
$httpHeaders = $httpHeaders.$key." ".$value."\n";
}
}
$result_1 = $provider->getMatch($httpHeaders);
printArrayToTable($result_1, $properties, $isPattern, 2);
/**
* Function prints the contents of a supplied array as a table.
* @param $array is the array to print out. Mandatory.
* @param $colNames a one dimensional array that contains names of columns. Optional.
* Default values will be used if parameter not provided.
*/
function printArrayToTable($match, $properties, $isPattern, $occurance, $colNames=array("Property","Value","Data Type")) {
// Columns in the array.
$columnsInTable = count($colNames);
// Extra column for the button.
$columnsInArrayWithButton = $columnsInTable + 1;
// Number of rows for properties.
// Id, Rank, Method and Difference are not displayed in the properties
// section, so we need less rows.
// Default is for Trie and Trie only provides Id.
$propertiesRows = count($properties) + 2;
// Number of Match Metrics rows. Pattern provides more metrics stats.
$metricsRowspan = 2;
if ($isPattern) {
// Pattern provides more metrics than Trie, hence more rows.
$metricsRowspan = 5;
}
echo "
";
echo "";
// Print metrics section.
echo "";
echo "| Match Metrics | ";
// Print 'About metrics' button.
echo "";
$link = getWebsiteLink("metrics", $isPattern, $occurance);
echo "About Metrics";
echo " | ";
echo "
";
//Print device Id.
echo "";
echo "| Id | ";
if (NULL !== $match->getDeviceId()) {
//For Trie Id is an optional property. May not necessarily be set.
echo "".$match->getDeviceId()." | ";
echo "".gettype($match->getDeviceId())." | ";
} else {
echo "N/A | ";
echo "N/A | ";
}
echo "
";
if ($isPattern) {
//Print detection method.
echo "";
echo "| Method | ";
echo "".$match->getMethod()." | ";
echo "".gettype($match->getMethod())." | ";
echo "
";
//Difference.
echo "";
echo "| Difference | ";
echo "".$match->getDifference()." | ";
echo "".gettype($match->getDifference())." | ";
echo "
";
//Rank.
echo "";
echo "| Rank | ";
echo "".$match->getRank()." | ";
echo "".gettype($match->getRank())." | ";
echo "
";
}
//Print column names
//Print Device properties header
echo "";
echo "| Device Properties | ";
echo "";
$link = getWebsiteLink("properties", $isPattern, $occurance);
echo "More Properties";
echo " | ";
echo "
";
echo "";
foreach($colNames as $key) {
echo "| $key | ";
}
echo "
";
//Print table contents.
if ($properties != NULL) {
//Dataset was in fact initialised with a list of properties.
foreach($properties as $value) {
//Ignore Rank, Id, Method and Difference as they are printed elsewhere.
if ($value === "SignatureRank" || $value === "Rank" ||
$value === "Difference" || $value === "Method" || $value ==="Id") {
continue;
}
echo "";
echo "| $value | ";
if ($match->getValue($value) != NULL) {
echo "".$match->getValue($value)." | ";
} else {
echo "Switch Data Set | ";
}
echo "".gettype($match->getValue($value))." | ";
echo "
";
}
} else {
//NULL was provided, meaning all properties selected.
foreach($match->getAvailableProperties() as $key => $value) {
//Ignore Rank, Id, Method and Difference as they are printed elsewhere.
if ($key === "SignatureRank" || $key === "Rank" ||
$key === "Difference" || $key === "Method" || $key ==="Id") {
continue;
}
echo "";
echo "| $key | ";
echo "".$value." | ";
echo "".gettype($value)." | ";
echo "
";
}
}
echo "";
echo "
";
}
/**
* Function prints information related to the data file currently in use.
*/
function printInfoTable($provider, $isPattern) {
//How many columns will be required.
$columns = 3;
echo "
";
echo "";
echo "";
echo "";
echo "
";
//Print dataset initialisation message.
//Third column spans all rows and is used to print 'Compare Data Options' button.
if ($columns == 3) {
echo "";
$link = getWebsiteLink("compare", $isPattern);
echo "Compare Data Options";
echo " | ";
}
echo "";
//Print dataset Published date. Pattern only.
echo "";
echo "| Dataset published: | ";
if ($isPattern) {
echo "".$provider->getDataSetPublishedDate()." | ";
} else {
echo "Not available for Trie. | ";
}
echo "
";
//Print dataset next update date. Pattern only.
echo "";
echo "| Dataset next update: | ";
if ($isPattern) {
echo "".$provider->getDataSetNextUpdateDate()." | ";
} else {
echo "Not available for Trie. | ";
}
echo "
";
//Print dataset version. Pattern only.
echo "";
echo "| Dataset version: | ";
if ($isPattern) {
echo "".$provider->getDataSetFormat()." | ";
} else {
echo "Not available for Trie. | ";
}
echo "
";
//Print dataset name. Exists for both Pattern and Trie. Both Pattern and Trie.
echo "";
echo "| Dataset name: | ";
echo "".$provider->getDataSetName()." | ";
echo "
";
//Print device combinations. Pattern only.
echo "";
echo "| Dataset device combinations: | ";
if ($isPattern) {
echo "".$provider->getDataSetDeviceCombinations()." | ";
} else {
echo "Not available for Trie. | ";
}
echo "
";
echo "";
echo "
";
}
/**
* Function prints all relevant headers and values for the relevant HTTP
* headers that were set in this request.
*/
function printHttpHeaders($array, $name, $headers=array()) {
if (empty($array)) {
return null;
}
$selective = FALSE;
if(!empty($headers)) {
$selective = TRUE;
}
echo "
";
echo "";
echo "";
echo "| Match With $name | ";
echo "
";
foreach ($array as $value) {
if ($selective) {
//Only some headers are required.
//If current header not in the array of required headers skip.
if (!in_array("HTTP_".strtoupper(str_replace("-","_",$value)), $headers)) {
continue;
}
}
echo "";
echo "| ";
echo $value;
echo " | ";
echo "";
if ($_SERVER["HTTP_".strtoupper(str_replace("-","_",$value))] != NULL) {
echo $_SERVER["HTTP_".strtoupper(str_replace("-","_",$value))];
} else {
echo "header not set";
}
echo " | ";
echo "
";
}
echo "";
echo "
";
}
/**
* Function generates a link to 51Degrees based on the purpose of the link, whether
* the detector is operating in Pattern or Trie modes and if the link is created for
* the match with User-Agent function or the Match with Headers function. Guaranteed
* to return a link, even if the parameter is not known.
* @returns a link to 51Degrees.com
*/
function getWebsiteLink($purpose, $isPattern, $occurance=1) {
$url = "https://51degrees.com";
$utmSource = "utm_source=Github";
$utmMedium = "utm_medium=repository";
$utmContent = "example_trie";
if($isPattern) {
$utmContent = "example_pattern";
}
$utmCampaign = "utm_campaign=php-open-source";
if ($purpose === 'image') {
$url = "https://51degrees.com/DesktopModules/FiftyOne/Distributor/Logo.ashx";
} else if ($purpose === 'metrics') {
$url = "https://51degrees.com/support/documentation/howdevicedetectionworks/trie";
if ($isPattern) {
$url = "https://51degrees.com/support/documentation/pattern";
}
if ($occurance == 2) {
$utmContent .= "_header";
} else {
$utmContent .= "_ua";
}
} else if ($purpose === 'compare') {
$url = "https://51degrees.com/compare-data-options";
$utmContent .= "_compare";
} else if ($purpose === 'properties') {
$url = "https://51degrees.com/resources/property-dictionary";
if ($occurance == 2) {
$utmContent .= "_properties_header";
} else {
$utmContent .= "_properties_ua";
}
}
return $url."?".$utmSource."&".$utmMedium."&".$utmContent."&".$utmCampaign;
}
// Snippet End
?>