-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathfacebookapi_php4_restlib.php
More file actions
1588 lines (1485 loc) · 53.2 KB
/
facebookapi_php4_restlib.php
File metadata and controls
1588 lines (1485 loc) · 53.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
//
// +---------------------------------------------------------------------------+
// | Facebook Platform PHP4 client |
// +---------------------------------------------------------------------------+
// | Copyright (c) 2007 Facebook, Inc. |
// | All rights reserved. |
// | |
// | Redistribution and use in source and binary forms, with or without |
// | modification, are permitted provided that the following conditions |
// | are met: |
// | |
// | 1. Redistributions of source code must retain the above copyright |
// | notice, this list of conditions and the following disclaimer. |
// | 2. Redistributions in binary form must reproduce the above copyright |
// | notice, this list of conditions and the following disclaimer in the |
// | documentation and/or other materials provided with the distribution. |
// | |
// | THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR |
// | IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
// | OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. |
// | IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, |
// | INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT |
// | NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
// | DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
// | THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
// | (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF |
// | THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
// +---------------------------------------------------------------------------+
// | For help with this library, contact developers-help@facebook.com |
// +---------------------------------------------------------------------------+
//
include_once 'simplexml44-0_4_4/class/IsterXmlSimpleXMLImpl.php';
class FacebookRestClient {
var $secret;
var $session_key;
var $api_key;
var $facebook;
var $error_code;
var $friends_list; // to save making the friends.get api call, this will get prepopulated on canvas pages
var $added; // to save making the users.isAppAdded api call, this will get prepopulated on canvas pages
/**
* Create the client.
* @param string $session_key if you haven't gotten a session key yet, leave
* this as null and then set it later by just
* directly accessing the $session_key member
* variable.
*/
function FacebookRestClient($api_key, $secret, &$facebook, $session_key=null) {
$this->secret = $secret;
$this->session_key = $session_key;
$this->api_key = $api_key;
$this->last_call_id = 0;
$this->facebook = &$facebook;
$this->error_code = 0;
$this->server_addr = $this->facebook->get_facebook_url('api') . '/restserver.php';
if ($GLOBALS['facebook_config']['debug']) {
$this->cur_id = 0;
?>
<script type="text/javascript">
var types = ['params', 'xml', 'php', 'sxml'];
function toggleDisplay(id, type) {
for each (var t in types) {
if (t != type || document.getElementById(t + id).style.display == 'block') {
document.getElementById(t + id).style.display = 'none';
} else {
document.getElementById(t + id).style.display = 'block';
}
}
return false;
}
</script>
<?php
}
}
/**
* Returns the session information available after current user logs in.
* @param string $auth_token the token returned by auth_createToken or
* passed back to your callback_url.
* @return assoc array containing session_key, uid
*/
function auth_getSession($auth_token) {
$result = $this->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
*/
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'
*/
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
*/
function fql_query($query) {
return $this->call_method('facebook.fql.query',
array('query' => $query));
}
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));
}
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));
}
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' => $title_data,
'body_template' => $body_template,
'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)
* ...)
*/
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
*/
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
*/
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
*/
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'
*/
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'
*/
function notifications_get() {
return $this->call_method('facebook.notifications.get', array());
}
/**
* Sends a notification to the specified users.
* @return (nothing)
*/
function notifications_send($to_ids, $notification) {
return $this->call_method('facebook.notifications.send',
array('to_ids' => $to_ids, 'notification' => $notification));
}
/**
* Sends an email to the specified user of the application.
* @param array $recipients : ids of the recipients
* @param string $subject : subject of the email
* @param string $text : (plain text) body of the email
* @param string $fbml : fbml markup if you want an html version of the email
* @return comma separated list of successful recipients
*/
function notifications_sendEmail($recipients, $subject, $text, $fbml) {
return $this->call_method('facebook.notifications.sendEmail',
array('recipients' => $recipients,
'subject' => $subject,
'text' => $text,
'fbml' => $fbml));
}
/**
* Returns the requested info fields for the requested set of pages
* @param array $page_ids an array of page ids
* @param array $fields an array of strings describing the info fields desired
* @param int $uid Optionally, limit results to pages of which this user is a fan.
* @param string type limits results to a particular type of page.
* @return array of pages
*/
function pages_getInfo($page_ids, $fields, $uid, $type) {
return $this->call_method('facebook.pages.getInfo', array('page_ids' => $page_ids, 'fields' => $fields, 'uid' => $uid, 'type' => $type));
}
/**
* Returns true if logged in user is an admin for the passed page
* @param int $page_id target page id
* @return boolean
*/
function pages_isAdmin($page_id) {
return $this->call_method('facebook.pages.isAdmin', array('page_id' => $page_id));
}
/**
* Returns whether or not the page corresponding to the current session object has the app installed
* @return boolean
*/
function pages_isAppAdded() {
if (isset($this->added)) {
return $this->added;
}
return $this->call_method('facebook.pages.isAppAdded', array());
}
/**
* Returns true if logged in user is a fan for the passed page
* @param int $page_id target page id
* @param int $uid user to compare. If empty, the logged in user.
* @return bool
*/
function pages_isFan($page_id, $uid) {
return $this->call_method('facebook.pages.isFan', array('page_id' => $page_id, 'uid' => $uid));
}
/**
* 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.
*/
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.
*/
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
*/
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
*/
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
*/
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
*/
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
* @param int $uid The user
* @param string $profile Profile FBML
* @param string $profile_action Profile action FBML
* @param string $mobile_profile Mobile profile FBML
* @return array A list of strings describing any compile errors for the submitted FBML
*/
function profile_setFBML($markup, $uid = null, $profile='', $profile_action='', $mobile_profile='') {
return $this->call_method('facebook.profile.setFBML', array('markup' => $markup,
'uid' => $uid,
'profile' => $profile,
'profile_action' => $profile_action,
'mobile_profile' => $mobile_profile));
}
function profile_getFBML($uid) {
return $this->call_method('facebook.profile.getFBML', array('uid' => $uid));
}
function fbml_refreshImgSrc($url) {
return $this->call_method('facebook.fbml.refreshImgSrc', array('url' => $url));
}
function fbml_refreshRefUrl($url) {
return $this->call_method('facebook.fbml.refreshRefUrl', array('url' => $url));
}
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,
'listing_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
*/
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
*/
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
*/
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
*/
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
*/
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
*/
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
*/
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
*/
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
*/
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
*/
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
*/
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
*/
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
*/
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
*/
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
*/
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
*/
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
*/
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
*/
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
*/
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
*/
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
*/
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
*/
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
*/
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