Class JFacebookPhoto

Description
Description | Vars | Methods (details)

Facebook API Photo class for the Joomla Platform.

Located in /libraries/joomla/facebook/photo.php (line 23) 

JFacebookObject
   |
   --JFacebookPhoto
Method Summary
Description | Vars | Methods (details)
mixed createComment (string $photo, string $message)
boolean createLike (string $photo)
boolean createTag (string $photo, [mixed $to = null], [string $tag_text = null], [integer $x = null], [integer $y = null])
boolean deleteComment (string $comment)
boolean deleteLike (string $photo)
mixed getComments (string $photo, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
mixed getLikes (string $photo, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
mixed getPhoto (string $photo)
string getPicture (string $photo, [boolean $redirect = true])
mixed getTags (string $photo, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
boolean updateTag (string $photo, string $to, [integer $x = null], [integer $y = null])
Variables
Description | Vars (details) | Methods (details)

Inherited Variables

Inherited from JFacebookObject

JFacebookObject::$client
 JFacebookObject::$oauth
 JFacebookObject::$options
Methods
Description | Vars Methods (details)
createComment (line 67)

Method to comment on a photo. Requires authentication and publish_stream permission, user_photos or friends_photos permission for private photos.

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed createComment (string $photo, string $message)
  • string $photo: The photo id.
  • string $message: The comment's text.
createLike (line 116)

Method to like a photo. Requires authentication and publish_stream permission, user_photos or friends_photos permission for private photos.

  • return: Returns true if successful, and false otherwise.
  • since: 13.1
  • access: public
boolean createLike (string $photo)
  • string $photo: The photo id.
createTag (line 167)

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.

  • return: Returns true if successful, and false otherwise.
  • since: 13.1
  • access: public
boolean createTag (string $photo, [mixed $to = null], [string $tag_text = null], [integer $x = null], [integer $y = null])
  • string $photo: The photo id.
  • mixed $to: ID of the User or an array of Users to tag in the photo: [{"id":"1234"}, {"id":"12345"}].
  • string $tag_text: A text string to tag.
  • integer $x: x coordinate of tag, as a percentage offset from the left edge of the picture.
  • integer $y: y coordinate of tag, as a percentage offset from the top edge of the picture.
deleteComment (line 84)

Method to delete a comment. Requires authentication and publish_stream permission, user_photos or friends_photos permission for private photos.

  • return: Returns true if successful, and false otherwise.
  • since: 13.1
  • access: public
boolean deleteComment (string $comment)
  • string $comment: The comment's id.
deleteLike (line 130)

Method to unlike a photo. Requires authentication and publish_stream permission, user_photos or friends_photos permission for private photos.

  • return: Returns true if successful, and false otherwise.
  • since: 13.1
  • access: public
boolean deleteLike (string $photo)
  • string $photo: The photo id.
getComments (line 52)

Method to get a photo's comments. Requires authentication and user_photos or friends_photos permission for private photos.

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed getComments (string $photo, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
  • string $photo: The photo 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.
getLikes (line 102)

Method to get photo's likes. Requires authentication and user_photos or friends_photos permission for private photos.

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed getLikes (string $photo, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
  • string $photo: The photo 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.
getPhoto (line 34)

Method to get a photo. Requires authentication and user_photos or friends_photos permission for private photos.

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed getPhoto (string $photo)
  • string $photo: The photo id.
getPicture (line 238)

Method to get the album-sized view of the photo. Requires authentication and user_photos or friends_photos permission for private photos.

  • return: URL of the picture.
  • since: 13.1
  • access: public
string getPicture (string $photo, [boolean $redirect = true])
  • string $photo: The photo id.
  • boolean $redirect: If false this will return the URL of the picture without a 302 redirect.
getTags (line 148)

Method to get the Users tagged in the photo. Requires authentication and user_photos or friends_photos permission for private photos.

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed getTags (string $photo, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
  • string $photo: The photo 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.
updateTag (line 210)

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.

  • return: Returns true if successful, and false otherwise.
  • since: 13.1
  • access: public
boolean updateTag (string $photo, string $to, [integer $x = null], [integer $y = null])
  • string $photo: The photo id.
  • string $to: ID of the User to update tag in the photo.
  • integer $x: x coordinate of tag, as a percentage offset from the left edge of the picture.
  • integer $y: y coordinate of tag, as a percentage offset from the top edge of the picture.

Inherited Methods

Inherited From JFacebookObject

JFacebookObject::__construct()
JFacebookObject::createConnection()
JFacebookObject::deleteConnection()
JFacebookObject::fetchUrl()
JFacebookObject::get()
JFacebookObject::getConnection()
JFacebookObject::getOAuth()
JFacebookObject::sendRequest()
JFacebookObject::setOAuth()

Documentation generated on Tue, 19 Nov 2013 15:10:30 +0100 by phpDocumentor 1.4.3