Docs For Class JTwitter

Description

Joomla Platform class for interacting with a Twitter API instance.

since: 12.3

Located in /libraries/joomla/twitter/twitter.php (line 19)

Variable Summary

JTwitterBlock $block

JHttp $client

JTwitterDirectMessages $directMessages

JTwitterFavorites $favorites

JTwitterFriends $friends

JTwitterHelp $help

JTwitterLists $lists

JTwitterOAuth $oauth

JRegistry $options

JTwitterPlaces $places

JTwitterProfile $profile

JTwitterSearch $search

JTwitterStatuses $statuses

JTwitterTrends $trends

JTwitterUsers $users

Method Summary

JTwitter __construct ([JTwitterOAuth $oauth = null], [JRegistry $options = null], [JHttp $client = null])

mixed getOption (string $key)

JTwitter setOption (string $key, mixed $value)

JTwitterObject __get (string $name)

Variables

JTwitterBlock $block (line 103)

var: Twitter API object for block.
since: 12.3
access: protected

JHttp $client (line 31)

var: The HTTP client object to use in sending HTTP requests.
since: 12.3
access: protected

JTwitterDirectMessages $directMessages (line 79)

var: Twitter API object for direct messages.
since: 12.3
access: protected

JTwitterFavorites $favorites (line 73)

var: Twitter API object for favorites.
since: 12.3
access: protected

JTwitterFriends $friends (line 43)

var: Twitter API object for friends.
since: 12.3
access: protected

JTwitterHelp $help (line 55)

var: Twitter API object for help.
since: 12.3
access: protected

JTwitterLists $lists (line 85)

var: Twitter API object for lists.
since: 12.3
access: protected

JTwitterOAuth $oauth (line 37)

var: The OAuth client.
since: 12.3
access: protected

JRegistry $options (line 25)

var: Options for the GitHub object.
since: 12.3
access: protected

JTwitterPlaces $places (line 91)

var: Twitter API object for places & geo.
since: 12.3
access: protected

JTwitterProfile $profile (line 109)

var: Twitter API object for profile.
since: 12.3
access: protected

JTwitterSearch $search (line 67)

var: Twitter API object for search.
since: 12.3
access: protected

JTwitterStatuses $statuses (line 61)

var: Twitter API object for statuses.
since: 12.3
access: protected

JTwitterTrends $trends (line 97)

var: Twitter API object for trends.
since: 12.3
access: protected

JTwitterUsers $users (line 49)

var: Twitter API object for users.
since: 12.3
access: protected

Methods

Constructor __construct (line 120)

Constructor.

since: 12.3
access: public

JTwitter __construct ([JTwitterOAuth $oauth = null], [JRegistry $options = null], [JHttp $client = null])

JTwitterOauth $oauth: The oauth client.
JRegistry $options: Twitter options object.
JHttp $client: The HTTP client object.

getOption (line 166)

Get an option from the JTwitter instance.

return: The option value.
since: 12.3
access: public

mixed getOption (string $key)

string $key: The name of the option to get.

setOption (line 181)

Set an option for the JTwitter instance.

return: This object for method chaining.
since: 12.3
access: public

JTwitter setOption (string $key, mixed $value)

string $key: The name of the option to set.
mixed $value: The option value to set.

__get (line 140)

Magic method to lazily create API objects

return: Twitter API object (statuses, users, favorites, etc.).
since: 12.3
throws: InvalidArgumentException
access: public

JTwitterObject __get (string $name)

string $name: Name of property to retrieve