Joomla CMS  3.8.5 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.8.5 et du framework Joomla Platform intégré
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, $extra_fields='', $limit=0, $offset=0, $until=null, $since=null)
 
 createConnection ($object, $connection=null, $parameters=null, array $headers=null)
 
 deleteConnection ($object, $connection=null, $extra_fields='')
 
 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
13.1
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$optionsFacebook options object.
JHttp$clientThe HTTP client object.
JFacebookOAuth$oauthThe OAuth client.
Depuis
13.1

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$objectThe object id.
string$connectionThe object's connection name.
array$parametersThe POST request parameters.
array$headersAn 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
13.1

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

◆ deleteConnection()

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

Method to delete a connection.

Paramètres
string$objectThe object id.
string$connectionThe object's connection name.
string$extra_fieldsURL fields.
Renvoie
mixed The decoded JSON response or false if the client is not authenticated.
Depuis
13.1

Références $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$pathURL to inflect.
integer$limitThe number of objects per page.
integer$offsetThe object's number on the page.
integer$untilA unix timestamp or any date accepted by strtotime.
integer$sinceA unix timestamp or any date accepted by strtotime.
Renvoie
string The request URL.
Depuis
13.1

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

◆ get()

get (   $object)

Method to get an object.

Paramètres
string$objectThe object id.
Renvoie
mixed The decoded JSON response or false if the client is not authenticated.
Depuis
13.1

Références null.

◆ getConnection()

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

Method to get object's connection.

Paramètres
string$objectThe object id.
string$connectionThe object's connection name.
string$extra_fieldsURL fields.
integer$limitThe number of objects per page.
integer$offsetThe object's number on the page.
string$untilA unix timestamp or any date accepted by strtotime.
string$sinceA unix timestamp or any date accepted by strtotime.
Renvoie
mixed The decoded JSON response or false if the client is not authenticated.
Depuis
13.1

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

◆ getOAuth()

getOAuth ( )

Method used to get the OAuth client.

Renvoie
JFacebookOAuth The OAuth client
Depuis
13.1

◆ sendRequest()

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

Method to send the request.

Paramètres
string$pathThe path of the request to make.
mixed$dataEither an associative array or a string to be sent with the post request.
array$headersAn array of name-value pairs to include in the header of the request
integer$limitThe number of objects per page.
integer$offsetThe object's number on the page.
string$untilA unix timestamp or any date accepted by strtotime.
string$sinceA unix timestamp or any date accepted by strtotime.
Renvoie
mixed The request response.
Depuis
13.1
Exceptions
DomainException

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

◆ setOAuth()

setOAuth (   $oauth)

Method used to set the OAuth client.

Paramètres
JFacebookOAuth$oauthThe OAuth client object.
Renvoie
JFacebookObject This object for method chaining.
Depuis
13.1

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 :