Référence de la classe JTwitterPlaces

Graphe d'héritage de JTwitterPlaces:

Fonctions membres publiques
	getPlace ($id)
	getGeocode ($lat, $long, $accuracy=null, $granularity=null, $maxResults=0, $callback=null)
	search ($lat=null, $long=null, $query=null, $ip=null, $granularity=null, $accuracy=null, $maxResults=0, $within=null, $attribute=null, $callback=null)
	getSimilarPlaces ($lat, $long, $name, $within=null, $attribute=null, $callback=null)
	createPlace ($lat, $long, $name, $geoToken, $within, $attribute=null, $callback=null)
Fonctions membres publiques hérités de JTwitterObject
	__construct (Registry &$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)

Membres hérités additionnels
Attributs protégés hérités de JTwitterObject
	$options
	$client
	$oauth

Description détaillée

Twitter API Places & Geo class for the Joomla Platform.

Depuis

3.1.4

Obsolète:

4.0 Use the joomla/twitter package via Composer instead

Documentation des fonctions membres

createPlace()

createPlace	(		$lat,
			$long,
			$name,
			$geoToken,
			$within,
			$attribute = null,
			$callback = null
	)

Method to create a new place object at the given latitude and longitude.

Paramètres

float	$lat	The latitude to search around.
float	$long	The longitude to search around.
string	$name	The name a place is known as.
string	$geoToken	The token found in the response from geo/similar_places.
string	$within	This is the place_id which you would like to restrict the search results to.
string	$attribute	This parameter searches for places which have this given street address.
string	$callback	If supplied, the response will use the JSONP format with a callback of the given name.

Renvoie

array The decoded JSON response

Depuis

3.1.4

Références $data, $name, et $path.

getGeocode()

getGeocode	(		$lat,
			$long,
			$accuracy = null,
			$granularity = null,
			$maxResults = 0,
			$callback = null
	)

Method to get up to 20 places that can be used as a place_id when updating a status.

Paramètres

float	$lat	The latitude to search around.
float	$long	The longitude to search around.
string	$accuracy	A hint on the "region" in which to search. If a number, then this is a radius in meters, but it can also take a string that is suffixed with ft to specify feet.
string	$granularity	This is the minimal granularity of place types to return and must be one of: poi, neighborhood, city, admin or country.
integer	$maxResults	A hint as to the number of results to return.
string	$callback	If supplied, the response will use the JSONP format with a callback of the given name.

Renvoie

array The decoded JSON response

Depuis

3.1.4

Références $data, et $path.

getPlace()

getPlace

(

$id

)

Method to get all the information about a known place.

Paramètres

string

$id

A place in the world. These IDs can be retrieved using getGeocode.

Renvoie

array The decoded JSON response

Depuis

3.1.4

Références $id, et $path.

getSimilarPlaces()

getSimilarPlaces	(		$lat,
			$long,
			$name,
			$within = null,
			$attribute = null,
			$callback = null
	)

Method to locate places near the given coordinates which are similar in name.

Paramètres

float	$lat	The latitude to search around.
float	$long	The longitude to search around.
string	$name	The name a place is known as.
string	$within	This is the place_id which you would like to restrict the search results to.
string	$attribute	This parameter searches for places which have this given street address.
string	$callback	If supplied, the response will use the JSONP format with a callback of the given name.

Renvoie

array The decoded JSON response

Depuis

3.1.4

Références $data, $name, et $path.

search()

search	(		$lat = null,
			$long = null,
			$query = null,
			$ip = null,
			$granularity = null,
			$accuracy = null,
			$maxResults = 0,
			$within = null,
			$attribute = null,
			$callback = null
	)

Method to search for places that can be attached to a statuses/update.

Paramètres

float	$lat	The latitude to search around.
float	$long	The longitude to search around.
string	$query	Free-form text to match against while executing a geo-based query, best suited for finding nearby locations by name.
string	$ip	An IP address.
string	$granularity	This is the minimal granularity of place types to return and must be one of: poi, neighborhood, city, admin or country.
string	$accuracy	A hint on the "region" in which to search. If a number, then this is a radius in meters, but it can also take a string that is suffixed with ft to specify feet.
integer	$maxResults	A hint as to the number of results to return.
string	$within	This is the place_id which you would like to restrict the search results to.
string	$attribute	This parameter searches for places which have this given street address.
string	$callback	If supplied, the response will use the JSONP format with a callback of the given name.

Renvoie

array The decoded JSON response

Depuis

3.1.4

Exceptions

RuntimeException

Références $data, $path, $query, et null.

---

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

• places.php