Constructor & Destructor Documentation
__construct |
( |
$ |
path, |
|
|
&$ |
album, |
|
|
&$ |
options | |
|
) |
| | |
Constructeur.
- Parameters:
-
| $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) |
Reimplemented from Zphotos_Data.
Member Function Documentation
- Returns:
- le nombre de sous-albums. (nombre)
- See also:
- getAlbums()
- Note:
- Cette url a pour but d'être completée par un sous-album, une photo, etc.
- Returns:
- l'url de base de l'album. Elle
- Note:
- Cette méthode peut être utile pour présenter l'album.
- Returns:
- la première photo de l'album, ou s'il est vide, d'un des sous-albums. (objet Photo)
- See also:
- getRandomPhoto()
- Parameters:
-
| photo | en question. (objet Photo) |
- Returns:
- la photo suivante de la photo passée en paramètre. (objet Photo)
- See also:
- hasNextPhoto()
- Parameters:
-
| numero | de la page. (nombre) (facultatif, page courante par defaut) |
- Returns:
- l'url de la page recherchée. (chaîne de caractères)
getPageUrlForPhoto |
( |
$ |
photo |
) |
|
- Parameters:
-
| la | photo dont on cherche la page. (objet Photo) |
- Returns:
- l'url de la page contenant d'une photo donnée. (chaîne de caractères)
- See also:
- getPageUrl()
- Returns:
- le nombre de photos présentes dans l'album. (nombre)
- See also:
- getPhotos()
getPhotosNumberByPage |
( |
|
) |
|
- Returns:
- le nombre de photos à afficher par page, 0 si ce n'est pas limité. (nombre)
getPreviousPhoto |
( |
$ |
photo |
) |
|
- Parameters:
-
| photo | en question. (objet Photo) |
- Returns:
- la photo précédente de la photo passée en paramètre. (objet Photo)
- See also:
- hasPreviousPhoto()
- Note:
- Cette méthode peut être utile pour présenter l'album.
- Returns:
- une photo aléatoire parmi l'album, ou s'il est vide, des sous-albums. (objet Photo)
- See also:
- getFirstPhoto()
- Returns:
- l'url de l'album. (chaîne de caractères)
- See also:
- getBaseUrl()
- Returns:
- vrai si cet album est un parent de l'album courant. (booleen)
- Returns:
- vrai si la page courante a une page suivante. (booléen)
- See also:
- getNextPageUrl()
Est-ce qu'une photo donnée a une photo suivante ?
- Parameters:
-
| photo | en question. (objet Photo) |
- Returns:
- vrai si la photo passée en parametre a une photo suivante. (booleen)
- See also:
- getNextPhoto()
hasPreviousPhoto |
( |
$ |
photo |
) |
|
Est-ce qu'une photo donnée a une photo précédente ?
- Parameters:
-
| photo | en question. (objet Photo) |
- Returns:
- vrai si la photo passée en parametre a une photo précédente. (booleen)
- See also:
- getPreviousPhoto()
- Returns:
- vrai s'il y a plusieurs pages de photos. (booléen)
- See also:
- getPagesNumber()
Est-ce que l'album est vide, c'est-a-dire ne contient aucune photo ?
- Parameters:
-
| est-ce | que vous voulez savoir si mes sous-albums sont vides également ? (booleen) (facultatif, faux par defaut) |
- Returns:
- vrai si l'album est vide. (booleen)
- Returns:
- vrai si cet album est l'album racine. (booleen)
- Parameters:
-
| $path,le | chemin correspondant à l'album recherché. (chaîne de caratères) |
- Returns:
- l'album qui correspond au chemin passé en paramètre. (objet Album)
- Parameters:
-
| nom | de la photo recherchée. (chaîne de caractères) |
- Returns:
- 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.
- Parameters:
-
| nombre | maximum de photos a afficher par page. (nombre) |
Trie les sous-albums
- Parameters:
-
| 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) |
- See also:
- sortPhotos()
Trie les photos
- Parameters:
-
| 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) |
- See also:
- sortAlbums()
The documentation for this class was generated from the following file: