JFacebookAlbum

class JFacebookAlbum extends JFacebookObject

Facebook API Album 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
getAlbum( string $album)

Method to get an album. Requires authentication and userphotos or friendsphotos permission for private photos.

mixed
getPhotos( string $album, integer $limit, integer $offset, string $until = null, string $since = null)

Method to get the photos contained in this album. Requires authentication and userphotos or friendsphotos permission for private photos.

mixed
createPhoto( string $album, string $source, string $message = null)

Method to add photos to an album. Note: check canupload flag first. Requires authentication and publishstream permission.

mixed
getComments( string $album, integer $limit, integer $offset, string $until = null, string $since = null)

Method to get an album's comments. Requires authentication and userphotos or friendsphotos permission for private photos.

mixed
createComment( string $album, string $message)

Method to comment on an album. Requires authentication and publish_stream permission.

boolean
deleteComment( string $comment)

Method to delete a comment. Requires authentication and publish_stream permission.

mixed
getLikes( string $album, integer $limit, integer $offset, string $until = null, string $since = null)

Method to get album's likes. Requires authentication and userphotos or friendsphotos permission for private photos.

boolean
createLike( string $album)

Method to like an album. Requires authentication and publish_stream permission.

boolean
deleteLike( string $album)

Method to unlike an album. Requires authentication and publish_stream permission.

string
getPicture( string $album, boolean $redirect = true)

Method to get the album's cover photo, the first picture uploaded to an album becomes the cover photo for the album.

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 getAlbum( string $album)

Method to get an album. Requires authentication and userphotos or friendsphotos permission for private photos.

Parameters

string $album The album id.

Return Value

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

mixed getPhotos( string $album, integer $limit, integer $offset, string $until = null, string $since = null)

Method to get the photos contained in this album. Requires authentication and userphotos or friendsphotos permission for private photos.

Parameters

string $album The album 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 createPhoto( string $album, string $source, string $message = null)

Method to add photos to an album. Note: check canupload flag first. Requires authentication and publishstream permission.

Parameters

string $album The album id.
string $source Path to photo.
string $message Photo description.

Return Value

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

mixed getComments( string $album, integer $limit, integer $offset, string $until = null, string $since = null)

Method to get an album's comments. Requires authentication and userphotos or friendsphotos permission for private photos.

Parameters

string $album The album 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 createComment( string $album, string $message)

Method to comment on an album. Requires authentication and publish_stream permission.

Parameters

string $album The album id.
string $message The comment's text.

Return Value

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

boolean deleteComment( string $comment)

Method to delete a comment. Requires authentication and publish_stream permission.

Parameters

string $comment The comment's id.

Return Value

boolean Returns true if successful, and false otherwise.

mixed getLikes( string $album, integer $limit, integer $offset, string $until = null, string $since = null)

Method to get album's likes. Requires authentication and userphotos or friendsphotos permission for private photos.

Parameters

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

boolean createLike( string $album)

Method to like an album. Requires authentication and publish_stream permission.

Parameters

string $album The album id.

Return Value

boolean Returns true if successful, and false otherwise.

boolean deleteLike( string $album)

Method to unlike an album. Requires authentication and publish_stream permission.

Parameters

string $album The album id.

Return Value

boolean Returns true if successful, and false otherwise.

string getPicture( string $album, boolean $redirect = true)

Method to get the album's cover photo, the first picture uploaded to an album becomes the cover photo for the album.

Requires authentication and userphotos or friendsphotos permission for private photos.

Parameters

string $album The album id.
boolean $redirect If false this will return the URL of the picture without a 302 redirect.

Return Value

string URL of the picture.