Getting started example of using 51Degrees device detection match metrics information. The example shows how to:
  1. Fetch a pointer to the 51Degrees device detection provider instance. This is instantiated on server startup and uses settings from php.ini.

    $provider = FiftyOneDegreesPatternV3::provider_get();
    

  2. Produce a match for a single HTTP User-Agent header

    my $match = $provider->getMatch($userAgent)
    

  3. Extract the value of the IsMobile property

    $match->getValue('IsMobile')
    

  4. Obtain device Id: consists of four components separated by a hyphen symbol: Hardware-Platform-Browser-IsCrawler where each Component represents an ID of the corresponding Profile.

    $match->getDeviceId();
  5. Obtain match method: provides information about the algorithm that was used to perform detection for a particular User-Agent. For more information on what each method means please see: How device detection works

    $match->getMethod();
  6. Obtain difference: used when detection method is not Exact or None. This is an integer value and the larger the value the less confident the detector is in this result.

    $match->getDifference();
  7. Obtain signature rank: an integer value that indicates how popular the device is. The lower the rank the more popular the signature.

    $match->getRank();
This example assumes you have the 51Degrees PHP API installed correctly, and have FiftyOneDegreesPatternV3.php in this directory. */ // Snippet Start require("../pattern/FiftyOneDegreesPatternV3.php"); $provider = FiftyOneDegreesPatternV3::provider_get(); // User-Agent string of an iPhone mobile device. $mobileUserAgent = "Mozilla/5.0 (iPhone; CPU iPhone OS 7_1 like Mac OS X) ". "AppleWebKit/537.51.2 (KHTML, like Gecko) 'Version/7.0 Mobile/11D167 ". "Safari/9537.53"; // User-Agent string of Firefox Web browser version 41 on desktop. $desktopUserAgent = "Mozilla/5.0 (Windows NT 6.3; WOW64; rv:41.0) ". "Gecko/20100101 Firefox/41.0"; // User-Agent string of a MediaHub device. $mediaHubUserAgent = "Mozilla/5.0 (Linux; Android 4.4.2; X7 Quad Core ". "Build/KOT49H) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 ". "Chrome/30.0.0.0 Safari/537.36"; // output_metrics function. Takes a match object as an argument // and print the match metrics relating to the specific match. function output_metrics($match) { echo "Device Id: ".$match->getDeviceId()."
\n"; echo "Method: ".$match->getMethod()."
\n"; echo "Difference: ".$match->getDifference()."
\n"; echo "Rank: ".$match->getRank()."
\n"; } echo "Starting Getting Started Match Metrics Example.
\n"; // Carries out a match with a mobile User-Agent. echo "
\nMobile User-Agent: ".$mobileUserAgent."
\n"; $match = $provider->getMatch($mobileUserAgent); output_metrics($match); // Carries out a match with a desktop User-Agent. echo "
\nDesktop User-Agent: ".$desktopUserAgent."
\n"; $match = $provider->getMatch($desktopUserAgent); output_metrics($match); // Carries out a match with a MediaHub User-Agent. echo "
\nMediaHub User-Agent: ".$mediaHubUserAgent."
\n"; $match = $provider->getMatch($mediaHubUserAgent); output_metrics($match); // Snippet End ?>