Class JFacebookObject

Facebook API object class for the Joomla Platform.

Direct known subclasses

JFacebookAlbum, JFacebookCheckin, JFacebookUser, JFacebookVideo, JFacebookComment, JFacebookEvent, JFacebookGroup, JFacebookLink, JFacebookNote, JFacebookPhoto, JFacebookPost, JFacebookStatus

Abstract
Package: Joomla\Platform\Facebook
Deprecated: 4.0 Use the joomla/facebook package via Composer instead
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE
Since: 13.1
Located at joomla/facebook/object.php

Methods summary

`public`	# `__construct( Joomla\Registry\Registry $options = null, JHttp $client = null, JFacebookOAuth $oauth = null )` Constructor. Constructor. Parameters `$options` `Joomla\Registry\Registry` - $options Facebook options object. `$client` `JHttp` - $client The HTTP client object. `$oauth` `JFacebookOAuth` - $oauth The OAuth client. Since 13.1
`protected string`	# `fetchUrl( string $path, integer $limit = 0, integer $offset = 0, timestamp $until = null, timestamp $since = null )` 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. 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. Parameters `$path` `string` - $path URL to inflect. `$limit` `integer` - $limit The number of objects per page. `$offset` `integer` - $offset The object's number on the page. `$until` `timestamp` - $until A unix timestamp or any date accepted by strtotime. `$since` `timestamp` - $since A unix timestamp or any date accepted by strtotime. Returns `string` - The request URL. Since 13.1
`public mixed`	# `sendRequest( string $path, mixed $data = '', array $headers = null, integer $limit = 0, integer $offset = 0, string $until = null, string $since = null )` Method to send the request. Method to send the request. Parameters `$path` `string` - $path The path of the request to make. `$data` `mixed` - $data Either an associative array or a string to be sent with the post request. `$headers` `array` - $headers An array of name-value pairs to include in the header of the request `$limit` `integer` - $limit The number of objects per page. `$offset` `integer` - $offset The object's number on the page. `$until` `string` - $until A unix timestamp or any date accepted by strtotime. `$since` `string` - $since A unix timestamp or any date accepted by strtotime. Returns `mixed` - The request response. Throws `DomainException` Since 13.1
`public mixed`	# `get( string $object )` Method to get an object. Method to get an object. Parameters `$object` `string` - $object The object id. Returns `mixed` - The decoded JSON response or false if the client is not authenticated. Since 13.1
`public mixed`	# `getConnection( string $object, string $connection = null, string $extra_fields = '', integer $limit = 0, integer $offset = 0, string $until = null, string $since = null )` Method to get object's connection. Method to get object's connection. Parameters `$object` `string` - $object The object id. `$connection` `string` - $connection The object's connection name. `$extra_fields` `string` - $extra_fields URL fields. `$limit` `integer` - $limit The number of objects per page. `$offset` `integer` - $offset The object's number on the page. `$until` `string` - $until A unix timestamp or any date accepted by strtotime. `$since` `string` - $since A unix timestamp or any date accepted by strtotime. Returns `mixed` - The decoded JSON response or false if the client is not authenticated. Since 13.1
`public mixed`	# `createConnection( string $object, string $connection = null, array $parameters = null, array $headers = null )` Method to create a connection. Method to create a connection. Parameters `$object` `string` - $object The object id. `$connection` `string` - $connection The object's connection name. `$parameters` `array` - $parameters The POST request parameters. `$headers` `array` - $headers An array of name-value pairs to include in the header of the request Returns `mixed` - The decoded JSON response or false if the client is not authenticated. Since 13.1
`public mixed`	# `deleteConnection( string $object, string $connection = null, string $extra_fields = '' )` Method to delete a connection. Method to delete a connection. Parameters `$object` `string` - $object The object id. `$connection` `string` - $connection The object's connection name. `$extra_fields` `string` - $extra_fields URL fields. Returns `mixed` - The decoded JSON response or false if the client is not authenticated. Since 13.1
`public JFacebookObject`	# `setOAuth( JFacebookOAuth $oauth )` Method used to set the OAuth client. Method used to set the OAuth client. Parameters `$oauth` `JFacebookOAuth` - $oauth The OAuth client object. Returns `JFacebookObject` - This object for method chaining. Since 13.1
`public JFacebookOAuth`	# `getOAuth( )` Method used to get the OAuth client. Method used to get the OAuth client. Returns `JFacebookOAuth` - The OAuth client Since 13.1

Magic methods summary

Properties summary

`protected Joomla\Registry\Registry`	`$options`	# Options for the Facebook object. Options for the Facebook object. Since 13.1
`protected JHttp`	`$client`	# The HTTP client object to use in sending HTTP requests. The HTTP client object to use in sending HTTP requests. Since 13.1
`protected JFacebookOAuth`	`$oauth`	# The OAuth client. The OAuth client. Since 13.1

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JFacebookObject

Direct known subclasses

Methods summary

Parameters

Since

Parameters

Returns

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Returns

Since

Magic methods summary

Properties summary

Since

Since

Since