\JTwitterObject

Twitter API object class for the Joomla Platform.

Synopsis

class JTwitterObject {

• // members
• protected JRegistry  $options;
• protected JHttp  $client;
• protected JTwitterOAuth  $oauth;
• // methods
• public void __construct()
• public void checkRateLimit()
• public string fetchUrl()
• public array getRateLimit()
• public array sendRequest()
• public mixed getOption()
• public JTwitterObject setOption()
}


Hierarchy

Extended by

• JTwitterObjectMock
• JTwitterLists
• JTwitterPlaces
• JTwitterHelp
• JTwitterDirectmessages
• JTwitterFavorites
• JTwitterBlock
• JTwitterFriends
• JTwitterUsers
• JTwittersearch
• JTwitterStatuses
• JTwitterTrends
• JTwitterProfile

Members

protected

• $client — JHttp
• $oauth — JTwitterOAuth
• $options — JRegistry

Methods

public

• __construct() — Constructor.
• checkRateLimit() — Method to check the rate limit for the requesting IP address
• fetchUrl() — 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.
• getOption() — Get an option from the JTwitterObject instance.
• getRateLimit() — Method to retrieve the rate limit for the requesting IP address
• sendRequest() — Method to send the request.
• setOption() — Set an option for the JTwitterObject instance.