Docs For Class JFacebook

Description

Joomla Platform class for interacting with a Facebook API instance.

since: 13.1

Located in /libraries/joomla/facebook/facebook.php (line 19)

Variable Summary

JFacebookAlbum $album

JFacebookCheckin $checkin

JHttp $client

JFacebookComment $comment

JFacebookEvent $event

JFacebookGroup $group

JFacebookLink $link

JFacebookNote $note

JFacebookOAuth $oauth

JRegistry $options

JFacebookPhoto $photo

JFacebookPost $post

JFacebookStatus $status

JFacebookUser $user

JFacebookVideo $video

Method Summary

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

mixed getOption (string $key)

JFacebook setOption (string $key, mixed $value)

JFacebookObject __get (string $name)

Variables

JFacebookAlbum $album (line 109)

var: Facebook API object for album.
since: 13.1
access: protected

JFacebookCheckin $checkin (line 55)

var: Facebook API object for checkin.
since: 13.1
access: protected

JHttp $client (line 31)

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

JFacebookComment $comment (line 91)

var: Facebook API object for comment.
since: 13.1
access: protected

JFacebookEvent $event (line 61)

var: Facebook API object for event.
since: 13.1
access: protected

JFacebookGroup $group (line 67)

var: Facebook API object for group.
since: 13.1
access: protected

JFacebookLink $link (line 73)

var: Facebook API object for link.
since: 13.1
access: protected

JFacebookNote $note (line 79)

var: Facebook API object for note.
since: 13.1
access: protected

JFacebookOAuth $oauth (line 37)

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

JRegistry $options (line 25)

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

JFacebookPhoto $photo (line 97)

var: Facebook API object for photo.
since: 13.1
access: protected

JFacebookPost $post (line 85)

var: Facebook API object for post.
since: 13.1
access: protected

JFacebookStatus $status (line 49)

var: Facebook API object for status.
since: 13.1
access: protected

JFacebookUser $user (line 43)

var: Facebook API object for user.
since: 13.1
access: protected

JFacebookVideo $video (line 103)

var: Facebook API object for video.
since: 13.1
access: protected

Methods

Constructor __construct (line 120)

Constructor.

since: 13.1
access: public

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

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

getOption (line 166)

Get an option from the JFacebook instance.

return: The option value.
since: 13.1
access: public

mixed getOption (string $key)

string $key: The name of the option to get.

setOption (line 181)

Set an option for the JFacebook instance.

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

JFacebook setOption (string $key, mixed $value)

string $key: The name of the option to set.
mixed $value: The option value to set.

__get (line 140)

Magic method to lazily create API objects

return: Facebook API object (status, user, friends etc).
since: 13.1
throws: InvalidArgumentException
access: public

JFacebookObject __get (string $name)

string $name: Name of property to retrieve