JFacebookGroup

class JFacebookGroup extends JFacebookObject

Facebook API Group class for the Joomla Platform.

Methods

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

Constructor.

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

Method to send the request.

from JFacebookObject
mixed
get( string $object)

Method to get an object.

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

Method to get object's connection.

from JFacebookObject
mixed
createConnection( string $object, string $connection = null, array $parameters = null, array $headers = null)

Method to create a connection.

from JFacebookObject
mixed
deleteConnection( string $object, string $connection = null, string $extra_fields = '')

Method to delete a connection.

from JFacebookObject
JFacebookObject
setOAuth( JFacebookOAuth $oauth)

Method used to set the OAuth client.

from JFacebookObject
JFacebookOAuth
getOAuth()

Method used to get the OAuth client.

from JFacebookObject
mixed
getGroup( string $group)

Method to read a group. Requires authentication and usergroups or friendsgroups permission for non-public groups.

mixed
getFeed( string $group, integer $limit, integer $offset, string $until = null, string $since = null)

Method to get the group's wall. Requires authentication and usergroups or friendsgroups permission for non-public groups.

mixed
getMembers( string $group, integer $limit, integer $offset)

Method to get the group's members. Requires authentication and usergroups or friendsgroups permission for non-public groups.

mixed
getDocs( string $group, integer $limit, integer $offset, string $until = null, string $since = null)

Method to get the group's docs. Requires authentication and usergroups or friendsgroups permission for non-public groups.

string
getPicture( string $group, string $type = null)

Method to get the groups's picture. Requires authentication and usergroups or friendsgroups permission.

mixed
createLink( string $group, string $link, string $message = null)

Method to post a link on group's wall. Requires authentication and publish_stream permission.

boolean
deleteLink( mixed $link)

Method to delete a link. Requires authentication.

mixed
createPost( string $group, string $message = null, string $link = null, string $picture = null, string $name = null, string $caption = null, string $description = null, array $actions = null)

Method to post on group's wall. Message or link parameter is required. Requires authentication and publish_stream permission.

boolean
deletePost( string $post)

Method to delete a post. Note: you can only delete the post if it was created by the current user. Requires authentication.

mixed
createStatus( string $group, string $message)

Method to post a status message on behalf of the user on the group's wall. Requires authentication and publish_stream permission.

boolean
deleteStatus( string $status)

Method to delete a status. Note: you can only delete the status if it was created by the current user. Requires authentication.

Details

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

Constructor.

Parameters

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

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

Method to send the request.

Parameters

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.

Return Value

mixed The request response.

Exceptions

DomainException

mixed get( string $object)

Method to get an object.

Parameters

string $object The object id.

Return Value

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

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

Method to get object's connection.

Parameters

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.

Return Value

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

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

Method to create a connection.

Parameters

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

Return Value

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

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

Method to delete a connection.

Parameters

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

Return Value

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

JFacebookObject setOAuth( JFacebookOAuth $oauth)

Method used to set the OAuth client.

Parameters

JFacebookOAuth $oauth The OAuth client object.

Return Value

JFacebookObject This object for method chaining.

JFacebookOAuth getOAuth()

Method used to get the OAuth client.

Return Value

JFacebookOAuth The OAuth client

mixed getGroup( string $group)

Method to read a group. Requires authentication and usergroups or friendsgroups permission for non-public groups.

Parameters

string $group The group id.

Return Value

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

mixed getFeed( string $group, integer $limit, integer $offset, string $until = null, string $since = null)

Method to get the group's wall. Requires authentication and usergroups or friendsgroups permission for non-public groups.

Parameters

string $group The group id.
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.

Return Value

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

mixed getMembers( string $group, integer $limit, integer $offset)

Method to get the group's members. Requires authentication and usergroups or friendsgroups permission for non-public groups.

Parameters

string $group The group id.
integer $limit The number of objects per page.
integer $offset The object's number on the page.

Return Value

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

mixed getDocs( string $group, integer $limit, integer $offset, string $until = null, string $since = null)

Method to get the group's docs. Requires authentication and usergroups or friendsgroups permission for non-public groups.

Parameters

string $group The group id.
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.

Return Value

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

string getPicture( string $group, string $type = null)

Method to get the groups's picture. Requires authentication and usergroups or friendsgroups permission.

Parameters

string $group The group id.
string $type To request a different photo use square | small | normal | large.

Return Value

string The URL to the group's picture.

Method to post a link on group's wall. Requires authentication and publish_stream permission.

Parameters

string $group The group id.
string $link Link URL.
string $message Link message.

Return Value

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

Method to delete a link. Requires authentication.

Parameters

mixed $link The Link ID.

Return Value

boolean Returns true if successful, and false otherwise.

mixed createPost( string $group, string $message = null, string $link = null, string $picture = null, string $name = null, string $caption = null, string $description = null, array $actions = null)

Method to post on group's wall. Message or link parameter is required. Requires authentication and publish_stream permission.

Parameters

string $group The group id.
string $message Post message.
string $link Post URL.
string $picture Post thumbnail image (can only be used if link is specified)
string $name Post name (can only be used if link is specified).
string $caption Post caption (can only be used if link is specified).
string $description Post description (can only be used if link is specified).
array $actions Post actions array of objects containing name and link.

Return Value

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

boolean deletePost( string $post)

Method to delete a post. Note: you can only delete the post if it was created by the current user. Requires authentication.

Parameters

string $post The Post ID.

Return Value

boolean Returns true if successful, and false otherwise.

mixed createStatus( string $group, string $message)

Method to post a status message on behalf of the user on the group's wall. Requires authentication and publish_stream permission.

Parameters

string $group The group id.
string $message Status message content.

Return Value

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

boolean deleteStatus( string $status)

Method to delete a status. Note: you can only delete the status if it was created by the current user. Requires authentication.

Parameters

string $status The Status ID.

Return Value

boolean Returns true if successful, and false otherwise.