JFacebookObject

Facebook API object class for the Joomla Platform.

abstract deprecated
since

3.2.0

deprecated

4.0 Use the joomla/facebook package via Composer instead

package

Joomla.Platform

Methods

__construct

Constructor.

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

3.2.0

Arguments

$options

\Joomla\Registry\RegistryFacebook options object.

$client

\JHttpThe HTTP client object.

$oauth

\JFacebookOAuthThe OAuth client.

createConnection

Method to create a connection.

createConnection(string $object, string $connection = null, array $parameters = null, array $headers = null) : mixed
since

3.2.0

Arguments

$object

stringThe object id.

$connection

stringThe object's connection name.

$parameters

arrayThe POST request parameters.

$headers

arrayAn array of name-value pairs to include in the header of the request

Response

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

deleteConnection

Method to delete a connection.

deleteConnection(string $object, string $connection = null, string $extra_fields = '') : mixed
since

3.2.0

Arguments

$object

stringThe object id.

$connection

stringThe object's connection name.

$extra_fields

stringURL fields.

Response

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

fetchUrl

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.

fetchUrl(string $path, integer $limit, integer $offset, integer $until = null, integer $since = null) : string
since

3.2.0

Arguments

$path

stringURL to inflect.

$limit

integerThe number of objects per page.

$offset

integerThe object's number on the page.

$until

integerA unix timestamp or any date accepted by strtotime.

$since

integerA unix timestamp or any date accepted by strtotime.

Response

stringThe request URL.

get

Method to get an object.

get(string $object) : mixed
since

3.2.0

Arguments

$object

stringThe object id.

Response

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

getConnection

Method to get object's connection.

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

3.2.0

Arguments

$object

stringThe object id.

$connection

stringThe object's connection name.

$extra_fields

stringURL fields.

$limit

integerThe number of objects per page.

$offset

integerThe object's number on the page.

$until

stringA unix timestamp or any date accepted by strtotime.

$since

stringA unix timestamp or any date accepted by strtotime.

Response

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

getOAuth

Method used to get the OAuth client.

getOAuth() : \JFacebookOAuth
since

3.2.0

Response

\JFacebookOAuthThe OAuth client

sendRequest

Method to send the request.

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

3.2.0

throws

\DomainException

Arguments

$path

stringThe path of the request to make.

$data

mixedEither an associative array or a string to be sent with the post request.

$headers

arrayAn array of name-value pairs to include in the header of the request

$limit

integerThe number of objects per page.

$offset

integerThe object's number on the page.

$until

stringA unix timestamp or any date accepted by strtotime.

$since

stringA unix timestamp or any date accepted by strtotime.

Response

mixedThe request response.

setOAuth

Method used to set the OAuth client.

setOAuth(\JFacebookOAuth $oauth) : \JFacebookObject
since

3.2.0

Arguments

$oauth

\JFacebookOAuthThe OAuth client object.

Response

\JFacebookObjectThis object for method chaining.

Properties

options

Options for the Facebook object.

since

3.2.0

Type(s)

\Joomla\Registry\Registry

client

The HTTP client object to use in sending HTTP requests.

since

3.2.0

Type(s)

\JHttp

oauth

The OAuth client.

since

3.2.0

Type(s)

\JFacebookOAuth