Référence de la classe JTwitterObject

Graphe d'héritage de JTwitterObject:

Fonctions membres publiques
	__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)

Attributs protégés
	$options
	$client
	$oauth

Description détaillée

Twitter API object class for the Joomla Platform.

Depuis

3.1.4

Obsolète:

4.0 Use the joomla/twitter package via Composer instead

Documentation des constructeurs et destructeur

__construct()

__construct	(	Registry &	$options = null,
		JHttp	$client = null,
		JTwitterOAuth	$oauth = null
	)

Constructor.

Paramètres

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

Depuis

3.1.4

Références $client, et $options.

Documentation des fonctions membres

checkRateLimit()

checkRateLimit	(		$resource = null,
			$action = null
	)

Method to check the rate limit for the requesting IP address

Paramètres

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.

Renvoie

void

Depuis

3.1.4

Exceptions

RuntimeException

Références $action.

fetchUrl()

fetchUrl	(		$path,
			$parameters = null
	)

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.

Paramètres

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

Renvoie

string The request URL.

Depuis

3.1.4

Références $key, $parameters, $path, $uri, et $value.

getOption()

getOption

(

$key

)

Get an option from the JTwitterObject instance.

Paramètres

string

$key

The name of the option to get.

Renvoie

mixed The option value.

Depuis

3.1.4

Références $key.

getRateLimit()

getRateLimit

(

$resource

)

Method to retrieve the rate limit for the requesting IP address

Paramètres

string

$resource

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

Renvoie

array The JSON response decoded

Depuis

3.1.4

Références $path.

sendRequest()

sendRequest	(		$path,
			$method = 'GET',
			$data = array(),
			$headers = array()
	)

Method to send the request.

Paramètres

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

Renvoie

array The decoded JSON response

Depuis

3.1.4

Exceptions

RuntimeException

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

setOption()

setOption	(		$key,
			$value
	)

Set an option for the JTwitterObject instance.

Paramètres

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

Renvoie

JTwitterObject This object for method chaining.

Depuis

3.1.4

Références $key, et $value.

Documentation des champs

$client

$client

protected

$oauth

$oauth

protected

$options

$options

protected

---

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

• joomla/twitter/object.php