secret = $secret;
$this->session_key = $session_key;
$this->api_key = $api_key;
$this->last_call_id = 0;
$this->server_addr = Facebook::get_facebook_url('api') . '/restserver.php';
if ($GLOBALS['facebook_config']['debug']) {
$this->cur_id = 0;
?>
call_method('facebook.auth.getSession', array('auth_token'=>$auth_token));
$this->session_key = $result['session_key'];
if (isset($result['secret']) && $result['secret']) {
// desktop apps have a special secret
$this->secret = $result['secret'];
}
return $result;
}
/**
* Returns events according to the filters specified.
* @param int $uid Optional: User associated with events.
* A null parameter will default to the session user.
* @param array $eids Optional: Filter by these event ids.
* A null parameter will get all events for the user.
* @param int $start_time Optional: Filter with this UTC as lower bound.
* A null or zero parameter indicates no lower bound.
* @param int $end_time Optional: Filter with this UTC as upper bound.
* A null or zero parameter indicates no upper bound.
* @param string $rsvp_status Optional: Only show events where the given uid
* has this rsvp status. This only works if you have specified a value for
* $uid. Values are as in events.getMembers. Null indicates to ignore
* rsvp status when filtering.
* @return array of events
*/
public function events_get($uid, $eids, $start_time, $end_time, $rsvp_status) {
return $this->call_method('facebook.events.get',
array(
'uid' => $uid,
'eids' => $eids,
'start_time' => $start_time,
'end_time' => $end_time,
'rsvp_status' => $rsvp_status));
}
/**
* Returns membership list data associated with an event
* @param int $eid : event id
* @return assoc array of four membership lists, with keys 'attending',
* 'unsure', 'declined', and 'not_replied'
*/
public function events_getMembers($eid) {
return $this->call_method('facebook.events.getMembers',
array('eid' => $eid));
}
/**
* Makes an FQL query. This is a generalized way of accessing all the data
* in the API, as an alternative to most of the other method calls. More
* info at http://developers.facebook.com/documentation.php?v=1.0&doc=fql
* @param string $query the query to evaluate
* @return generalized array representing the results
*/
public function fql_query($query) {
return $this->call_method('facebook.fql.query',
array('query' => $query));
}
public function feed_publishStoryToUser($title, $body,
$image_1=null, $image_1_link=null,
$image_2=null, $image_2_link=null,
$image_3=null, $image_3_link=null,
$image_4=null, $image_4_link=null) {
return $this->call_method('facebook.feed.publishStoryToUser',
array('title' => $title,
'body' => $body,
'image_1' => $image_1,
'image_1_link' => $image_1_link,
'image_2' => $image_2,
'image_2_link' => $image_2_link,
'image_3' => $image_3,
'image_3_link' => $image_3_link,
'image_4' => $image_4,
'image_4_link' => $image_4_link));
}
public function feed_publishActionOfUser($title, $body,
$image_1=null, $image_1_link=null,
$image_2=null, $image_2_link=null,
$image_3=null, $image_3_link=null,
$image_4=null, $image_4_link=null) {
return $this->call_method('facebook.feed.publishActionOfUser',
array('title' => $title,
'body' => $body,
'image_1' => $image_1,
'image_1_link' => $image_1_link,
'image_2' => $image_2,
'image_2_link' => $image_2_link,
'image_3' => $image_3,
'image_3_link' => $image_3_link,
'image_4' => $image_4,
'image_4_link' => $image_4_link));
}
public function feed_publishTemplatizedAction($actor_id, $title_template, $title_data,
$body_template, $body_data, $body_general,
$image_1=null, $image_1_link=null,
$image_2=null, $image_2_link=null,
$image_3=null, $image_3_link=null,
$image_4=null, $image_4_link=null,
$target_ids='') {
return $this->call_method('facebook.feed.publishTemplatizedAction',
array('actor_id' => $actor_id,
'title_template' => $title_template,
'title_data' => is_array($title_data) ? json_encode($title_data) : $title_data,
'body_template' => $body_template,
'body_data' => is_array($body_data) ? json_encode($body_data) : $body_data,
'body_general' => $body_general,
'image_1' => $image_1,
'image_1_link' => $image_1_link,
'image_2' => $image_2,
'image_2_link' => $image_2_link,
'image_3' => $image_3,
'image_3_link' => $image_3_link,
'image_4' => $image_4,
'image_4_link' => $image_4_link,
'target_ids' => $target_ids));
}
/**
* Returns whether or not pairs of users are friends.
* Note that the Facebook friend relationship is symmetric.
* @param array $uids1: array of ids (id_1, id_2,...) of some length X
* @param array $uids2: array of ids (id_A, id_B,...) of SAME length X
* @return array of uid pairs with bool, true if pair are friends, e.g.
* array( 0 => array('uid1' => id_1, 'uid2' => id_A, 'are_friends' => 1),
* 1 => array('uid1' => id_2, 'uid2' => id_B, 'are_friends' => 0)
* ...)
*/
public function friends_areFriends($uids1, $uids2) {
return $this->call_method('facebook.friends.areFriends',
array('uids1'=>$uids1, 'uids2'=>$uids2));
}
/**
* Returns the friends of the current session user.
* @return array of friends
*/
public function friends_get() {
if (isset($this->friends_list)) {
return $this->friends_list;
}
return $this->call_method('facebook.friends.get', array());
}
/**
* Returns the friends of the session user, who are also users
* of the calling application.
* @return array of friends
*/
public function friends_getAppUsers() {
return $this->call_method('facebook.friends.getAppUsers', array());
}
/**
* Returns groups according to the filters specified.
* @param int $uid Optional: User associated with groups.
* A null parameter will default to the session user.
* @param array $gids Optional: group ids to query.
* A null parameter will get all groups for the user.
* @return array of groups
*/
public function groups_get($uid, $gids) {
return $this->call_method('facebook.groups.get',
array(
'uid' => $uid,
'gids' => $gids));
}
/**
* Returns the membership list of a group
* @param int $gid : Group id
* @return assoc array of four membership lists, with keys
* 'members', 'admins', 'officers', and 'not_replied'
*/
public function groups_getMembers($gid) {
return $this->call_method('facebook.groups.getMembers',
array('gid' => $gid));
}
/**
* Returns the outstanding notifications for the session user.
* @return assoc array of
* notification count objects for 'messages', 'pokes' and 'shares',
* a uid list of 'friend_requests', a gid list of 'group_invites',
* and an eid list of 'event_invites'
*/
public function notifications_get() {
return $this->call_method('facebook.notifications.get', array());
}
/**
* Sends an email notification to the specified user.
* @return string url which you should send the logged in user to to finalize the message.
*/
public function notifications_send($to_ids, $notification, $email='') {
return $this->call_method('facebook.notifications.send',
array('to_ids' => $to_ids, 'notification' => $notification, 'email' => $email));
}
/**
* Sends a request to the specified user (e.g. "you have 1 event invitation")
* @param array $to_ids user ids to receive the request (must be friends with sender, capped at 10)
* @param string $type type of request, e.g. "event" (as in "You have an event invitation.")
* @param string $content fbml content of the request. really stripped down fbml - just
* text/names/links. also, use the special tag
* to specify the buttons to be included.
* @param string $image url of an image to show beside the request
* @param bool $invite whether to call it an "invitation" or a "request"
* @return string url which you should send the logged in user to to finalize the message.
*/
public function notifications_sendRequest($to_ids, $type, $content, $image, $invite) {
return $this->call_method('facebook.notifications.sendRequest',
array('to_ids' => $to_ids, 'type' => $type, 'content' => $content,
'image' => $image, 'invite' => $invite));
}
/**
* Returns photos according to the filters specified.
* @param int $subj_id Optional: Filter by uid of user tagged in the photos.
* @param int $aid Optional: Filter by an album, as returned by
* photos_getAlbums.
* @param array $pids Optional: Restrict to a list of pids
* Note that at least one of these parameters needs to be specified, or an
* error is returned.
* @return array of photo objects.
*/
public function photos_get($subj_id, $aid, $pids) {
return $this->call_method('facebook.photos.get',
array('subj_id' => $subj_id, 'aid' => $aid, 'pids' => $pids));
}
/**
* Returns the albums created by the given user.
* @param int $uid Optional: the uid of the user whose albums you want.
* A null value will return the albums of the session user.
* @param array $aids Optional: a list of aids to restrict the query.
* Note that at least one of the (uid, aids) parameters must be specified.
* @returns an array of album objects.
*/
public function photos_getAlbums($uid, $aids) {
return $this->call_method('facebook.photos.getAlbums',
array('uid' => $uid,
'aids' => $aids));
}
/**
* Returns the tags on all photos specified.
* @param string $pids : a list of pids to query
* @return array of photo tag objects, with include pid, subject uid,
* and two floating-point numbers (xcoord, ycoord) for tag pixel location
*/
public function photos_getTags($pids) {
return $this->call_method('facebook.photos.getTags',
array('pids' => $pids));
}
/**
* Returns the requested info fields for the requested set of users
* @param array $uids an array of user ids
* @param array $fields an array of strings describing the info fields desired
* @return array of users
*/
public function users_getInfo($uids, $fields) {
return $this->call_method('facebook.users.getInfo', array('uids' => $uids, 'fields' => $fields));
}
/**
* Returns the user corresponding to the current session object.
* @return integer uid
*/
public function users_getLoggedInUser(){
return $this->call_method('facebook.users.getLoggedInUser', array());
}
/**
* Returns whether or not the user corresponding to the current session object has the app installed
* @return boolean
*/
public function users_isAppAdded() {
if (isset($this->added)) {
return $this->added;
}
return $this->call_method('facebook.users.isAppAdded', array());
}
/**
* Sets the FBML for the profile of the user attached to this session
* @param string $markup The FBML that describes the profile presence of this app for the user
* @return array A list of strings describing any compile errors for the submitted FBML
*/
public function profile_setFBML($markup, $uid = null) {
return $this->call_method('facebook.profile.setFBML', array('markup' => $markup, 'uid' => $uid));
}
public function profile_getFBML($uid) {
return $this->call_method('facebook.profile.getFBML', array('uid' => $uid));
}
public function fbml_refreshImgSrc($url) {
return $this->call_method('facebook.fbml.refreshImgSrc', array('url' => $url));
}
public function fbml_refreshRefUrl($url) {
return $this->call_method('facebook.fbml.refreshRefUrl', array('url' => $url));
}
public function fbml_setRefHandle($handle, $fbml) {
return $this->call_method('facebook.fbml.setRefHandle', array('handle' => $handle, 'fbml' => $fbml));
}
/**
* Get all the marketplace categories
*
* @return array A list of category names
*/
function marketplace_getCategories() {
return $this->call_method('facebook.marketplace.getCategories', array());
}
/**
* Get all the marketplace subcategories for a particular category
*
* @param category The category for which we are pulling subcategories
* @return array A list of subcategory names
*/
function marketplace_getSubCategories($category) {
return $this->call_method('facebook.marketplace.getSubCategories', array('category' => $category));
}
/**
* Get listings by either listing_id or user
*
* @param listing_ids An array of listing_ids (optional)
* @param uids An array of user ids (optional)
* @return array The data for matched listings
*/
function marketplace_getListings($listing_ids, $uids) {
return $this->call_method('facebook.marketplace.getListings', array('listing_ids' => $listing_ids, 'uids' => $uids));
}
/**
* Search for Marketplace listings. All arguments are optional, though at least
* one must be filled out to retrieve results.
*
* @param category The category in which to search (optional)
* @param subcategory The subcategory in which to search (optional)
* @param query A query string (optional)
* @return array The data for matched listings
*/
function marketplace_search($category, $subcategory, $query) {
return $this->call_method('facebook.marketplace.search', array('category' => $category, 'subcategory' => $subcategory, 'query' => $query));
}
/**
* Remove a listing from Marketplace
*
* @param listing_id The id of the listing to be removed
* @param status 'SUCCESS', 'NOT_SUCCESS', or 'DEFAULT'
* @return bool True on success
*/
function marketplace_removeListing($listing_id, $status='DEFAULT') {
return $this->call_method('facebook.marketplace.removeListing',
array('listing_id'=>$listing_id,
'status'=>$status));
}
/**
* Create/modify a Marketplace listing for the loggedinuser
*
* @param int listing_id The id of a listing to be modified, 0 for a new listing.
* @param show_on_profile bool Should we show this listing on the user's profile
* @param attrs array An array of the listing data
* @return int The listing_id (unchanged if modifying an existing listing)
*/
function marketplace_createListing($listing_id, $show_on_profile, $attrs) {
return $this->call_method('facebook.marketplace.createListing',
array('listing_id'=>$listing_id,
'show_on_profile'=>$show_on_profile,
'attrs'=>json_encode($attrs)));
}
/////////////////////////////////////////////////////////////////////////////
// Data Store API
/**
* Set a user preference.
*
* @param pref_id preference identifier (0-200)
* @param value preferece's value
* @error
* API_EC_DATA_DATABASE_ERROR
* API_EC_PARAM
* API_EC_DATA_QUOTA_EXCEEDED
* API_EC_DATA_UNKNOWN_ERROR
*/
public function data_setUserPreference($pref_id, $value) {
return $this->call_method
('facebook.data.setUserPreference',
array('pref_id' => $pref_id,
'value' => $value));
}
/**
* Set a user's all preferences for this application.
*
* @param values preferece values in an associative arrays
* @param replace whether to replace all existing preferences or
* merge into them.
* @error
* API_EC_DATA_DATABASE_ERROR
* API_EC_PARAM
* API_EC_DATA_QUOTA_EXCEEDED
* API_EC_DATA_UNKNOWN_ERROR
*/
public function data_setUserPreferences($values, $replace = false) {
return $this->call_method
('facebook.data.setUserPreferences',
array('values' => json_encode($values),
'replace' => $replace));
}
/**
* Get a user preference.
*
* @param pref_id preference identifier (0-200)
* @return preference's value
* @error
* API_EC_DATA_DATABASE_ERROR
* API_EC_PARAM
* API_EC_DATA_QUOTA_EXCEEDED
* API_EC_DATA_UNKNOWN_ERROR
*/
public function data_getUserPreference($pref_id) {
return $this->call_method
('facebook.data.getUserPreference',
array('pref_id' => $pref_id));
}
/**
* Get a user preference.
*
* @return preference values
* @error
* API_EC_DATA_DATABASE_ERROR
* API_EC_DATA_QUOTA_EXCEEDED
* API_EC_DATA_UNKNOWN_ERROR
*/
public function data_getUserPreferences() {
return $this->call_method
('facebook.data.getUserPreferences',
array());
}
/**
* Create a new object type.
*
* @param name object type's name
* @error
* API_EC_DATA_DATABASE_ERROR
* API_EC_DATA_OBJECT_ALREADY_EXISTS
* API_EC_PARAM
* API_EC_PERMISSION
* API_EC_DATA_INVALID_OPERATION
* API_EC_DATA_QUOTA_EXCEEDED
* API_EC_DATA_UNKNOWN_ERROR
*/
public function data_createObjectType($name) {
return $this->call_method
('facebook.data.createObjectType',
array('name' => $name));
}
/**
* Delete an object type.
*
* @param obj_type object type's name
* @error
* API_EC_DATA_DATABASE_ERROR
* API_EC_DATA_OBJECT_NOT_FOUND
* API_EC_PARAM
* API_EC_PERMISSION
* API_EC_DATA_INVALID_OPERATION
* API_EC_DATA_QUOTA_EXCEEDED
* API_EC_DATA_UNKNOWN_ERROR
*/
public function data_dropObjectType($obj_type) {
return $this->call_method
('facebook.data.dropObjectType',
array('obj_type' => $obj_type));
}
/**
* Rename an object type.
*
* @param obj_type object type's name
* @param new_name new object type's name
* @error
* API_EC_DATA_DATABASE_ERROR
* API_EC_DATA_OBJECT_NOT_FOUND
* API_EC_DATA_OBJECT_ALREADY_EXISTS
* API_EC_PARAM
* API_EC_PERMISSION
* API_EC_DATA_INVALID_OPERATION
* API_EC_DATA_QUOTA_EXCEEDED
* API_EC_DATA_UNKNOWN_ERROR
*/
public function data_renameObjectType($obj_type, $new_name) {
return $this->call_method
('facebook.data.renameObjectType',
array('obj_type' => $obj_type,
'new_name' => $new_name));
}
/**
* Add a new property to an object type.
*
* @param obj_type object type's name
* @param prop_name name of the property to add
* @param prop_type 1: integer; 2: string; 3: text blob
* @error
* API_EC_DATA_DATABASE_ERROR
* API_EC_DATA_OBJECT_ALREADY_EXISTS
* API_EC_PARAM
* API_EC_PERMISSION
* API_EC_DATA_INVALID_OPERATION
* API_EC_DATA_QUOTA_EXCEEDED
* API_EC_DATA_UNKNOWN_ERROR
*/
public function data_defineObjectProperty($obj_type, $prop_name, $prop_type){
return $this->call_method
('facebook.data.defineObjectProperty',
array('obj_type' => $obj_type,
'prop_name' => $prop_name,
'prop_type' => $prop_type));
}
/**
* Remove a previously defined property from an object type.
*
* @param obj_type object type's name
* @param prop_name name of the property to remove
* @error
* API_EC_DATA_DATABASE_ERROR
* API_EC_DATA_OBJECT_NOT_FOUND
* API_EC_PARAM
* API_EC_PERMISSION
* API_EC_DATA_INVALID_OPERATION
* API_EC_DATA_QUOTA_EXCEEDED
* API_EC_DATA_UNKNOWN_ERROR
*/
public function data_undefineObjectProperty($obj_type, $prop_name) {
return $this->call_method
('facebook.data.undefineObjectProperty',
array('obj_type' => $obj_type,
'prop_name' => $prop_name));
}
/**
* Rename a previously defined property of an object type.
*
* @param obj_type object type's name
* @param prop_name name of the property to rename
* @param new_name new name to use
* @error
* API_EC_DATA_DATABASE_ERROR
* API_EC_DATA_OBJECT_NOT_FOUND
* API_EC_DATA_OBJECT_ALREADY_EXISTS
* API_EC_PARAM
* API_EC_PERMISSION
* API_EC_DATA_INVALID_OPERATION
* API_EC_DATA_QUOTA_EXCEEDED
* API_EC_DATA_UNKNOWN_ERROR
*/
public function data_renameObjectProperty($obj_type, $prop_name,
$new_name) {
return $this->call_method
('facebook.data.renameObjectProperty',
array('obj_type' => $obj_type,
'prop_name' => $prop_name,
'new_name' => $new_name));
}
/**
* Retrieve a list of all object types that have defined for the application.
*
* @return a list of object type names
* @error
* API_EC_DATA_DATABASE_ERROR
* API_EC_PERMISSION
* API_EC_DATA_QUOTA_EXCEEDED
* API_EC_DATA_UNKNOWN_ERROR
*/
public function data_getObjectTypes() {
return $this->call_method
('facebook.data.getObjectTypes',
array());
}
/**
* Get definitions of all properties of an object type.
*
* @param obj_type object type's name
* @return pairs of property name and property types
* @error
* API_EC_DATA_DATABASE_ERROR
* API_EC_PARAM
* API_EC_PERMISSION
* API_EC_DATA_OBJECT_NOT_FOUND
* API_EC_DATA_QUOTA_EXCEEDED
* API_EC_DATA_UNKNOWN_ERROR
*/
public function data_getObjectType($obj_type) {
return $this->call_method
('facebook.data.getObjectType',
array('obj_type' => $obj_type));
}
/**
* Create a new object.
*
* @param obj_type object type's name
* @param properties (optional) properties to set initially
* @return newly created object's id
* @error
* API_EC_DATA_DATABASE_ERROR
* API_EC_PARAM
* API_EC_PERMISSION
* API_EC_DATA_INVALID_OPERATION
* API_EC_DATA_QUOTA_EXCEEDED
* API_EC_DATA_UNKNOWN_ERROR
*/
public function data_createObject($obj_type, $properties = null) {
return $this->call_method
('facebook.data.createObject',
array('obj_type' => $obj_type,
'properties' => json_encode($properties)));
}
/**
* Update an existing object.
*
* @param obj_id object's id
* @param properties new properties
* @param replace true for replacing existing properties; false for merging
* @error
* API_EC_DATA_DATABASE_ERROR
* API_EC_DATA_OBJECT_NOT_FOUND
* API_EC_PARAM
* API_EC_PERMISSION
* API_EC_DATA_INVALID_OPERATION
* API_EC_DATA_QUOTA_EXCEEDED
* API_EC_DATA_UNKNOWN_ERROR
*/
public function data_updateObject($obj_id, $properties, $replace = false) {
return $this->call_method
('facebook.data.updateObject',
array('obj_id' => $obj_id,
'properties' => json_encode($properties),
'replace' => $replace));
}
/**
* Delete an existing object.
*
* @param obj_id object's id
* @error
* API_EC_DATA_DATABASE_ERROR
* API_EC_DATA_OBJECT_NOT_FOUND
* API_EC_PARAM
* API_EC_PERMISSION
* API_EC_DATA_INVALID_OPERATION
* API_EC_DATA_QUOTA_EXCEEDED
* API_EC_DATA_UNKNOWN_ERROR
*/
public function data_deleteObject($obj_id) {
return $this->call_method
('facebook.data.deleteObject',
array('obj_id' => $obj_id));
}
/**
* Delete a list of objects.
*
* @param obj_ids objects to delete
* @error
* API_EC_DATA_DATABASE_ERROR
* API_EC_PARAM
* API_EC_PERMISSION
* API_EC_DATA_INVALID_OPERATION
* API_EC_DATA_QUOTA_EXCEEDED
* API_EC_DATA_UNKNOWN_ERROR
*/
public function data_deleteObjects($obj_ids) {
return $this->call_method
('facebook.data.deleteObjects',
array('obj_ids' => json_encode($obj_ids)));
}
/**
* Get a single property value of an object.
*
* @param obj_id object's id
* @param prop_name individual property's name
* @return individual property's value
* @error
* API_EC_DATA_DATABASE_ERROR
* API_EC_DATA_OBJECT_NOT_FOUND
* API_EC_PARAM
* API_EC_PERMISSION
* API_EC_DATA_INVALID_OPERATION
* API_EC_DATA_QUOTA_EXCEEDED
* API_EC_DATA_UNKNOWN_ERROR
*/
public function data_getObjectProperty($obj_id, $prop_name) {
return $this->call_method
('facebook.data.getObjectProperty',
array('obj_id' => $obj_id,
'prop_name' => $prop_name));
}
/**
* Get properties of an object.
*
* @param obj_id object's id
* @param prop_names (optional) properties to return; null for all.
* @return specified properties of an object
* @error
* API_EC_DATA_DATABASE_ERROR
* API_EC_DATA_OBJECT_NOT_FOUND
* API_EC_PARAM
* API_EC_PERMISSION
* API_EC_DATA_INVALID_OPERATION
* API_EC_DATA_QUOTA_EXCEEDED
* API_EC_DATA_UNKNOWN_ERROR
*/
public function data_getObject($obj_id, $prop_names = null) {
return $this->call_method
('facebook.data.getObject',
array('obj_id' => $obj_id,
'prop_names' => json_encode($prop_names)));
}
/**
* Get properties of a list of objects.
*
* @param obj_ids object ids
* @param prop_names (optional) properties to return; null for all.
* @return specified properties of an object
* @error
* API_EC_DATA_DATABASE_ERROR
* API_EC_DATA_OBJECT_NOT_FOUND
* API_EC_PARAM
* API_EC_PERMISSION
* API_EC_DATA_INVALID_OPERATION
* API_EC_DATA_QUOTA_EXCEEDED
* API_EC_DATA_UNKNOWN_ERROR
*/
public function data_getObjects($obj_ids, $prop_names = null) {
return $this->call_method
('facebook.data.getObjects',
array('obj_ids' => json_encode($obj_ids),
'prop_names' => json_encode($prop_names)));
}
/**
* Set a single property value of an object.
*
* @param obj_id object's id
* @param prop_name individual property's name
* @param prop_value new value to set
* @error
* API_EC_DATA_DATABASE_ERROR
* API_EC_DATA_OBJECT_NOT_FOUND
* API_EC_PARAM
* API_EC_PERMISSION
* API_EC_DATA_INVALID_OPERATION
* API_EC_DATA_QUOTA_EXCEEDED
* API_EC_DATA_UNKNOWN_ERROR
*/
public function data_setObjectProperty($obj_id, $prop_name,
$prop_value) {
return $this->call_method
('facebook.data.setObjectProperty',
array('obj_id' => $obj_id,
'prop_name' => $prop_name,
'prop_value' => $prop_value));
}
/**
* Read hash value by key.
*
* @param obj_type object type's name
* @param key hash key
* @param prop_name (optional) individual property's name
* @return hash value
* @error
* API_EC_DATA_DATABASE_ERROR
* API_EC_PARAM
* API_EC_PERMISSION
* API_EC_DATA_INVALID_OPERATION
* API_EC_DATA_QUOTA_EXCEEDED
* API_EC_DATA_UNKNOWN_ERROR
*/
public function data_getHashValue($obj_type, $key, $prop_name = null) {
return $this->call_method
('facebook.data.getHashValue',
array('obj_type' => $obj_type,
'key' => $key,
'prop_name' => $prop_name));
}
/**
* Write hash value by key.
*
* @param obj_type object type's name
* @param key hash key
* @param value hash value
* @param prop_name (optional) individual property's name
* @error
* API_EC_DATA_DATABASE_ERROR
* API_EC_PARAM
* API_EC_PERMISSION
* API_EC_DATA_INVALID_OPERATION
* API_EC_DATA_QUOTA_EXCEEDED
* API_EC_DATA_UNKNOWN_ERROR
*/
public function data_setHashValue($obj_type, $key, $value, $prop_name = null) {
return $this->call_method
('facebook.data.setHashValue',
array('obj_type' => $obj_type,
'key' => $key,
'value' => $value,
'prop_name' => $prop_name));
}
/**
* Increase a hash value by specified increment atomically.
*
* @param obj_type object type's name
* @param key hash key
* @param prop_name individual property's name
* @param increment (optional) default is 1
* @return incremented hash value
* @error
* API_EC_DATA_DATABASE_ERROR
* API_EC_PARAM
* API_EC_PERMISSION
* API_EC_DATA_INVALID_OPERATION
* API_EC_DATA_QUOTA_EXCEEDED
* API_EC_DATA_UNKNOWN_ERROR
*/
public function data_incHashValue($obj_type, $key, $prop_name, $increment = 1) {
return $this->call_method
('facebook.data.incHashValue',
array('obj_type' => $obj_type,
'key' => $key,
'prop_name' => $prop_name,
'increment' => $increment));
}
/**
* Remove a hash key and its values.
*
* @param obj_type object type's name
* @param key hash key
* @error
* API_EC_DATA_DATABASE_ERROR
* API_EC_PARAM
* API_EC_PERMISSION
* API_EC_DATA_INVALID_OPERATION
* API_EC_DATA_QUOTA_EXCEEDED
* API_EC_DATA_UNKNOWN_ERROR
*/
public function data_removeHashKey($obj_type, $key) {
return $this->call_method
('facebook.data.removeHashKey',
array('obj_type' => $obj_type,
'key' => $key));
}
/**
* Remove hash keys and their values.
*
* @param obj_type object type's name
* @param keys hash keys
* @error
* API_EC_DATA_DATABASE_ERROR
* API_EC_PARAM
* API_EC_PERMISSION
* API_EC_DATA_INVALID_OPERATION
* API_EC_DATA_QUOTA_EXCEEDED
* API_EC_DATA_UNKNOWN_ERROR
*/
public function data_removeHashKeys($obj_type, $keys) {
return $this->call_method
('facebook.data.removeHashKeys',
array('obj_type' => $obj_type,
'keys' => json_encode($keys)));
}
/**
* Define an object association.
*
* @param name name of this association
* @param assoc_type 1: one-way 2: two-way symmetric 3: two-way asymmetric
* @param assoc_info1 needed info about first object type
* @param assoc_info2 needed info about second object type
* @param inverse (optional) name of reverse association
* @error
* API_EC_DATA_DATABASE_ERROR
* API_EC_DATA_OBJECT_ALREADY_EXISTS
* API_EC_PARAM
* API_EC_PERMISSION
* API_EC_DATA_INVALID_OPERATION
* API_EC_DATA_QUOTA_EXCEEDED
* API_EC_DATA_UNKNOWN_ERROR
*/
public function data_defineAssociation($name, $assoc_type, $assoc_info1,
$assoc_info2, $inverse = null) {
return $this->call_method
('facebook.data.defineAssociation',
array('name' => $name,
'assoc_type' => $assoc_type,
'assoc_info1' => json_encode($assoc_info1),
'assoc_info2' => json_encode($assoc_info2),
'inverse' => $inverse));
}
/**
* Undefine an object association.
*
* @param name name of this association
* @error
* API_EC_DATA_DATABASE_ERROR
* API_EC_DATA_OBJECT_NOT_FOUND
* API_EC_PARAM
* API_EC_PERMISSION
* API_EC_DATA_INVALID_OPERATION
* API_EC_DATA_QUOTA_EXCEEDED
* API_EC_DATA_UNKNOWN_ERROR
*/
public function data_undefineAssociation($name) {
return $this->call_method
('facebook.data.undefineAssociation',
array('name' => $name));
}
/**
* Rename an object association or aliases.
*
* @param name name of this association
* @param new_name (optional) new name of this association
* @param new_alias1 (optional) new alias for object type 1
* @param new_alias2 (optional) new alias for object type 2
* @error
* API_EC_DATA_DATABASE_ERROR
* API_EC_DATA_OBJECT_ALREADY_EXISTS
* API_EC_DATA_OBJECT_NOT_FOUND
* API_EC_PARAM
* API_EC_PERMISSION
* API_EC_DATA_INVALID_OPERATION
* API_EC_DATA_QUOTA_EXCEEDED
* API_EC_DATA_UNKNOWN_ERROR
*/
public function data_renameAssociation($name, $new_name, $new_alias1 = null,
$new_alias2 = null) {
return $this->call_method
('facebook.data.renameAssociation',
array('name' => $name,
'new_name' => $new_name,
'new_alias1' => $new_alias1,
'new_alias2' => $new_alias2));
}
/**
* Get definition of an object association.
*
* @param name name of this association
* @return specified association
* @error
* API_EC_DATA_DATABASE_ERROR
* API_EC_DATA_OBJECT_NOT_FOUND
* API_EC_PARAM
* API_EC_PERMISSION
* API_EC_DATA_QUOTA_EXCEEDED
* API_EC_DATA_UNKNOWN_ERROR
*/
public function data_getAssociationDefinition($name) {
return $this->call_method
('facebook.data.getAssociationDefinition',
array('name' => $name));
}
/**
* Get definition of all associations.
*
* @return all defined associations
* @error
* API_EC_DATA_DATABASE_ERROR
* API_EC_PERMISSION
* API_EC_DATA_QUOTA_EXCEEDED
* API_EC_DATA_UNKNOWN_ERROR
*/
public function data_getAssociationDefinitions() {
return $this->call_method
('facebook.data.getAssociationDefinitions',
array());
}
/**
* Create or modify an association between two objects.
*
* @param name name of association
* @param obj_id1 id of first object
* @param obj_id2 id of second object
* @param data (optional) extra string data to store
* @param assoc_time (optional) extra time data; default to creation time
* @error
* API_EC_DATA_DATABASE_ERROR
* API_EC_PARAM
* API_EC_PERMISSION
* API_EC_DATA_INVALID_OPERATION
* API_EC_DATA_QUOTA_EXCEEDED
* API_EC_DATA_UNKNOWN_ERROR
*/
public function data_setAssociation($name, $obj_id1, $obj_id2, $data = null,
$assoc_time = null) {
return $this->call_method
('facebook.data.setAssociation',
array('name' => $name,
'obj_id1' => $obj_id1,
'obj_id2' => $obj_id2,
'data' => $data,
'assoc_time' => $assoc_time));
}
/**
* Create or modify associations between objects.
*
* @param assocs associations to set
* @param name (optional) name of association
* @error
* API_EC_DATA_DATABASE_ERROR
* API_EC_PARAM
* API_EC_PERMISSION
* API_EC_DATA_INVALID_OPERATION
* API_EC_DATA_QUOTA_EXCEEDED
* API_EC_DATA_UNKNOWN_ERROR
*/
public function data_setAssociations($assocs, $name = null) {
return $this->call_method
('facebook.data.setAssociations',
array('assocs' => json_encode($assocs),
'name' => $name));
}
/**
* Remove an association between two objects.
*
* @param name name of association
* @param obj_id1 id of first object
* @param obj_id2 id of second object
* @error
* API_EC_DATA_DATABASE_ERROR
* API_EC_DATA_OBJECT_NOT_FOUND
* API_EC_PARAM
* API_EC_PERMISSION
* API_EC_DATA_QUOTA_EXCEEDED
* API_EC_DATA_UNKNOWN_ERROR
*/
public function data_removeAssociation($name, $obj_id1, $obj_id2) {
return $this->call_method
('facebook.data.removeAssociation',
array('obj_id1' => $obj_id1,
'obj_id2' => $obj_id2));
}
/**
* Remove associations between objects by specifying pairs of object ids.
*
* @param assocs associations to remove
* @param name (optional) name of association
* @error
* API_EC_DATA_DATABASE_ERROR
* API_EC_DATA_OBJECT_NOT_FOUND
* API_EC_PARAM
* API_EC_PERMISSION
* API_EC_DATA_QUOTA_EXCEEDED
* API_EC_DATA_UNKNOWN_ERROR
*/
public function data_removeAssociations($assocs, $name = null) {
return $this->call_method
('facebook.data.removeAssociations',
array('assocs' => json_encode($assocs),
'name' => $name));
}
/**
* Remove associations between objects by specifying one object id.
*
* @param name name of association
* @param obj_id who's association to remove
* @error
* API_EC_DATA_DATABASE_ERROR
* API_EC_DATA_OBJECT_NOT_FOUND
* API_EC_PARAM
* API_EC_PERMISSION
* API_EC_DATA_INVALID_OPERATION
* API_EC_DATA_QUOTA_EXCEEDED
* API_EC_DATA_UNKNOWN_ERROR
*/
public function data_removeAssociatedObjects($name, $obj_id) {
return $this->call_method
('facebook.data.removeAssociatedObjects',
array('name' => $name,
'obj_id' => $obj_id));
}
/**
* Retrieve a list of associated objects.
*
* @param name name of association
* @param obj_id who's association to retrieve
* @param no_data only return object ids
* @return associated objects
* @error
* API_EC_DATA_DATABASE_ERROR
* API_EC_DATA_OBJECT_NOT_FOUND
* API_EC_PARAM
* API_EC_PERMISSION
* API_EC_DATA_INVALID_OPERATION
* API_EC_DATA_QUOTA_EXCEEDED
* API_EC_DATA_UNKNOWN_ERROR
*/
public function data_getAssociatedObjects($name, $obj_id, $no_data = true) {
return $this->call_method
('facebook.data.getAssociatedObjects',
array('obj_id' => $obj_id,
'no_data' => $no_data));
}
/**
* Count associated objects.
*
* @param name name of association
* @param obj_id who's association to retrieve
* @return associated object's count
* @error
* API_EC_DATA_DATABASE_ERROR
* API_EC_DATA_OBJECT_NOT_FOUND
* API_EC_PARAM
* API_EC_PERMISSION
* API_EC_DATA_INVALID_OPERATION
* API_EC_DATA_QUOTA_EXCEEDED
* API_EC_DATA_UNKNOWN_ERROR
*/
public function data_getAssociatedObjectCount($name, $obj_id) {
return $this->call_method
('facebook.data.getAssociatedObjectCount',
array('name' => $name,
'obj_id' => $obj_id));
}
/**
* Get a list of associated object counts.
*
* @param name name of association
* @param obj_ids whose association to retrieve
* @return associated object counts
* @error
* API_EC_DATA_DATABASE_ERROR
* API_EC_DATA_OBJECT_NOT_FOUND
* API_EC_PARAM
* API_EC_PERMISSION
* API_EC_DATA_INVALID_OPERATION
* API_EC_DATA_QUOTA_EXCEEDED
* API_EC_DATA_UNKNOWN_ERROR
*/
public function data_getAssociatedObjectCounts($name, $obj_ids) {
return $this->call_method
('facebook.data.getAssociatedObjectCounts',
array('name' => $name,
'obj_ids' => json_encode($obj_ids)));
}
/**
* Find all associations between two objects.
*
* @param obj_id1 id of first object
* @param obj_id2 id of second object
* @param no_data only return association names without data
* @return all associations between objects
* @error
* API_EC_DATA_DATABASE_ERROR
* API_EC_PARAM
* API_EC_PERMISSION
* API_EC_DATA_QUOTA_EXCEEDED
* API_EC_DATA_UNKNOWN_ERROR
*/
public function data_getAssociations($obj_id1, $obj_id2, $no_data = true) {
return $this->call_method
('facebook.data.getAssociations',
array('obj_id1' => $obj_id1,
'obj_id2' => $obj_id2,
'no_data' => $no_data));
}
/* UTILITY FUNCTIONS */
public function call_method($method, $params) {
if ($this->json) {
$json = $this->post_request($method, $params);
# XXX: silly facebook with its invalid JSON
$valid = preg_match('/^[\[{].*[\]}]$/', $json);
$array = json_decode($valid ? $json : "[$json]", true);
$result = $valid ? $array : $array[0];
} else {
$xml = $this->post_request($method, $params);
$sxml = simplexml_load_string($xml);
$result = self::convert_simplexml_to_array($sxml);
if ($GLOBALS['facebook_config']['debug']) {
// output the raw xml and its corresponding php object, for debugging:
print '
';
$this->cur_id++;
print $this->cur_id . ': Called ' . $method . ', show ' .
'
Params | '.
'
XML | '.
'
SXML | '.
'
PHP';
print '
'.print_r($params, true).'
';
print '
'.htmlspecialchars($xml).'
';
print '
'.print_r($result, true).'
';
print '
'.print_r($sxml, true).'
';
print '
';
}
}
if (is_array($result) && isset($result['error_code'])) {
throw new FacebookRestClientException($result['error_msg'], $result['error_code']);
}
return $result;
}
public function post_request($method, $params) {
$params['method'] = $method;
$params['session_key'] = $this->session_key;
$params['api_key'] = $this->api_key;
$params['call_id'] = microtime(true);
if ($params['call_id'] <= $this->last_call_id) {
$params['call_id'] = $this->last_call_id + 0.001;
}
$this->last_call_id = $params['call_id'];
if (!isset($params['v'])) {
$params['v'] = '1.0';
}
if ($this->json)
$params['format'] = 'JSON';
$post_params = array();
foreach ($params as $key => &$val) {
if (is_array($val)) $val = implode(',', $val);
$post_params[] = $key.'='.urlencode($val);
}
$post_params[] = 'sig='.Facebook::generate_sig($params, $this->secret);
$post_string = implode('&', $post_params);
if ($this->json) {
$result = file_get_contents($this->server_addr, false, stream_context_create(
array('http' =>
array('method' => 'POST',
'header' => 'Content-type: application/x-www-form-urlencoded'."\r\n".
'User-Agent: Facebook API PHP5 Client 1.1 (non-curl) '.phpversion()."\r\n".
'Content-length: ' . strlen($post_string),
'content' => $post_string))));
} elseif (function_exists('curl_init')) {
// Use CURL if installed...
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $this->server_addr);
curl_setopt($ch, CURLOPT_POSTFIELDS, $post_string);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_USERAGENT, 'Facebook API PHP5 Client 1.1 (curl) ' . phpversion());
$result = curl_exec($ch);
curl_close($ch);
} else {
// Non-CURL based version...
$context =
array('http' =>
array('method' => 'POST',
'header' => 'Content-type: application/x-www-form-urlencoded'."\r\n".
'User-Agent: Facebook API PHP5 Client 1.1 (non-curl) '.phpversion()."\r\n".
'Content-length: ' . strlen($post_string),
'content' => $post_string));
$contextid=stream_context_create($context);
$sock=fopen($this->server_addr, 'r', false, $contextid);
if ($sock) {
$result='';
while (!feof($sock))
$result.=fgets($sock, 4096);
fclose($sock);
}
}
return $result;
}
public static function convert_simplexml_to_array($sxml) {
$arr = array();
if ($sxml) {
foreach ($sxml as $k => $v) {
if ($sxml['list']) {
$arr[] = self::convert_simplexml_to_array($v);
} else {
$arr[$k] = self::convert_simplexml_to_array($v);
}
}
}
if (sizeof($arr) > 0) {
return $arr;
} else {
return (string)$sxml;
}
}
}
class FacebookRestClientException extends Exception {
}
// Supporting methods and values------
/**
* Error codes and descriptions for the Facebook API.
*/
class FacebookAPIErrorCodes {
const API_EC_SUCCESS = 0;
/*
* GENERAL ERRORS
*/
const API_EC_UNKNOWN = 1;
const API_EC_SERVICE = 2;
const API_EC_METHOD = 3;
const API_EC_TOO_MANY_CALLS = 4;
const API_EC_BAD_IP = 5;
/*
* PARAMETER ERRORS
*/
const API_EC_PARAM = 100;
const API_EC_PARAM_API_KEY = 101;
const API_EC_PARAM_SESSION_KEY = 102;
const API_EC_PARAM_CALL_ID = 103;
const API_EC_PARAM_SIGNATURE = 104;
const API_EC_PARAM_USER_ID = 110;
const API_EC_PARAM_USER_FIELD = 111;
const API_EC_PARAM_SOCIAL_FIELD = 112;
const API_EC_PARAM_ALBUM_ID = 120;
/*
* USER PERMISSIONS ERRORS
*/
const API_EC_PERMISSION = 200;
const API_EC_PERMISSION_USER = 210;
const API_EC_PERMISSION_ALBUM = 220;
const API_EC_PERMISSION_PHOTO = 221;
const FQL_EC_PARSER = 601;
const FQL_EC_UNKNOWN_FIELD = 602;
const FQL_EC_UNKNOWN_TABLE = 603;
const FQL_EC_NOT_INDEXABLE = 604;
/**
* DATA STORE API ERRORS
*/
const API_EC_DATA_UNKNOWN_ERROR = 800;
const API_EC_DATA_INVALID_OPERATION = 801;
const API_EC_DATA_QUOTA_EXCEEDED = 802;
const API_EC_DATA_OBJECT_NOT_FOUND = 803;
const API_EC_DATA_OBJECT_ALREADY_EXISTS = 804;
const API_EC_DATA_DATABASE_ERROR = 805;
public static $api_error_descriptions = array(
API_EC_SUCCESS => 'Success',
API_EC_UNKNOWN => 'An unknown error occurred',
API_EC_SERVICE => 'Service temporarily unavailable',
API_EC_METHOD => 'Unknown method',
API_EC_TOO_MANY_CALLS => 'Application request limit reached',
API_EC_BAD_IP => 'Unauthorized source IP address',
API_EC_PARAM => 'Invalid parameter',
API_EC_PARAM_API_KEY => 'Invalid API key',
API_EC_PARAM_SESSION_KEY => 'Session key invalid or no longer valid',
API_EC_PARAM_CALL_ID => 'Call_id must be greater than previous',
API_EC_PARAM_SIGNATURE => 'Incorrect signature',
API_EC_PARAM_USER_ID => 'Invalid user id',
API_EC_PARAM_USER_FIELD => 'Invalid user info field',
API_EC_PARAM_SOCIAL_FIELD => 'Invalid user field',
API_EC_PARAM_ALBUM_ID => 'Invalid album id',
API_EC_PERMISSION => 'Permissions error',
API_EC_PERMISSION_USER => 'User not visible',
API_EC_PERMISSION_ALBUM => 'Album not visible',
API_EC_PERMISSION_PHOTO => 'Photo not visible',
FQL_EC_PARSER => 'FQL: Parser Error',
FQL_EC_UNKNOWN_FIELD => 'FQL: Unknown Field',
FQL_EC_UNKNOWN_TABLE => 'FQL: Unknown Table',
FQL_EC_NOT_INDEXABLE => 'FQL: Statement not indexable',
FQL_EC_UNKNOWN_FUNCTION => 'FQL: Attempted to call unknown function',
FQL_EC_INVALID_PARAM => 'FQL: Invalid parameter passed in',
API_EC_DATA_UNKNOWN_ERROR => 'Unknown data store API error',
API_EC_DATA_INVALID_OPERATION => 'Invalid operation',
API_EC_DATA_QUOTA_EXCEEDED => 'Data store allowable quota was exceeded',
API_EC_DATA_OBJECT_NOT_FOUND => 'Specified object cannot be found',
API_EC_DATA_OBJECT_ALREADY_EXISTS => 'Specified object already exists',
API_EC_DATA_DATABASE_ERROR => 'A database error occurred. Please try again',
);
}
$profile_field_array = array(
"about_me",
"activities",
"affiliations",
"birthday",
"books",
"current_location",
"education_history",
"first_name",
"hometown_location",
"hs_info",
"interests",
"is_app_user",
"last_name",
"meeting_for",
"meeting_sex",
"movies",
"music",
"name",
"notes_count",
"pic",
"pic_big",
"pic_small",
"political",
"profile_update_time",
"quotes",
"relationship_status",
"religion",
"sex",
"significant_other_id",
"status",
"timezone",
"tv",
"wall_count",
"work_history");
?>