Joomla CMS  3.10.11 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.10.11 et du framework Joomla Platform intégré
Tout Structures de données Espaces de nommage Fichiers Fonctions Variables Pages
Référence de la classe JFacebookPhoto
+ Graphe d'héritage de JFacebookPhoto:

Fonctions membres publiques

 getPhoto ($photo)
 
 getComments ($photo, $limit=0, $offset=0, $until=null, $since=null)
 
 createComment ($photo, $message)
 
 deleteComment ($comment)
 
 getLikes ($photo, $limit=0, $offset=0, $until=null, $since=null)
 
 createLike ($photo)
 
 deleteLike ($photo)
 
 getTags ($photo, $limit=0, $offset=0, $until=null, $since=null)
 
 createTag ($photo, $to=null, $tagText=null, $x=null, $y=null)
 
 updateTag ($photo, $to, $x=null, $y=null)
 
 getPicture ($photo, $redirect=true)
 
- Fonctions membres publiques hérités de JFacebookObject
 __construct (Registry $options=null, JHttp $client=null, JFacebookOAuth $oauth=null)
 
 sendRequest ($path, $data='', array $headers=null, $limit=0, $offset=0, $until=null, $since=null)
 
 get ($object)
 
 getConnection ($object, $connection=null, $extraFields='', $limit=0, $offset=0, $until=null, $since=null)
 
 createConnection ($object, $connection=null, $parameters=null, array $headers=null)
 
 deleteConnection ($object, $connection=null, $extraFields='')
 
 setOAuth ($oauth)
 
 getOAuth ()
 

Membres hérités additionnels

- Fonctions membres protégées hérités de JFacebookObject
 fetchUrl ($path, $limit=0, $offset=0, $until=null, $since=null)
 
- Attributs protégés hérités de JFacebookObject
 $options
 
 $client
 
 $oauth
 

Description détaillée

Facebook API Photo class for the Joomla Platform.

3.2.0 deprecated 302.

Documentation des fonctions membres

◆ createComment()

createComment (   $photo,
  $message 
)

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

Paramètres
string$photoThe photo id.
string$messageThe comment's text.
Renvoie
mixed The decoded JSON response or false if the client is not authenticated.
Depuis
3.2.0

Références $data, et $message.

◆ createLike()

createLike (   $photo)

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

Paramètres
string$photoThe photo id.
Renvoie
boolean Returns true if successful, and false otherwise.
Depuis
3.2.0

◆ createTag()

createTag (   $photo,
  $to = null,
  $tagText = null,
  $x = null,
  $y = null 
)

Method to tag one or more Users in a photo. $to or $tagText required. Requires authentication and publish_stream permission, user_photos permission for private photos.

Paramètres
string$photoThe photo id.
mixed$toID of the User or an array of Users to tag in the photo: [{"id":"1234"}, {"id":"12345"}].
string$tagTextA text string to tag.
integer$xx coordinate of tag, as a percentage offset from the left edge of the picture.
integer$yy coordinate of tag, as a percentage offset from the top edge of the picture.
Renvoie
boolean Returns true if successful, and false otherwise.
Depuis
3.2.0

Références $data.

◆ deleteComment()

deleteComment (   $comment)

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

Paramètres
string$commentThe comment's id.
Renvoie
boolean Returns true if successful, and false otherwise.
Depuis
3.2.0

◆ deleteLike()

deleteLike (   $photo)

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

Paramètres
string$photoThe photo id.
Renvoie
boolean Returns true if successful, and false otherwise.
Depuis
3.2.0

◆ getComments()

getComments (   $photo,
  $limit = 0,
  $offset = 0,
  $until = null,
  $since = null 
)

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

Paramètres
string$photoThe photo id.
integer$limitThe number of objects per page.
integer$offsetThe object's number on the page.
string$untilA unix timestamp or any date accepted by strtotime.
string$sinceA unix timestamp or any date accepted by strtotime.
Renvoie
mixed The decoded JSON response or false if the client is not authenticated.
Depuis
3.2.0

Références $limit, et $offset.

◆ getLikes()

getLikes (   $photo,
  $limit = 0,
  $offset = 0,
  $until = null,
  $since = null 
)

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

Paramètres
string$photoThe photo id.
integer$limitThe number of objects per page.
integer$offsetThe object's number on the page.
string$untilA unix timestamp or any date accepted by strtotime.
string$sinceA unix timestamp or any date accepted by strtotime.
Renvoie
mixed The decoded JSON response or false if the client is not authenticated.
Depuis
3.2.0

Références $limit, et $offset.

◆ getPhoto()

getPhoto (   $photo)

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

Paramètres
string$photoThe photo id.
Renvoie
mixed The decoded JSON response or false if the client is not authenticated.
Depuis
3.2.0

◆ getPicture()

getPicture (   $photo,
  $redirect = true 
)

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

Paramètres
string$photoThe photo id.
boolean$redirectIf false this will return the URL of the picture without a 302 redirect.
Renvoie
string URL of the picture.
Depuis
3.2.0

◆ getTags()

getTags (   $photo,
  $limit = 0,
  $offset = 0,
  $until = null,
  $since = null 
)

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

Paramètres
string$photoThe photo id.
integer$limitThe number of objects per page.
integer$offsetThe object's number on the page.
string$untilA unix timestamp or any date accepted by strtotime.
string$sinceA unix timestamp or any date accepted by strtotime.
Renvoie
mixed The decoded JSON response or false if the client is not authenticated.
Depuis
3.2.0

Références $limit, et $offset.

◆ updateTag()

updateTag (   $photo,
  $to,
  $x = null,
  $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.

Paramètres
string$photoThe photo id.
string$toID of the User to update tag in the photo.
integer$xx coordinate of tag, as a percentage offset from the left edge of the picture.
integer$yy coordinate of tag, as a percentage offset from the top edge of the picture.
Renvoie
boolean Returns true if successful, and false otherwise.
Depuis
3.2.0

Références $data.


La documentation de cette classe a été générée à partir du fichier suivant :