FB Request Monkey

Making batch and paged requests on the Facebook API can be complicated and annoying. This app handles all of that complexity and allows for dynamic, batching, paging and error handling

Dependencies

Requires php underscore and the most recent version of the Facebook PHP SDK

Installation

require('fb_request_monkey.php');

The Facebook API needs to be initialized with a config array before requests can be made.

In Function

 $fbConfig = array(
 	'appId' => 1000,
 	'secret' => 'asdfsds',
 	'cookie' => true,	
 );

 $results = FB_Request_Monkey::sendMany($actions, $fbConfig);

In a Config File

FB_Request_Monkey::initialize($fbConfig);

Usage

To make requests, build individual actions out of the query you want to make, the access token for that query, and the method. The actions will be automatically batched.

$actions = array(
	array(
		'query' => 'me/friends',
		'method' => 'GET',
		'token' => 'ADLFKJSDFS97823987'
		'params' => array(
			'param1' => 'test',
		),
	),
	array(
		'query' => 'me',
		'method' => 'GET',
		'token' => 'ADLFKJSDFS97823987'
		'params' => array(
			'param1' => 'test',
		),
	),
);

$results = FB_Request_Monkey::sendMany($actions);

Single Action

$action = array(
	'query' => 'me/friends',
	'token' => 'ADLFKJSDFS97823987'
	'method' => 'GET',
	'params' => array(
		'param1' => 'test',
	),
);

$results = FB_Request_Monkey::sendOne($action);

FQL

$action = array(
	'method' => 'GET',
	'query' => 'fql',
	'token' => 'Aasdlkjaslkjsdf',
	'params' => array(
		'q' => 'SELECT uid, name, pic_square FROM user WHERE uid = me()',
	),
);

FQL MultiQuery

This would return all of the names of all of the friends for the current users

$action = array(
	'method' => 'GET',
	'query' => 'fql',
	'token' => 'AAACZAvGW91SwBAAwx0d8DKTpkwkZCXP2yvF5UK2YNPYJVcDThI7HTFImTutxXrJQH2icFSLZBIkwOr4qD0SxUnMD01rFQJYgNZCfpgFh1wZDZD',
	'params' => array(
		'q' => array(
			'query1' => 'SELECT uid2 FROM friend WHERE uid1 = me()',
			'query2' => 'SELECT name FROM user WHERE uid IN (SELECT uid2 FROM #query1)',
		),
	),
);

Labelling / Grouping

If you want the data that's returned to be grouped, add a label parameter to the action.

$actions = array(
	array(
		'query' => 'me/friends',
		'method' => 'GET',
		'token' => 'ADLFKJSDFS97823987'
		'params' => array(
			'param1' => 'test',
		),
		'label' => 'foo',
	),
	array(
		'query' => 'me',
		'method' => 'GET',
		'token' => 'ADLFKJSDFS97823987'
		'params' => array(
			'param1' => 'test',
		),
		'label' = 'bar',
	),
);
$results = FB_Request_Monkey::sendMany($actions);

This would return

$labelledResults = array(
	'foo' => array(
		//data for this label
	),
	'bar' => array(
		//data for this label
	),
);

Applying multiple labels

If you'd like more than one label to be applied to each action, add an array of labels, going from outside to inside, and the labels will be applied accordingly.

$actions = array(
	array(
		'query' => '1000/friends',
		'method' => 'GET',
		'token' => 'ADLFKJSDFS97823987'
		'params' => array(
			'param1' => 'test',
		),
		'label' => array(1000, 'friend_query');
	),
	array(
		'query' => 'me',
		'method' => 'GET',
		'token' => 'ADLFKJSDFS97823987'
		'params' => array(
			'param1' => 'test',
		),
		'label' => array(1000, 'overall_query');
	),
	array(
		'query' => '2000/friends',
		'method' => 'GET',
		'token' => 'ADLFKJSDFS97823987'
		'params' => array(
			'param1' => 'test',
		),
		'label' => array(2000, 'friend_query');
	),
	array(
		'query' => '2000',
		'method' => 'GET',
		'token' => 'ADLFKJSDFS97823987'
		'params' => array(
			'param1' => 'test',
		),
		'label' => array(2000, 'overall_query');
	),
);
$results = FB_Request_Monkey::sendMany($actions);

Would result in

$labelledResults = array(
	1000 => array(
		'friend_query' => array(
			//results
		),
		'overall_query' => array(
			//results
		),
	),
	2000 => array(
		'friend_query' => array(
			//results
		),
		'overall_query' => array(
			//results
		),
	),
);

Optional Parameters

Returning Errors

If there's an error in a single batch request, the default behavior is to throw an exception at the point and halt the program. At times, this may not be the desired behvaior. If you'd like to have errors be returned rather than generate exceptions, pass in $allowErrors in the options array. Note: There is default result counting functionality to confirm that all results that go out, come back. If you allowErrors, you are disabling result counting as well.

$options = array(
	'allowErrors' => true,
);

$actions = array(
	array(
		'query' => 'wrongQuery',
		'token' => ADLFKJSDFS97823987,
		'method' => 'GET',
	),
	array(
		'query' => 'me'
		'token' => ADLFKJSDFS97823987,
		'method' => 'GET',
	),
);

$results = FB_Request_Monkey::sendMany($actions, $config, $options);

This would result in

$results = array(
	'data' => array(
		array(
			'error' => array(
				'message' => "(#803) Some of the aliases you requested do not exist: wrongQuery",
				'type' => "OAuthException",
				'code' => 803,
			),
		),
		array(
			// good results from 'me' action
		),
	),
);