README

PHP API Kit v4.0, implementing v4.0 of the HandsetDetection API.

API Kits can use our web service or resolve detections locally depending on your configuration.

Installation

Download the package directly from github or use composer.

{
	"require": {
	  "handsetdetection/php-apikit": "4.*"
	}
}

Configuration

API Kit configuration files can be downloaded directly from Handset Detection.

1. Login to your dashboard
2. Click 'Add a Site'
3. Configure your new site
4. Grab the config file variables for your API Kit (from the site settings)
5. Place the variables into the hdconfig.php file

Examples

Instantiate the HD4 object

// Using the default config file
require_once('HD4.php');
$hd = new HandsetDetection\HD4();

OR

// Using a custom config file
require_once('HD4.php');
$hd = new HandsetDetection\HD4('/tmp/myCustomConfigFile.php');

List all vendors

if ($hd->deviceVendors()) {
    $data = $hd->getReply();
    print_r($data);
} else {
    print $hd->getError();
}

List all device models for a vendor (Nokia)

if ($hd->deviceModels('Nokia')) {
    $data = $hd->getReply();
    print_r($data);
} else {
    print $hd->getError();
}

View information for a specific device (Nokia N95)

if ($hd->deviceView('Nokia','N95')) {
    $data = $hd->getReply();
    print_r($data);
} else {
    print $hd->getError();
}

What devices have this attribute ?

if ($hd->deviceWhatHas('network','CDMA')) {
    $data = $hd->getReply();
    print_r($data);
} else {
    print $hd->getError();
}

Basic device detection

This is the most simple detection call - http headers are picked up automatically.

if ($hd->deviceDetect()) {
    $tmp = $hd->getReply();
    print_r($tmp);
} else {
    print $hd->getError();
}

Manually set the http headers (user-agent etc..)

$hd->setDetectVar('user-agent','Mozilla/5.0 (SymbianOS/9.2; U; Series60/3.1 NokiaN95-3/20.2.011 Profile/MIDP-2.0 Configuration/CLDC-1.1 ) AppleWebKit/413');
$hd->setDetectVar('x-wap-profile','http://nds1.nds.nokia.com/uaprof/NN95-1r100.xml');
if ($hd->deviceDetect()) {
    $tmp = $hd->getReply();
    print_r($tmp);
} else {
    print $hd->getError();
}

Download the Full Ultimate Edition

Note : Increase the default timeout before downloading the archive.

$hd->setTimeout(500);
if ($hd->deviceFetchArchive()) {
    $data = $hd->getRawReply();
    echo "Downloaded ".strlen($data)." bytes";
} else {
    print $hd->getError();
    print $hd->getRawReply();
}

Download the Community Ultimate Edition

$hd->setTimeout(500);
if ($hd->communityFetchArchive()) {
    $data = $hd->getRawReply();
    echo "Downloaded ".strlen($data)." bytes";
} else {
    print $hd->getError();
    print $hd->getRawReply();
}

Flexible Caching Options

Version 4.1.* includes APC(u), Memcache, Memcached and Redis caching options. For backwards compatibility if no option is set in the config file then it defaults to APC.

Note : Memcached and Memcached both have a default maximum object size of 1Mb which is too low. We recommend increasing this limit to at least 5Mb with the -I or --max-item-size= options.

Using Memcache

Include a the following cache configuration in your config file. Options represent any cache flags you would like to pass to the memcache::set call. See http://php.net/manual/en/memcache.set.php for more information.

$hdconfig['cache'] = array (
	'memcache' => array (
		'options' => 0,
		'servers' => array(
			'localhost' => '11211'
		)
	)
)

Using Memcached

Include a the following cache configuration in your config file. Options represent cache settings set via the setOption call : See http://php.net/manual/en/memcached.setoption.php for more information. Pass options as $option => $value in the options array.

$hdconfig['cache'] = array (
	'memcached' => array(
		'options' => array(),
		'servers' => array(
			array('localhost', '11211'),
		)
	)
);

If you're using cache connection pooling then pass the pool name as follows :

$hdconfig['cache'] = array (
	'memcached' => array(
		'pool' => 'mypool',
		'options' => array(),
		'servers' => array(
			array('localhost', '11211'),
		)
	)
);

Using Predis

From version 4.1.11 we also have Redis as a caching option. Redis caching uses Predis, which you should include via composer. Use a caching config as follows:

$hdconfig['cache'] = array (
	'redis' => array (
		'scheme' => 'tcp',
		'host'   => '127.0.0.1',
		'port'   => 6379
	)
);

Using PHPRedis

From version 4.1.12 we also have PhpRedis as a caching option, which uses the redis.so extension from https://github.com/phpredis/phpredis . connect_method can be connect or pconnect. pconnect connections also support a peristent_id.

Use a caching config as follows:

$hdconfig['cache'] = array (
	'phpredis' => array (
		'connect_method' => 'pconnect',
		'host'   => '127.0.0.1',
		'port'   => 6379,
		'timeout' => 2.5,
		'persistent_id' => 'x'
	)
);

Extra Examples

Additional examples can be found in the examples.php file.

Getting Started with the Free usage tier and Community Edition

After signing up with our service you'll be on a free usage tier which entitles you to 20,000 Cloud detections (web service) per month, and access to our Community Edition for Ultimate (stand alone) detection. The archive for stand alone detection can be downloaded manually however its easiest to configure the API kit with your credentials and let the API kit do the heavy lifting for you. See examples above for how to do this.

Instructions for manually installing the archive are available at v4 API Ultimate Community Edition, Getting Started

Unit testing

Unit tests use phpUnit and can be found in the tests directory.

API Documentation

See the v4 API Documentation.

API Kits

See the Handset Detection GitHub Repo.

Support

Let us know if you have any hassles (hello@handsetdetection.com).