Joomla Platform  13.1
Documentation des API du framework Joomla Platform
 Tout Classes Espaces de nommage Fichiers Fonctions Variables Pages
Référence de la classe JTwitterTrends
+ Graphe d'héritage de JTwitterTrends:
+ Graphe de collaboration de JTwitterTrends:

Liste de tous les membres

Fonctions membres publiques

 getTrends ($id, $exclude=null)
 getLocations ()
 getClosest ($lat=null, $long=null)
- Fonctions membres publiques inherited from JTwitterObject
 __construct (JRegistry &$options=null, JHttp $client=null, JTwitterOAuth $oauth=null)
 checkRateLimit ($resource=null, $action=null)
 fetchUrl ($path, $parameters=null)
 getRateLimit ($resource)
 sendRequest ($path, $method= 'GET', $data=array(), $headers=array())
 getOption ($key)
 setOption ($key, $value)

Additional Inherited Members

- Attributs protégés inherited from JTwitterObject
 $options
 $client
 $oauth

Description détaillée

Définition à la ligne 19 du fichier trends.php.


Documentation des fonctions membres

JTwitterTrends::getClosest (   $lat = null,
  $long = null 
)

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

Paramètres:
float$latThe latitude to search around.
float$longThe longitude to search around.
Renvoie:
array The decoded JSON response
Depuis:
12.3

Définition à la ligne 81 du fichier trends.php.

{
// Check the rate limit for remaining hits
$this->checkRateLimit('trends', 'closest');
// Set the API path
$path = '/trends/closest.json';
$data = array();
// Check if lat is specified
if ($lat)
{
$data['lat'] = $lat;
}
// Check if long is specified
if ($long)
{
$data['long'] = $long;
}
// Send the request.
return $this->sendRequest($path, 'GET', $data);
}
JTwitterTrends::getLocations ( )

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

Renvoie:
array The decoded JSON response
Depuis:
12.3

Définition à la ligne 59 du fichier trends.php.

{
// Check the rate limit for remaining hits
$this->checkRateLimit('trends', 'available');
// Set the API path
$path = '/trends/available.json';
// Send the request.
return $this->sendRequest($path);
}
JTwitterTrends::getTrends (   $id,
  $exclude = null 
)

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

Paramètres:
integer$idThe Yahoo! Where On Earth ID of the location to return trending information for. Global information is available by using 1 as the WOEID.
string$excludeSetting this equal to hashtags will remove all hashtags from the trends list.
Renvoie:
array The decoded JSON response
Depuis:
12.3

Définition à la ligne 32 du fichier trends.php.

{
// Check the rate limit for remaining hits
$this->checkRateLimit('trends', 'place');
// Set the API path
$path = '/trends/place.json';
$data['id'] = $id;
// Check if exclude is specified
if ($exclude)
{
$data['exclude'] = $exclude;
}
// Send the request.
return $this->sendRequest($path, 'GET', $data);
}

La documentation de cette classe a été générée à partir du fichier suivant :