Docs For Class JTwitterTrends

JTwitterTrends

Description

Twitter API Trends class for the Joomla Platform.

since: 12.3

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

JTwitterObject
   |
   --JTwitterTrends

Method Summary

array getClosest ([float $lat = null], [float $long = null])

array getLocations ()

array getTrends (integer $id, [string $exclude = null])

Variables

Inherited Variables

Inherited from JTwitterObject

JTwitterObject::$client
JTwitterObject::$oauth
JTwitterObject::$options

Methods

getClosest (line 81)

Method to get the locations that Twitter has trending topic information for, closest to a specified location.

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

array getClosest ([float $lat = null], [float $long = null])

float $lat: The latitude to search around.
float $long: The longitude to search around.

getLocations (line 59)

Method to get the locations that Twitter has trending topic information for.

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

array getLocations ()

getTrends (line 32)

Method to get the top 10 trending topics for a specific WOEID, if trending information is available for it.

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

array getTrends (integer $id, [string $exclude = null])

integer $id: The Yahoo! Where On Earth ID of the location to return trending information for. Global information is available by using 1 as the WOEID.
string $exclude: Setting this equal to hashtags will remove all hashtags from the trends list.

Inherited Methods

Inherited From JTwitterObject

JTwitterObject::__construct()
JTwitterObject::checkRateLimit()
JTwitterObject::fetchUrl()
JTwitterObject::getOption()
JTwitterObject::getRateLimit()
JTwitterObject::sendRequest()
JTwitterObject::setOption()

Documentation generated on Tue, 19 Nov 2013 15:16:01 +0100 by phpDocumentor 1.4.3