Référence de la classe Zphotos_Album

Graphe d'héritage de Zphotos_Album:
Zphotos_Data

Fonctions membres publiques

Accessors

 getPhotos ()
 getFirstPhoto ()
 getRandomPhoto ()
 getPhotosNumber ()
 getAlbums ()
 getAlbumsNumber ()
 hasAlbums ()
 isRootAlbum ()
 getUrl ()
 getBaseUrl ()
 isEmpty ()
Sort methods

 sortAlbums ()
 sortPhotos ()
Pagging methods

 setPhotosNumberByPage ($maxSize)
 getPhotosNumberByPage ()
 hasSeveralPages ()
 getPagesNumber ()
 hasNextPage ()
 getNextPageUrl ()
 hasPreviousPage ()
 getPreviousPageUrl ()
 getPageUrlForPhoto ($photo)
 getPageUrl ()
Photo methods

 searchPhoto ($name)
 hasNextPhoto ($photo)
 getNextPhoto ($photo)
 hasPreviousPhoto ($photo)
 getPreviousPhoto ($photo)
Public methods

 searchAlbum ($path)

Constructor



 __construct ($path, &$album, &$options)

Documentation des constructeurs et destructeur

__construct ( path,
&$  album,
&$  options 
)

Constructeur.

Paramètres:
$path,le chemin vers le dossier de l'album. (chaîne de caractères)
$album,l'album parent. (objet Zphotos_Album)
$options,les options de Zphotos Express. (objet Zphotos_Options)

Réimplémentée à partir de Zphotos_Data.


Documentation des fonctions membres

getAlbums (  ) 
Renvoie:
la liste des sous-albums. (tableau d'objet Album)
Voir également:
getAlbumsNumber()
getAlbumsNumber (  ) 
Renvoie:
le nombre de sous-albums. (nombre)
Voir également:
getAlbums()
getBaseUrl (  ) 
Note:
Cette url a pour but d'être completée par un sous-album, une photo, etc.
Renvoie:
l'url de base de l'album. Elle
getFirstPhoto (  ) 
Note:
Cette méthode peut être utile pour présenter l'album.
Renvoie:
la première photo de l'album, ou s'il est vide, d'un des sous-albums. (objet Photo)
Voir également:
getRandomPhoto()
getNextPageUrl (  ) 
Renvoie:
l'url de la page suivante. (chaîne de caractères)
Voir également:
hasNextPage()
getPageUrl()
À faire:
supprimer les référence à $this->page
getNextPhoto ( photo  ) 
Paramètres:
photo en question. (objet Photo)
Renvoie:
la photo suivante de la photo passée en paramètre. (objet Photo)
Voir également:
hasNextPhoto()
getPagesNumber (  ) 
Renvoie:
le nombre de pages de photo dans l'album. (booléen)
Voir également:
setPhotosNumberByPage()
getPageUrl (  ) 
Paramètres:
numero de la page. (nombre) (facultatif, page courante par defaut)
Renvoie:
l'url de la page recherchée. (chaîne de caractères)
getPageUrlForPhoto ( photo  ) 
Paramètres:
la photo dont on cherche la page. (objet Photo)
Renvoie:
l'url de la page contenant d'une photo donnée. (chaîne de caractères)
Voir également:
getPageUrl()
getPhotos (  ) 
Paramètres:
le numero de la page. (nombre) (facultatif)
Renvoie:
la liste des photos de la page de l'album. (tableau d'objets Photo)
Voir également:
getPhotosNumber()
getFirstPhoto()
getRandomPhoto()
getPhotosNumber (  ) 
Renvoie:
le nombre de photos présentes dans l'album. (nombre)
Voir également:
getPhotos()
getPhotosNumberByPage (  ) 
Renvoie:
le nombre de photos à afficher par page, 0 si ce n'est pas limité. (nombre)
getPreviousPageUrl (  ) 
Renvoie:
l'url de la page precedente. (chaîne de caractères)
Voir également:
hasPreviousPage()
getPageUrl()
getPreviousPhoto ( photo  ) 
Paramètres:
photo en question. (objet Photo)
Renvoie:
la photo précédente de la photo passée en paramètre. (objet Photo)
Voir également:
hasPreviousPhoto()
getRandomPhoto (  ) 
Note:
Cette méthode peut être utile pour présenter l'album.
Renvoie:
une photo aléatoire parmi l'album, ou s'il est vide, des sous-albums. (objet Photo)
Voir également:
getFirstPhoto()
getUrl (  ) 
Renvoie:
l'url de l'album. (chaîne de caractères)
Voir également:
getBaseUrl()
hasAlbums (  ) 
Renvoie:
vrai si cet album est un parent de l'album courant. (booleen)
hasNextPage (  ) 
Renvoie:
vrai si la page courante a une page suivante. (booléen)
Voir également:
getNextPageUrl()
hasNextPhoto ( photo  ) 

Est-ce qu'une photo donnée a une photo suivante ?

Paramètres:
photo en question. (objet Photo)
Renvoie:
vrai si la photo passée en parametre a une photo suivante. (booleen)
Voir également:
getNextPhoto()
hasPreviousPage (  ) 
Renvoie:
vrai si la page courante a une page precedente. (booléen)
Voir également:
getPreviousPageUrl()
hasPreviousPhoto ( photo  ) 

Est-ce qu'une photo donnée a une photo précédente ?

Paramètres:
photo en question. (objet Photo)
Renvoie:
vrai si la photo passée en parametre a une photo précédente. (booleen)
Voir également:
getPreviousPhoto()
hasSeveralPages (  ) 
Renvoie:
vrai s'il y a plusieurs pages de photos. (booléen)
Voir également:
getPagesNumber()
isEmpty (  ) 

Est-ce que l'album est vide, c'est-a-dire ne contient aucune photo ?

Paramètres:
est-ce que vous voulez savoir si mes sous-albums sont vides également ? (booleen) (facultatif, faux par defaut)
Renvoie:
vrai si l'album est vide. (booleen)
isRootAlbum (  ) 
Renvoie:
vrai si cet album est l'album racine. (booleen)
searchAlbum ( path  ) 
Paramètres:
$path,le chemin correspondant à l'album recherché. (chaîne de caratères)
Renvoie:
l'album qui correspond au chemin passé en paramètre. (objet Album)
searchPhoto ( name  ) 
Paramètres:
nom de la photo recherchée. (chaîne de caractères)
Renvoie:
la photo qui correcpond au nom passé en paramètre. (objet Photo)
setPhotosNumberByPage ( maxSize  ) 

Change le nombre de photo à afficher par page.

Note:
Si vous ne voulez pas de système de page, il faut le mettre à 0.
Paramètres:
nombre maximum de photos a afficher par page. (nombre)
sortAlbums (  ) 

Trie les sous-albums

Paramètres:
le critère, peut prendre comme valeur 'name' ou 'date'. (chaîne de caractères) (facultatif, 'name', par defaut)
voulez-vous trier a l'envers ? (booleen) (facultatif, faux par defaut)
dois-je trier mes sous-albums egalement ? (booleen) (facultatif, faux par defaut)
Voir également:
sortPhotos()
sortPhotos (  ) 

Trie les photos

Paramètres:
le critère, peut prendre comme valeur 'name' ou 'date'. (chaîne de caractères) (facultatif, 'name', par defaut)
voulez-vous trier a l'envers ? (booleen) (facultatif, faux par defaut)
dois-je trier les photos de mes sous-albums egalement ? (booleen) (facultatif, faux par defaut)
Voir également:
sortAlbums()

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