Docs For Class JTwitterObject

Description

Twitter API object class for the Joomla Platform.

abstract:
since: 12.3

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

Direct descendents

Class	Description
JTwitterBlock	Twitter API Block class for the Joomla Platform.
JTwitterDirectmessages	Twitter API Direct Messages class for the Joomla Platform.
JTwitterFavorites	Twitter API Favorites class for the Joomla Platform.
JTwitterFriends	Twitter API Friends class for the Joomla Platform.
JTwitterHelp	Twitter API Help class for the Joomla Platform.
JTwitterLists	Twitter API Lists class for the Joomla Platform.
JTwitterPlaces	Twitter API Places & Geo class for the Joomla Platform.
JTwitterProfile	Twitter API Profile class for the Joomla Platform.
JTwittersearch	Twitter API Search class for the Joomla Platform.
JTwitterStatuses	Twitter API Statuses class for the Joomla Platform.
JTwitterTrends	Twitter API Trends class for the Joomla Platform.
JTwitterUsers	Twitter API Users class for the Joomla Platform.

Variable Summary

JHttp $client

JTwitterOAuth $oauth

JRegistry $options

Method Summary

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

void checkRateLimit ([string $resource = null], [string $action = null])

string fetchUrl (string $path, [array $parameters = null])

mixed getOption (string $key)

array getRateLimit (string $resource)

array sendRequest (string $path, [string $method = 'GET'], [mixed $data = array()], [array $headers = array()])

JTwitterObject setOption (string $key, mixed $value)

Variables

JHttp $client (line 31)

var: The HTTP client object to use in sending HTTP requests.
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 Twitter object.
since: 12.3
access: protected

Methods

Constructor __construct (line 48)

Constructor.

since: 12.3
access: public

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

JRegistry &$options: Twitter options object.
JHttp $client: The HTTP client object.
JTwitterOAuth $oauth: The OAuth client.

checkRateLimit (line 66)

Method to check the rate limit for the requesting IP address

since: 12.3
throws: RuntimeException
access: public

void checkRateLimit ([string $resource = null], [string $action = null])

string $resource: A resource or a comma-separated list of resource families you want to know the current rate limit disposition for.
string $action: An action for the specified resource, if only one resource is specified.

fetchUrl (line 99)

Method to build and return a full request URL for the request. This method will add appropriate pagination details if necessary and also prepend the API url to have a complete URL for the request.

return: The request URL.
since: 12.3
access: public

string fetchUrl (string $path, [array $parameters = null])

string $path: URL to inflect
array $parameters: The parameters passed in the URL.

getOption (line 206)

Get an option from the JTwitterObject instance.

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

mixed getOption (string $key)

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

getRateLimit (line 138)

Method to retrieve the rate limit for the requesting IP address

return: The JSON response decoded
since: 12.3
access: public

array getRateLimit (string $resource)

string $resource: A resource or a comma-separated list of resource families you want to know the current rate limit disposition for.

sendRequest (line 164)

Method to send the request.

return: The decoded JSON response
since: 12.3
throws: RuntimeException
access: public

array sendRequest (string $path, [string $method = 'GET'], [mixed $data = array()], [array $headers = array()])

string $path: The path of the request to make
string $method: The request method.
mixed $data: Either an associative array or a string to be sent with the post request.
array $headers: An array of name-value pairs to include in the header of the request

setOption (line 221)

Set an option for the JTwitterObject instance.

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

JTwitterObject setOption (string $key, mixed $value)

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