-
Notifications
You must be signed in to change notification settings - Fork 0
/
event.php
523 lines (481 loc) · 16.2 KB
/
event.php
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
<?php
/**
* @package Joomla.Platform
* @subpackage Facebook
*
* @copyright Copyright (C) 2005 - 2012 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die();
/**
* Facebook API User class for the Joomla Platform.
*
* @package Joomla.Platform
* @subpackage Facebook
*
* @see http://developers.facebook.com/docs/reference/api/event/
* @since 13.1
*/
class JFacebookEvent extends JFacebookObject
{
/**
* Method to get information about an event visible to the current user. Requires authentication.
*
* @param string $event The event id.
*
* @return mixed The decoded JSON response or false if the client is not authenticated.
*
* @since 13.1
*/
public function getEvent($event)
{
return $this->get($event);
}
/**
* Method to get the event's wall. Requires authentication.
*
* @param string $event The event id.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
* @param string $until A unix timestamp or any date accepted by strtotime.
* @param string $since A unix timestamp or any date accepted by strtotime.
*
* @return mixed The decoded JSON response or false if the client is not authenticated.
*
* @since 13.1
*/
public function getFeed($event, $limit = 0, $offset = 0, $until = null, $since = null)
{
return $this->getConnection($event, 'feed', '', $limit, $offset, $until, $since);
}
/**
* Method to post a link on event's feed which the current_user is or maybe attending. Requires authentication and publish_stream permission.
*
* @param string $event The event id.
* @param string $link Link URL.
* @param string $message Link message.
*
* @return mixed The decoded JSON response or false if the client is not authenticated.
*
* @since 13.1
*/
public function createLink($event, $link, $message = null)
{
// Set POST request parameters.
$data = array();
$data['link'] = $link;
$data['message'] = $message;
return $this->createConnection($event, 'feed', $data);
}
/**
* Method to delete a link. Requires authentication and publish_stream permission.
*
* @param mixed $link The Link ID.
*
* @return boolean Returns true if successful, and false otherwise.
*
* @since 13.1
*/
public function deleteLink($link)
{
return $this->deleteConnection($link);
}
/**
* Method to post on event's wall. Message or link parameter is required. Requires authentication and publish_stream permission.
*
* @param string $event The event id.
* @param string $message Post message.
* @param string $link Post URL.
* @param string $picture Post thumbnail image (can only be used if link is specified)
* @param string $name Post name (can only be used if link is specified).
* @param string $caption Post caption (can only be used if link is specified).
* @param string $description Post description (can only be used if link is specified).
* @param array $actions Post actions array of objects containing name and link.
*
* @return mixed The decoded JSON response or false if the client is not authenticated.
*
* @since 13.1
*/
public function createPost($event, $message = null, $link = null, $picture = null, $name = null, $caption = null,
$description = null, $actions = null)
{
// Set POST request parameters.
$data = array();
$data['message'] = $message;
$data['link'] = $link;
$data['name'] = $name;
$data['caption'] = $caption;
$data['description'] = $description;
$data['actions'] = $actions;
$data['picture'] = $picture;
return $this->createConnection($event, 'feed', $data);
}
/**
* Method to delete a post. Note: you can only delete the post if it was created by the current user.
* Requires authentication and publish_stream permission.
*
* @param string $post The Post ID.
*
* @return boolean Returns true if successful, and false otherwise.
*
* @since 13.1
*/
public function deletePost($post)
{
return $this->deleteConnection($post);
}
/**
* Method to post a status message on behalf of the user on the event's wall. Requires authentication and publish_stream permission.
*
* @param string $event The event id.
* @param string $message Status message content.
*
* @return mixed The decoded JSON response or false if the client is not authenticated.
*
* @since 13.1
*/
public function createStatus($event, $message)
{
// Set POST request parameters.
$data = array();
$data['message'] = $message;
return $this->createConnection($event, 'feed', $data);
}
/**
* Method to delete a status. Note: you can only delete the post if it was created by the current user.
* Requires authentication and publish_stream permission.
*
* @param string $status The Status ID.
*
* @return boolean Returns true if successful, and false otherwise.
*
* @since 13.1
*/
public function deleteStatus($status)
{
return $this->deleteConnection($status);
}
/**
* Method to get the list of invitees for the event. Requires authentication and user_events or friends_events permission.
*
* @param string $event The event id.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
*
* @return mixed The decoded JSON response or false if the client is not authenticated.
*
* @since 13.1
*/
public function getInvited($event, $limit = 0, $offset = 0)
{
return $this->getConnection($event, 'invited', '', $limit, $offset);
}
/**
* Method to check if a user is invited to the event. Requires authentication and user_events or friends_events permission.
*
* @param string $event The event id.
* @param mixed $user Either an integer containing the user ID or a string containing the username.
*
* @return array The decoded JSON response or an empty array if the user is not invited.
*
* @since 13.1
*/
public function isInvited($event, $user)
{
return $this->getConnection($event, 'invited/' . $user);
}
/**
* Method to invite users to the event. Requires authentication and create_event permission.
*
* @param string $event The event id.
* @param string $users Comma separated list of user ids.
*
* @return boolean Returns true if successful, and false otherwise.
*
* @since 13.1
*/
public function createInvite($event, $users)
{
// Set POST request parameters.
$data = array();
$data['users'] = $users;
return $this->createConnection($event, 'invited', $data);
}
/**
* Method to delete a invitation. Note: you can only delete the invite if the current user is the event admin.
* Requires authentication and rsvp_event permission.
*
* @param string $event The event id.
* @param string $user The user id.
*
* @return boolean Returns true if successful, and false otherwise.
*
* @since 13.1
*/
public function deleteInvite($event, $user)
{
return $this->deleteConnection($event, 'invited/' . $user);
}
/**
* Method to get the list of attending users. Requires authentication and user_events or friends_events permission.
*
* @param string $event The event id.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
*
* @return mixed The decoded JSON response or false if the client is not authenticated.
*
* @since 13.1
*/
public function getAttending($event, $limit = 0, $offset = 0)
{
return $this->getConnection($event, 'attending', '', $limit, $offset);
}
/**
* Method to check if a user is attending an event. Requires authentication and user_events or friends_events permission.
*
* @param string $event The event id.
* @param mixed $user Either an integer containing the user ID or a string containing the username.
*
* @return array The decoded JSON response or an empty array if the user is not invited.
*
* @since 13.1
*/
public function isAttending($event, $user)
{
return $this->getConnection($event, 'attending/' . $user);
}
/**
* Method to set the current user as attending. Requires authentication and rsvp_event permission.
*
* @param string $event The event id.
*
* @return boolean Returns true if successful, and false otherwise.
*
* @since 13.1
*/
public function createAttending($event)
{
return $this->createConnection($event, 'attending');
}
/**
* Method to get the list of maybe attending users. Requires authentication and user_events or friends_events permission.
*
* @param string $event The event id.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
*
* @return mixed The decoded JSON response or false if the client is not authenticated.
*
* @since 13.1
*/
public function getMaybe($event, $limit = 0, $offset = 0)
{
return $this->getConnection($event, 'maybe', '', $limit, $offset);
}
/**
* Method to check if a user is maybe attending an event. Requires authentication and user_events or friends_events permission.
*
* @param string $event The event id.
* @param mixed $user Either an integer containing the user ID or a string containing the username.
*
* @return array The decoded JSON response or an empty array if the user is not invited.
*
* @since 13.1
*/
public function isMaybe($event, $user)
{
return $this->getConnection($event, 'maybe/' . $user);
}
/**
* Method to set the current user as maybe attending. Requires authentication and rscp_event permission.
*
* @param string $event The event id.
*
* @return boolean Returns true if successful, and false otherwise.
*
* @since 13.1
*/
public function createMaybe($event)
{
return $this->createConnection($event, 'maybe');
}
/**
* Method to get the list of users which declined the event. Requires authentication and user_events or friends_events permission.
*
* @param string $event The event id.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
*
* @return mixed The decoded JSON response or false if the client is not authenticated.
*
* @since 13.1
*/
public function getDeclined($event, $limit = 0, $offset = 0)
{
return $this->getConnection($event, 'declined', '', $limit, $offset);
}
/**
* Method to check if a user responded 'no' to the event. Requires authentication and user_events or friends_events permission.
*
* @param string $event The event id.
* @param mixed $user Either an integer containing the user ID or a string containing the username.
*
* @return array The decoded JSON response or an empty array if the user is not invited.
*
* @since 13.1
*/
public function isDeclined($event, $user)
{
return $this->getConnection($event, 'declined/' . $user);
}
/**
* Method to set the current user as declined. Requires authentication and rscp_event permission.
*
* @param string $event The event id.
*
* @return boolean Returns true if successful, and false otherwise.
*
* @since 13.1
*/
public function createDeclined($event)
{
return $this->createConnection($event, 'declined');
}
/**
* Method to get the list of users which have not replied to the event. Requires authentication and user_events or friends_events permission.
*
* @param string $event The event id.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
*
* @return mixed The decoded JSON response or false if the client is not authenticated.
*
* @since 13.1
*/
public function getNoreply($event, $limit = 0, $offset = 0)
{
return $this->getConnection($event, 'noreply', '', $limit, $offset);
}
/**
* Method to check if a user has not replied to the event. Requires authentication and user_events or friends_events permission.
*
* @param string $event The event id.
* @param mixed $user Either an integer containing the user ID or a string containing the username.
*
* @return array The decoded JSON response or an empty array if the user is not invited.
*
* @since 13.1
*/
public function isNoreply($event, $user)
{
return $this->getConnection($event, 'noreply/' . $user);
}
/**
* Method to get the event's profile picture. Requires authentication and user_events or friends_events permission.
*
* @param string $event The event id.
* @param boolean $redirect If false this will return the URL of the picture without a 302 redirect.
* @param string $type To request a different photo use square | small | normal | large.
*
* @return string The URL to the event's profile picture.
*
* @since 13.1
*/
public function getPicture($event, $redirect = true, $type = null)
{
$extra_fields = '';
if ($redirect == false)
{
$extra_fields = '?redirect=false';
}
if ($type)
{
$extra_fields .= (strpos($extra_fields, '?') === false) ? '?type=' . $type : '&type=' . $type;
}
return $this->getConnection($event, 'picture', $extra_fields);
}
/**
* Method to get photos published on event's wall. Requires authentication.
*
* @param string $event The event id.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
* @param string $until A unix timestamp or any date accepted by strtotime.
* @param string $since A unix timestamp or any date accepted by strtotime.
*
* @return mixed The decoded JSON response or false if the client is not authenticated.
*
* @since 13.1
*/
public function getPhotos($event, $limit = 0, $offset = 0, $until = null, $since = null)
{
return $this->getConnection($event, 'photos', '', $limit, $offset, $until, $since);
}
/**
* Method to post a photo on event's wall. Requires authentication and publish_stream permission.
*
* @param string $event The event id.
* @param string $source Path to photo.
* @param string $message Photo description.
*
* @return mixed The decoded JSON response or false if the client is not authenticated.
*
* @since 13.1
*/
public function createPhoto($event, $source, $message = null)
{
// Set POST request parameters.
$data = array();
$data[basename($source)] = '@' . realpath($source);
if ($message)
{
$data['message'] = $message;
}
return $this->createConnection($event, 'photos', $data, array('Content-Type' => 'multipart/form-data'));
}
/**
* Method to get videos published on event's wall. Requires authentication.
*
* @param string $event The event id.
* @param integer $limit The number of objects per page.
* @param integer $offset The object's number on the page.
* @param string $until A unix timestamp or any date accepted by strtotime.
* @param string $since A unix timestamp or any date accepted by strtotime.
*
* @return mixed The decoded JSON response or false if the client is not authenticated.
*
* @since 13.1
*/
public function getVideos($event, $limit = 0, $offset = 0, $until = null, $since = null)
{
return $this->getConnection($event, 'videos', '', $limit, $offset, $until, $since);
}
/**
* Method to post a video on event's wall. Requires authentication and publish_stream permission.
*
* @param string $event The event id.
* @param string $source Path to photo.
* @param string $title Video title.
* @param string $description Video description.
*
* @return mixed The decoded JSON response or false if the client is not authenticated.
*
* @since 13.1
*/
public function createVideo($event, $source, $title = null, $description = null)
{
// Set POST request parameters.
$data = array();
$data[basename($source)] = '@' . realpath($source);
if ($title)
{
$data['title'] = $title;
}
if ($description)
{
$data['description'] = $description;
}
return $this->createConnection($event, 'videos', $data, array('Content-Type' => 'multipart/form-data'));
}
}