Référence de la classe JFacebookObject

Graphe d'héritage de JFacebookObject:

Fonctions membres publiques
	__construct (Registry $options=null, JHttp $client=null, JFacebookOAuth $oauth=null)
	sendRequest ($path, $data='', array $headers=null, $limit=0, $offset=0, $until=null, $since=null)
	get ($object)
	getConnection ($object, $connection=null, $extraFields='', $limit=0, $offset=0, $until=null, $since=null)
	createConnection ($object, $connection=null, $parameters=null, array $headers=null)
	deleteConnection ($object, $connection=null, $extraFields='')
	setOAuth ($oauth)
	getOAuth ()

Fonctions membres protégées
	fetchUrl ($path, $limit=0, $offset=0, $until=null, $since=null)

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

Description détaillée

Facebook API object class for the Joomla Platform.

Depuis

3.2.0

Obsolète:

4.0 Use the joomla/facebook package via Composer instead

Documentation des constructeurs et destructeur

__construct()

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

Constructor.

Paramètres

Registry	$options	Facebook options object.
JHttp	$client	The HTTP client object.
JFacebookOAuth	$oauth	The OAuth client.

Depuis

3.2.0

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

Documentation des fonctions membres

createConnection()

createConnection	(		$object,
			$connection = null,
			$parameters = null,
		array	$headers = null
	)

Method to create a connection.

Paramètres

string	$object	The object id.
string	$connection	The object's connection name.
array	$parameters	The POST request parameters.
array	$headers	An array of name-value pairs to include in the header of the request

Renvoie

mixed The decoded JSON response or false if the client is not authenticated.

Depuis

3.2.0

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

deleteConnection()

deleteConnection	(		$object,
			$connection = null,
			$extraFields = ''
	)

Method to delete a connection.

Paramètres

string	$object	The object id.
string	$connection	The object's connection name.
string	$extraFields	URL fields.

Renvoie

mixed The decoded JSON response or false if the client is not authenticated.

Depuis

3.2.0

Références $extraFields, $path, et null.

fetchUrl()

fetchUrl (   $path,   $limit = 0,   $offset = 0,   $until = null,   $since = null  )

protected

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.
integer	$limit	The number of objects per page.
integer	$offset	The object's number on the page.
integer	$until	A unix timestamp or any date accepted by strtotime.
integer	$since	A unix timestamp or any date accepted by strtotime.

Renvoie

string The request URL.

Depuis

3.2.0

Références $limit, $offset, $path, $uri, et null.

get()

get

(

$object

)

Method to get an object.

Paramètres

string

$object

The object id.

Renvoie

mixed The decoded JSON response or false if the client is not authenticated.

Depuis

3.2.0

Références null.

getConnection()

getConnection	(		$object,
			$connection = null,
			$extraFields = '',
			$limit = 0,
			$offset = 0,
			$until = null,
			$since = null
	)

Method to get object's connection.

Paramètres

string	$object	The object id.
string	$connection	The object's connection name.
string	$extraFields	URL fields.
integer	$limit	The number of objects per page.
integer	$offset	The object's number on the page.
string	$until	A unix timestamp or any date accepted by strtotime.
string	$since	A unix timestamp or any date accepted by strtotime.

Renvoie

mixed The decoded JSON response or false if the client is not authenticated.

Depuis

3.2.0

Références $extraFields, $limit, $offset, $path, et null.

getOAuth()

getOAuth

(

)

Method used to get the OAuth client.

Renvoie

JFacebookOAuth The OAuth client

Depuis

3.2.0

sendRequest()

sendRequest	(		$path,
			$data = '',
		array	$headers = null,
			$limit = 0,
			$offset = 0,
			$until = null,
			$since = null
	)

Method to send the request.

Paramètres

string	$path	The path of the request to make.
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
integer	$limit	The number of objects per page.
integer	$offset	The object's number on the page.
string	$until	A unix timestamp or any date accepted by strtotime.
string	$since	A unix timestamp or any date accepted by strtotime.

Renvoie

mixed The request response.

Depuis

3.2.0

Exceptions

DomainException

Références $limit, $offset, et $path.

setOAuth()

setOAuth

(

$oauth

)

Method used to set the OAuth client.

Paramètres

JFacebookOAuth

$oauth

The OAuth client object.

Renvoie

JFacebookObject This object for method chaining.

Depuis

3.2.0

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/facebook/object.php