statuses.php
21.3 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
<?php
/**
* @package Joomla.Platform
* @subpackage Twitter
*
* @copyright Copyright (C) 2005 - 2019 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die();
/**
* Twitter API Statuses class for the Joomla Platform.
*
* @since 3.1.4
* @deprecated 4.0 Use the `joomla/twitter` package via Composer instead
*/
class JTwitterStatuses extends JTwitterObject
{
/**
* Method to get a single tweet with the given ID.
*
* @param integer $id The ID of the tweet to retrieve.
* @param boolean $trim_user When set to true, each tweet returned in a timeline will include a user object including only
* the status author's numerical ID.
* @param boolean $entities When set to true, each tweet will include a node called "entities,". This node offers a variety of metadata
* about the tweet in a discreet structure, including: user_mentions, urls, and hashtags.
* @param boolean $my_retweet When set to either true, t or 1, any statuses returned that have been retweeted by the authenticating user will
* include an additional current_user_retweet node, containing the ID of the source status for the retweet.
*
* @return array The decoded JSON response
*
* @since 3.1.4
*/
public function getTweetById($id, $trim_user = null, $entities = null, $my_retweet = null)
{
// Check the rate limit for remaining hits
$this->checkRateLimit('statuses', 'show/:id');
// Set the API base
$path = '/statuses/show/' . $id . '.json';
$data = array();
// Check if trim_user is specified
if (!is_null($trim_user))
{
$data['trim_user'] = $trim_user;
}
// Check if entities is specified
if (!is_null($entities))
{
$data['include_entities'] = $entities;
}
// Check if my_retweet is specified
if (!is_null($my_retweet))
{
$data['include_my_retweet'] = $my_retweet;
}
// Send the request.
return $this->sendRequest($path, 'GET', $data);
}
/**
* Method to retrieve the latest statuses from the specified user timeline.
*
* @param mixed $user Either an integer containing the user ID or a string containing the screen name.
* @param integer $count Specifies the number of tweets to try and retrieve, up to a maximum of 200. Retweets are always included
* in the count, so it is always suggested to set $include_rts to true
* @param boolean $include_rts When set to true, the timeline will contain native retweets in addition to the standard stream of tweets.
* @param boolean $no_replies This parameter will prevent replies from appearing in the returned timeline. This parameter is only supported
* for JSON and XML responses.
* @param integer $since_id Returns results with an ID greater than (that is, more recent than) the specified ID.
* @param integer $max_id Returns results with an ID less than (that is, older than) the specified ID.
* @param boolean $trim_user When set to true, each tweet returned in a timeline will include a user object including only
* the status author's numerical ID.
* @param boolean $contributor This parameter enhances the contributors element of the status response to include the screen_name of the
* contributor. By default only the user_id of the contributor is included.
*
* @return array The decoded JSON response
*
* @since 3.1.4
* @throws RuntimeException
*/
public function getUserTimeline($user, $count = 20, $include_rts = null, $no_replies = null, $since_id = 0, $max_id = 0, $trim_user = null,
$contributor = null)
{
// Check the rate limit for remaining hits
$this->checkRateLimit('statuses', 'user_timeline');
$data = array();
// Determine which type of data was passed for $user
if (is_numeric($user))
{
$data['user_id'] = $user;
}
elseif (is_string($user))
{
$data['screen_name'] = $user;
}
else
{
// We don't have a valid entry
throw new RuntimeException('The specified username is not in the correct format; must use integer or string');
}
// Set the API base
$path = '/statuses/user_timeline.json';
// Set the count string
$data['count'] = $count;
// Check if include_rts is specified
if (!is_null($include_rts))
{
$data['include_rts'] = $include_rts;
}
// Check if no_replies is specified
if (!is_null($no_replies))
{
$data['exclude_replies'] = $no_replies;
}
// Check if a since_id is specified
if ($since_id > 0)
{
$data['since_id'] = (int) $since_id;
}
// Check if a max_id is specified
if ($max_id > 0)
{
$data['max_id'] = (int) $max_id;
}
// Check if trim_user is specified
if (!is_null($trim_user))
{
$data['trim_user'] = $trim_user;
}
// Check if contributor details is specified
if (!is_null($contributor))
{
$data['contributor_details'] = $contributor;
}
// Send the request.
return $this->sendRequest($path, 'GET', $data);
}
/**
* Method to post a tweet.
*
* @param string $status The text of the tweet.
* @param integer $in_reply_to_status_id The ID of an existing status that the update is in reply to.
* @param float $lat The latitude of the location this tweet refers to.
* @param float $long The longitude of the location this tweet refers to.
* @param string $place_id A place in the world.
* @param boolean $display_coordinates Whether or not to put a pin on the exact coordinates a tweet has been sent from.
* @param boolean $trim_user When set to true, each tweet returned in a timeline will include a user object including only
* the status author's numerical ID.
*
* @return array The decoded JSON response
*
* @since 3.1.4
*/
public function tweet($status, $in_reply_to_status_id = null, $lat = null, $long = null, $place_id = null, $display_coordinates = null,
$trim_user = null)
{
// Set the API base.
$path = '/statuses/update.json';
// Set POST data.
$data = array('status' => utf8_encode($status));
// Check if in_reply_to_status_id is specified.
if ($in_reply_to_status_id)
{
$data['in_reply_to_status_id'] = $in_reply_to_status_id;
}
// Check if lat is specified.
if ($lat)
{
$data['lat'] = $lat;
}
// Check if long is specified.
if ($long)
{
$data['long'] = $long;
}
// Check if place_id is specified.
if ($place_id)
{
$data['place_id'] = $place_id;
}
// Check if display_coordinates is specified.
if (!is_null($display_coordinates))
{
$data['display_coordinates'] = $display_coordinates;
}
// Check if trim_user is specified.
if (!is_null($trim_user))
{
$data['trim_user'] = $trim_user;
}
// Send the request.
return $this->sendRequest($path, 'POST', $data);
}
/**
* Method to retrieve the most recent mentions for the authenticating user.
*
* @param integer $count Specifies the number of tweets to try and retrieve, up to a maximum of 200. Retweets are always included
* in the count, so it is always suggested to set $include_rts to true
* @param boolean $include_rts When set to true, the timeline will contain native retweets in addition to the standard stream of tweets.
* @param boolean $entities When set to true, each tweet will include a node called "entities,". This node offers a variety of metadata
* about the tweet in a discreet structure, including: user_mentions, urls, and hashtags.
* @param integer $since_id Returns results with an ID greater than (that is, more recent than) the specified ID.
* @param integer $max_id Returns results with an ID less than (that is, older than) the specified ID.
* @param boolean $trim_user When set to true, each tweet returned in a timeline will include a user object including only
* the status author's numerical ID.
* @param string $contributor This parameter enhances the contributors element of the status response to include the screen_name
* of the contributor.
*
* @return array The decoded JSON response
*
* @since 3.1.4
* @throws RuntimeException
*/
public function getMentions($count = 20, $include_rts = null, $entities = null, $since_id = 0, $max_id = 0,
$trim_user = null, $contributor = null)
{
// Check the rate limit for remaining hits
$this->checkRateLimit('statuses', 'mentions_timeline');
// Set the API base
$path = '/statuses/mentions_timeline.json';
// Set the count string
$data['count'] = $count;
// Check if include_rts is specified
if (!is_null($include_rts))
{
$data['include_rts'] = $include_rts;
}
// Check if entities is specified
if (!is_null($entities))
{
$data['include_entities'] = $entities;
}
// Check if a since_id is specified
if ($since_id > 0)
{
$data['since_id'] = (int) $since_id;
}
// Check if a max_id is specified
if ($max_id > 0)
{
$data['max_id'] = (int) $max_id;
}
// Check if trim_user is specified
if (!is_null($trim_user))
{
$data['trim_user'] = $trim_user;
}
// Check if contributor is specified
if (!is_null($contributor))
{
$data['contributor_details'] = $contributor;
}
// Send the request.
return $this->sendRequest($path, 'GET', $data);
}
/**
* Method to get the most recent tweets of the authenticated user that have been retweeted by others.
*
* @param integer $count Specifies the number of tweets to try and retrieve, up to a maximum of 200. Retweets are always included
* in the count, so it is always suggested to set $include_rts to true
* @param integer $since_id Returns results with an ID greater than (that is, more recent than) the specified ID.
* @param boolean $entities When set to true, each tweet will include a node called "entities,". This node offers a variety of metadata
* about the tweet in a discreet structure, including: user_mentions, urls, and hashtags.
* @param boolean $user_entities The user entities node will be disincluded when set to false.
* @param integer $max_id Returns results with an ID less than (that is, older than) the specified ID.
* @param boolean $trim_user When set to true, each tweet returned in a timeline will include a user object including only
* the status author's numerical ID.
*
* @return array The decoded JSON response
*
* @since 3.1.4
*/
public function getRetweetsOfMe($count = 20, $since_id = 0, $entities = null, $user_entities = null, $max_id = 0, $trim_user = null)
{
// Check the rate limit for remaining hits
$this->checkRateLimit('statuses', 'retweets_of_me');
// Set the API path
$path = '/statuses/retweets_of_me.json';
// Set the count string
$data['count'] = $count;
// Check if a since_id is specified
if ($since_id > 0)
{
$data['since_id'] = (int) $since_id;
}
// Check if a max_id is specified
if ($max_id > 0)
{
$data['max_id'] = (int) $max_id;
}
// Check if trim_user is specified
if (!is_null($trim_user))
{
$data['trim_user'] = $trim_user;
}
// Check if entities is specified
if (!is_null($entities))
{
$data['include_entities'] = $entities;
}
// Check if entities is specified
if (!is_null($user_entities))
{
$data['include_user_entities'] = $user_entities;
}
// Send the request.
return $this->sendRequest($path, 'GET', $data);
}
/**
* Method to show user objects of up to 100 members who retweeted the status.
*
* @param integer $id The numerical ID of the desired status.
* @param integer $count Specifies the number of retweets to try and retrieve, up to a maximum of 100.
* @param integer $cursor Causes the list of IDs to be broken into pages of no more than 100 IDs at a time.
* The number of IDs returned is not guaranteed to be 100 as suspended users are
* filtered out after connections are queried. If no cursor is provided, a value of
* -1 will be assumed, which is the first "page."
* @param boolean $stringify_ids Set to true to return IDs as strings, false to return as integers.
*
* @return array The decoded JSON response
*
* @since 3.1.4
*/
public function getRetweeters($id, $count = 20, $cursor = null, $stringify_ids = null)
{
// Check the rate limit for remaining hits
$this->checkRateLimit('statuses', 'retweeters/ids');
// Set the API path
$path = '/statuses/retweeters/ids.json';
// Set the status id.
$data['id'] = $id;
// Set the count string
$data['count'] = $count;
// Check if cursor is specified
if (!is_null($cursor))
{
$data['cursor'] = $cursor;
}
// Check if entities is specified
if (!is_null($stringify_ids))
{
$data['stringify_ids'] = $stringify_ids;
}
// Send the request.
return $this->sendRequest($path, 'GET', $data);
}
/**
* Method to get up to 100 of the first retweets of a given tweet.
*
* @param integer $id The numerical ID of the desired status.
* @param integer $count Specifies the number of tweets to try and retrieve, up to a maximum of 200. Retweets are always included
* in the count, so it is always suggested to set $include_rts to true
* @param boolean $trim_user When set to true, each tweet returned in a timeline will include a user object including only
* the status author's numerical ID.
*
* @return array The decoded JSON response
*
* @since 3.1.4
*/
public function getRetweetsById($id, $count = 20, $trim_user = null)
{
// Check the rate limit for remaining hits
$this->checkRateLimit('statuses', 'retweets/:id');
// Set the API path
$path = '/statuses/retweets/' . $id . '.json';
// Set the count string
$data['count'] = $count;
// Check if trim_user is specified
if (!is_null($trim_user))
{
$data['trim_user'] = $trim_user;
}
// Send the request.
return $this->sendRequest($path, 'GET', $data);
}
/**
* Method to delete the status specified by the required ID parameter.
*
* @param integer $id The numerical ID of the desired status.
* @param boolean $trim_user When set to true, each tweet returned in a timeline will include a user object including only
* the status author's numerical ID.
*
* @return array The decoded JSON response
*
* @since 3.1.4
*/
public function deleteTweet($id, $trim_user = null)
{
// Set the API path
$path = '/statuses/destroy/' . $id . '.json';
$data = array();
// Check if trim_user is specified
if (!is_null($trim_user))
{
$data['trim_user'] = $trim_user;
}
// Send the request.
return $this->sendRequest($path, 'POST', $data);
}
/**
* Method to retweet a tweet.
*
* @param integer $id The numerical ID of the desired status.
* @param boolean $trim_user When set to true, each tweet returned in a timeline will include a user object including only
* the status author's numerical ID.
*
* @return array The decoded JSON response
*
* @since 3.1.4
*/
public function retweet($id, $trim_user = null)
{
// Set the API path
$path = '/statuses/retweet/' . $id . '.json';
$data = array();
// Check if trim_user is specified
if (!is_null($trim_user))
{
$data['trim_user'] = $trim_user;
}
// Send the request.
return $this->sendRequest($path, 'POST', $data);
}
/**
* Method to post a tweet with media.
*
* @param string $status The text of the tweet.
* @param string $media File to upload
* @param integer $in_reply_to_status_id The ID of an existing status that the update is in reply to.
* @param float $lat The latitude of the location this tweet refers to.
* @param float $long The longitude of the location this tweet refers to.
* @param string $place_id A place in the world.
* @param boolean $display_coordinates Whether or not to put a pin on the exact coordinates a tweet has been sent from.
* @param boolean $sensitive Set to true for content which may not be suitable for every audience.
*
* @return array The decoded JSON response
*
* @since 3.1.4
* @throws RuntimeException
*/
public function tweetWithMedia($status, $media, $in_reply_to_status_id = null, $lat = null, $long = null, $place_id = null,
$display_coordinates = null, $sensitive = null)
{
// Set the API request path.
$path = '/statuses/update_with_media.json';
// Set POST data.
$data = array(
'status' => utf8_encode($status),
'media[]' => "@{$media}",
);
$header = array('Content-Type' => 'multipart/form-data');
// Check if in_reply_to_status_id is specified.
if (!is_null($in_reply_to_status_id))
{
$data['in_reply_to_status_id'] = $in_reply_to_status_id;
}
// Check if lat is specified.
if ($lat)
{
$data['lat'] = $lat;
}
// Check if long is specified.
if ($long)
{
$data['long'] = $long;
}
// Check if place_id is specified.
if ($place_id)
{
$data['place_id'] = $place_id;
}
// Check if display_coordinates is specified.
if (!is_null($display_coordinates))
{
$data['display_coordinates'] = $display_coordinates;
}
// Check if sensitive is specified.
if (!is_null($sensitive))
{
$data['possibly_sensitive'] = $sensitive;
}
// Send the request.
return $this->sendRequest($path, 'POST', $data, $header);
}
/**
* Method to get information allowing the creation of an embedded representation of a Tweet on third party sites.
* Note: either the id or url parameters must be specified in a request. It is not necessary to include both.
*
* @param integer $id The Tweet/status ID to return embed code for.
* @param string $url The URL of the Tweet/status to be embedded.
* @param integer $maxwidth The maximum width in pixels that the embed should be rendered at. This value is constrained to be
* between 250 and 550 pixels.
* @param boolean $hide_media Specifies whether the embedded Tweet should automatically expand images which were uploaded via
* POST statuses/update_with_media.
* @param boolean $hide_thread Specifies whether the embedded Tweet should automatically show the original message in the case that
* the embedded Tweet is a reply.
* @param boolean $omit_script Specifies whether the embedded Tweet HTML should include a `<script>` element pointing to widgets.js.
* In cases where a page already includes widgets.js, setting this value to true will prevent a redundant
* script element from being included.
* @param string $align Specifies whether the embedded Tweet should be left aligned, right aligned, or centered in the page.
* Valid values are left, right, center, and none.
* @param string $related A value for the TWT related parameter, as described in Web Intents. This value will be forwarded to all
* Web Intents calls.
* @param string $lang Language code for the rendered embed. This will affect the text and localization of the rendered HTML.
*
* @return array The decoded JSON response
*
* @since 3.1.4
* @throws RuntimeException
*/
public function getOembed($id = null, $url = null, $maxwidth = null, $hide_media = null, $hide_thread = null, $omit_script = null,
$align = null, $related = null, $lang = null)
{
// Check the rate limit for remaining hits.
$this->checkRateLimit('statuses', 'oembed');
// Set the API request path.
$path = '/statuses/oembed.json';
// Determine which of $id and $url is specified.
if ($id)
{
$data['id'] = $id;
}
elseif ($url)
{
$data['url'] = rawurlencode($url);
}
else
{
// We don't have a valid entry.
throw new RuntimeException('Either the id or url parameters must be specified in a request.');
}
// Check if maxwidth is specified.
if ($maxwidth)
{
$data['maxwidth'] = $maxwidth;
}
// Check if hide_media is specified.
if (!is_null($hide_media))
{
$data['hide_media'] = $hide_media;
}
// Check if hide_thread is specified.
if (!is_null($hide_thread))
{
$data['hide_thread'] = $hide_thread;
}
// Check if omit_script is specified.
if (!is_null($omit_script))
{
$data['omit_script'] = $omit_script;
}
// Check if align is specified.
if ($align)
{
$data['align'] = $align;
}
// Check if related is specified.
if ($related)
{
$data['related'] = $related;
}
// Check if lang is specified.
if ($lang)
{
$data['lang'] = $lang;
}
// Send the request.
return $this->sendRequest($path, 'GET', $data);
}
}