Joomla Platform  13.1
Documentation des API du framework Joomla Platform
 Tout Classes Espaces de nommage Fichiers Fonctions Variables Pages
Fonctions membres publiques | Fonctions membres protégées | Attributs protégés
Référence de la classe JFacebookObject
+ Graphe d'héritage de JFacebookObject:

Liste de tous les membres

Fonctions membres publiques

 __construct (JRegistry $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

Définition à la ligne 22 du fichier object.php.

Documentation des constructeurs et destructeur

JFacebookObject::__construct ( JRegistry  $options = null,
JHttp  $client = null,
JFacebookOAuth  $oauth = null 
)

Constructor.

Paramètres:
JRegistry$optionsFacebook options object.
JHttp$clientThe HTTP client object.
JFacebookOAuth$oauthThe OAuth client.
Depuis:
13.1

Définition à la ligne 51 du fichier object.php.

{
$this->options = isset($options) ? $options : new JRegistry;
$this->client = isset($client) ? $client : new JHttp($this->options);
$this->oauth = $oauth;
}

Documentation des fonctions membres

JFacebookObject::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

Définition à la ligne 218 du fichier object.php.

{
if ($this->oauth->isAuthenticated())
{
// Build the request path.
if ($connection != null)
{
$path = $object . '/' . $connection;
}
else
{
$path = $object;
}
// Send the post request.
$response = $this->oauth->query($this->fetchUrl($path), $parameters, $headers, 'post');
return json_decode($response->body);
}
else
{
return false;
}
}
JFacebookObject::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

Définition à la ligne 254 du fichier object.php.

{
if ($this->oauth->isAuthenticated())
{
// Build the request path.
if ($connection != null)
{
$path = $object . '/' . $connection . $extra_fields;
}
else
{
$path = $object . $extra_fields;
}
// Send the delete request.
$response = $this->oauth->query($this->fetchUrl($path), null, array(), 'delete');
return json_decode($response->body);
}
else
{
return false;
}
}
JFacebookObject::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.
timestamp$untilA unix timestamp or any date accepted by strtotime.
timestamp$sinceA unix timestamp or any date accepted by strtotime.
Renvoie:
string The request URL.
Depuis:
13.1

Définition à la ligne 73 du fichier object.php.

Références JUri\setVar().

{
// Get a new JUri object fousing the api url and given path.
$uri = new JUri($this->options->get('api.url') . $path);
if ($limit > 0)
{
$uri->setVar('limit', (int) $limit);
}
if ($offset > 0)
{
$uri->setVar('offset', (int) $offset);
}
if ($until != null)
{
$uri->setVar('until', $until);
}
if ($since != null)
{
$uri->setVar('since', $since);
}
return (string) $uri;
}

+ Voici le graphe d'appel pour cette fonction :

JFacebookObject::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

Définition à la ligne 142 du fichier object.php.

{
if ($this->oauth != null)
{
if ($this->oauth->isAuthenticated())
{
$response = $this->oauth->query($this->fetchUrl($object));
return json_decode($response->body);
}
else
{
return false;
}
}
// Send the request.
return $this->sendRequest($object);
}
JFacebookObject::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

Définition à la ligne 177 du fichier object.php.

{
$path = $object . '/' . $connection . $extra_fields;
if ($this->oauth != null)
{
if ($this->oauth->isAuthenticated())
{
$response = $this->oauth->query($this->fetchUrl($path, $limit, $offset, $until, $since));
if (strcmp($response->body, ''))
{
return json_decode($response->body);
}
else
{
return $response->headers['Location'];
}
}
else
{
return false;
}
}
// Send the request.
return $this->sendRequest($path, '', null, $limit, $offset, $until, $since);
}
JFacebookObject::getOAuth ( )

Method used to get the OAuth client.

Renvoie:
JFacebookOAuth The OAuth client
Depuis:
13.1

Définition à la ligne 302 du fichier object.php.

{
return $this->oauth;
}
JFacebookObject::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

Définition à la ligne 117 du fichier object.php.

{
// Send the request.
$response = $this->client->get($this->fetchUrl($path, $limit, $offset, $until, $since), $headers);
$response = json_decode($response->body);
// Validate the response.
if (property_exists($response, 'error'))
{
throw new RuntimeException($response->error->message);
}
return $response;
}
JFacebookObject::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

Définition à la ligne 288 du fichier object.php.

{
$this->oauth = $oauth;
return $this;
}

Documentation des données membres

JFacebookObject::$client
protected

Définition à la ligne 34 du fichier object.php.

JFacebookObject::$oauth
protected

Définition à la ligne 40 du fichier object.php.

JFacebookObject::$options
protected

Définition à la ligne 28 du fichier object.php.

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