Graphe d'héritage de JFacebookAlbum:

Graphe de collaboration de JFacebookAlbum:

Fonctions membres publiques
	getAlbum ($album)
	getPhotos ($album, $limit=0, $offset=0, $until=null, $since=null)
	createPhoto ($album, $source, $message=null)
	getComments ($album, $limit=0, $offset=0, $until=null, $since=null)
	createComment ($album, $message)
	deleteComment ($comment)
	getLikes ($album, $limit=0, $offset=0, $until=null, $since=null)
	createLike ($album)
	deleteLike ($album)
	getPicture ($album, $redirect=true)
Fonctions membres publiques inherited from JFacebookObject
	__construct (JRegistry $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, $extra_fields= '', $limit=0, $offset=0, $until=null, $since=null)
	createConnection ($object, $connection=null, $parameters=null, array $headers=null)
	deleteConnection ($object, $connection=null, $extra_fields= '')
	setOAuth ($oauth)
	getOAuth ()

Additional Inherited Members
Fonctions membres protégées inherited from JFacebookObject
	fetchUrl ($path, $limit=0, $offset=0, $until=null, $since=null)
Attributs protégés inherited from JFacebookObject
	$options
	$client
	$oauth

Description détaillée

Définition à la ligne 23 du fichier album.php.

Documentation des fonctions membres

JFacebookAlbum::createComment	(	$album,
		$message
	)

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

Paramètres:

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

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

Depuis:: 13.1

Définition à la ligne 110 du fichier album.php.

        {
                // Set POST request parameters.
                $data = array();
                $data['message'] = $message;
                return $this->createConnection($album, 'comments', $data);
        }

JFacebookAlbum::createLike ( $album )

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

Paramètres:

string $album The album id.

Renvoie:: boolean Returns true if successful, and false otherwise.

Depuis:: 13.1

Définition à la ligne 160 du fichier album.php.

        {
                return $this->createConnection($album, 'likes');
        }

JFacebookAlbum::createPhoto	(	$album,
		$source,
		$message = `null`
	)

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

Paramètres:

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

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

Depuis:: 13.1

Définition à la ligne 68 du fichier album.php.

        {
                // Set POST request parameters.
                $data = array();
                $data[basename($source)] = '@' . realpath($source);
                if ($message)
                {
                        $data['message'] = $message;
                }
                return $this->createConnection($album, 'photos', $data, array('Content-Type' => 'multipart/form-data'));
        }

JFacebookAlbum::deleteComment ( $comment )

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

Paramètres:

string $comment The comment's id.

Renvoie:: boolean Returns true if successful, and false otherwise.

Depuis:: 13.1

Définition à la ligne 128 du fichier album.php.

        {
                return $this->deleteConnection($comment);
        }

JFacebookAlbum::deleteLike ( $album )

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

Paramètres:

string $album The album id.

Renvoie:: boolean Returns true if successful, and false otherwise.

Depuis:: 13.1

Définition à la ligne 174 du fichier album.php.

        {
                return $this->deleteConnection($album, 'likes');
        }

JFacebookAlbum::getAlbum ( $album )

Method to get an album. Requires authentication and user_photos or friends_photos permission for private photos.

Paramètres:

string $album The album id.

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

Depuis:: 13.1

Définition à la ligne 34 du fichier album.php.

        {
                return $this->get($album);
        }

JFacebookAlbum::getComments	(	$album,
		$limit = `0`,
		$offset = `0`,
		$until = `null`,
		$since = `null`
	)

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

Paramètres:

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.

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

Depuis:: 13.1

Définition à la ligne 95 du fichier album.php.

        {
                return $this->getConnection($album, 'comments', '', $limit, $offset, $until, $since);
        }

JFacebookAlbum::getLikes	(	$album,
		$limit = `0`,
		$offset = `0`,
		$until = `null`,
		$since = `null`
	)

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

Paramètres:

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.

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

Depuis:: 13.1

Définition à la ligne 146 du fichier album.php.

        {
                return $this->getConnection($album, 'likes', '', $limit, $offset, $until, $since);
        }

JFacebookAlbum::getPhotos	(	$album,
		$limit = `0`,
		$offset = `0`,
		$until = `null`,
		$since = `null`
	)

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

Paramètres:

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.

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

Depuis:: 13.1

Définition à la ligne 52 du fichier album.php.

        {
                return $this->getConnection($album, 'photos', '', $limit, $offset, $until, $since);
        }

JFacebookAlbum::getPicture	(	$album,
		$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 user_photos or friends_photos permission for private photos.

Paramètres:

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

Renvoie:: string URL of the picture.

Depuis:: 13.1

Définition à la ligne 190 du fichier album.php.

        {
                $extra_fields = '';
                if ($redirect == false)
                {
                        $extra_fields = '?redirect=false';
                }
                return $this->getConnection($album, 'picture', $extra_fields);
        }

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

jplatform-13.1/joomla/facebook/album.php

Fonctions membres publiques

Additional Inherited Members

Description détaillée

Documentation des fonctions membres