Docs For Class JFacebookObject

Description

Facebook API object class for the Joomla Platform.

abstract:
since: 13.1

Located in /libraries/joomla/facebook/object.php (line 22)

Direct descendents

Class	Description
JFacebookAlbum	Facebook API Album class for the Joomla Platform.
JFacebookCheckin	Facebook API Checkin class for the Joomla Platform.
JFacebookComment	Facebook API Comment class for the Joomla Platform.
JFacebookEvent	Facebook API User class for the Joomla Platform.
JFacebookGroup	Facebook API Group class for the Joomla Platform.
JFacebookLink	Facebook API Link class for the Joomla Platform.
JFacebookNote	Facebook API Note class for the Joomla Platform.
JFacebookPhoto	Facebook API Photo class for the Joomla Platform.
JFacebookPost	Facebook API Post class for the Joomla Platform.
JFacebookStatus	Facebook API Status class for the Joomla Platform.
JFacebookUser	Facebook API User class for the Joomla Platform.
JFacebookVideo	Facebook API Video class for the Joomla Platform.

Variable Summary

JHttp $client

JFacebookOAuth $oauth

JRegistry $options

Method Summary

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

mixed createConnection (string $object, [string $connection = null], [array $parameters = null], [array $headers = null])

mixed deleteConnection (string $object, [string $connection = null], [string $extra_fields = ''])

string fetchUrl (string $path, [integer $limit = 0], [integer $offset = 0], [timestamp $until = null], [timestamp $since = null])

mixed get (string $object)

mixed getConnection (string $object, [string $connection = null], [string $extra_fields = ''], [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])

JFacebookOAuth getOAuth ()

mixed sendRequest (string $path, [mixed $data = ''], [array $headers = null], [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])

JFacebookObject setOAuth (JFacebookOAuth $oauth)

Variables

JHttp $client (line 34)

var: The HTTP client object to use in sending HTTP requests.
since: 13.1
access: protected

JFacebookOAuth $oauth (line 40)

var: The OAuth client.
since: 13.1
access: protected

JRegistry $options (line 28)

var: Options for the Facebook object.
since: 13.1
access: protected

Methods

Constructor __construct (line 51)

Constructor.

since: 13.1
access: public

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

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

createConnection (line 218)

Method to create a connection.

return: The decoded JSON response or false if the client is not authenticated.
since: 13.1
access: public

mixed createConnection (string $object, [string $connection = null], [array $parameters = null], [array $headers = null])

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

deleteConnection (line 254)

Method to delete a connection.

return: The decoded JSON response or false if the client is not authenticated.
since: 13.1
access: public

mixed deleteConnection (string $object, [string $connection = null], [string $extra_fields = ''])

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

fetchUrl (line 73)

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.

return: The request URL.
since: 13.1
access: protected

string fetchUrl (string $path, [integer $limit = 0], [integer $offset = 0], [timestamp $until = null], [timestamp $since = null])

string $path: URL to inflect.
integer $limit: The number of objects per page.
integer $offset: The object's number on the page.
timestamp $until: A unix timestamp or any date accepted by strtotime.
timestamp $since: A unix timestamp or any date accepted by strtotime.

get (line 142)

Method to get an object.

return: The decoded JSON response or false if the client is not authenticated.
since: 13.1
access: public

mixed get (string $object)

string $object: The object id.

getConnection (line 177)

Method to get object's connection.

return: The decoded JSON response or false if the client is not authenticated.
since: 13.1
access: public

mixed getConnection (string $object, [string $connection = null], [string $extra_fields = ''], [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])

string $object: The object id.
string $connection: The object's connection name.
string $extra_fields: 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.

getOAuth (line 302)

Method used to get the OAuth client.

return: The OAuth client
since: 13.1
access: public

JFacebookOAuth getOAuth ()

sendRequest (line 117)

Method to send the request.

return: The request response.
since: 13.1
throws: DomainException
access: public

mixed sendRequest (string $path, [mixed $data = ''], [array $headers = null], [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])

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.

setOAuth (line 288)

Method used to set the OAuth client.

return: This object for method chaining.
since: 13.1
access: public

JFacebookObject setOAuth (JFacebookOAuth $oauth)

JFacebookOAuth $oauth: The OAuth client object.