Class JFacebookPhoto
Facebook API Photo class for the Joomla Platform.
-
JFacebookObject
-
JFacebookPhoto
Methods summary
public
mixed
|
#
getPhoto( string $photo )
Method to get a photo. Requires authentication and user_photos or
friends_photos permission for private photos.
Method to get a photo. Requires authentication and user_photos or
friends_photos permission for private photos.
Parameters
- $photo
string - $photo The photo id. Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|
public
mixed
|
#
getLikes( string $photo, integer $limit = 0, integer $offset = 0, string $until = null, string $since = null )
Method to get photo's likes. Requires authentication and user_photos or
friends_photos permission for private photos.
Method to get photo's likes. Requires authentication and user_photos or
friends_photos permission for private photos.
Parameters
- $photo
string - $photo The photo id.- $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
boolean
|
#
createLike( string $photo )
Method to like a photo. Requires authentication and publish_stream
permission, user_photos or friends_photos permission for private photos.
Method to like a photo. Requires authentication and publish_stream
permission, user_photos or friends_photos permission for private photos.
Parameters
- $photo
string - $photo The photo id. Returns
boolean - Returns true if successful, and false otherwise.
Since
13.1
|
public
boolean
|
#
deleteLike( string $photo )
Method to unlike a photo. Requires authentication and publish_stream
permission, user_photos or friends_photos permission for private photos.
Method to unlike a photo. Requires authentication and publish_stream
permission, user_photos or friends_photos permission for private photos.
Parameters
- $photo
string - $photo The photo id. Returns
boolean - Returns true if successful, and false otherwise.
Since
13.1
|
public
mixed
|
#
getTags( string $photo, integer $limit = 0, integer $offset = 0, string $until = null, string $since = null )
Method to get the Users tagged in the photo. Requires authentication and
user_photos or friends_photos permission for private photos.
Method to get the Users tagged in the photo. Requires authentication and
user_photos or friends_photos permission for private photos.
Parameters
- $photo
string - $photo The photo id.- $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
boolean
|
#
createTag( string $photo, mixed $to = null, string $tag_text = null, integer $x = null, integer $y = null )
Method to tag one or more Users in a photo. $to or $tag_text required.
Requires authentication and publish_stream permission, user_photos permission
for private photos.
Method to tag one or more Users in a photo. $to or $tag_text required.
Requires authentication and publish_stream permission, user_photos permission
for private photos.
Parameters
- $photo
string - $photo The photo id.- $to
mixed - $to ID of the User or an array of Users to tag in the photo: [{id, {id.- $tag_text
string - $tag_text A text string to tag.- $x
integer - $x x coordinate of tag, as a percentage offset from the left edge of the
picture.- $y
integer - $y y coordinate of tag, as a percentage offset from the top edge of the picture. Returns
boolean - Returns true if successful, and false otherwise.
Since
13.1
|
public
boolean
|
#
updateTag( string $photo, string $to, integer $x = null, integer $y = null )
Method to update the position of the tag for a particular Users in a photo.
Requires authentication and publish_stream permission, user_photos permission
for private photos.
Method to update the position of the tag for a particular Users in a photo.
Requires authentication and publish_stream permission, user_photos permission
for private photos.
Parameters
- $photo
string - $photo The photo id.- $to
string - $to ID of the User to update tag in the photo.- $x
integer - $x x coordinate of tag, as a percentage offset from the left edge of the
picture.- $y
integer - $y y coordinate of tag, as a percentage offset from the top edge of the picture. Returns
boolean - Returns true if successful, and false otherwise.
Since
13.1
|
public
string
|
#
getPicture( string $photo, boolean $redirect = true )
Method to get the album-sized view of the photo. Requires authentication and
user_photos or friends_photos permission for private photos.
Method to get the album-sized view of the photo. Requires authentication and
user_photos or friends_photos permission for private photos.
Parameters
- $photo
string - $photo The photo id.- $redirect
boolean - $redirect If false this will return the URL of the picture without a 302
redirect. Returns
string - URL of the picture.
Since
13.1
|
__construct(),
createConnection(),
deleteConnection(),
fetchUrl(),
get(),
getConnection(),
getOAuth(),
sendRequest(),
setOAuth()
Magic methods summary
Properties summary
$client,
$oauth,
$options
