API de la BdU du SdE
 Tout Classes Fonctions Variables Pages
Référence de la classe Bdu_Entity_Association

Classe représentant une association. Plus de détails...

Fonctions membres publiques

 __construct ($id, $name, $description, $siteUrl, $logoUrl, Bdu_Util_UnitOfWork $unitOfWork)
 
 getId ()
 Retourne l'identifiant de l'association.
 
 getName ()
 Retourne le nom de l'association.
 
 getDescription ()
 Retourne la description de l'association.
 
 getSiteUrl ()
 Retourne l'url du site de l'association.
 
 getLogoUrl ()
 Retourne l'url du logo de l'association.
 
 getCurrentStudents ($retrieve=true)
 Retourne la liste des membres actuels.
 
 getAllStudents ($retrieve=true)
 Retourne la liste de tous les membres (actuels et anciens)
 
 getCurrentMandates ()
 Retourne la liste de tous les mandats en cours.
 
 getAllMandates ()
 Retourne la liste de tous les mandats, y compris ceux des anciens membres.
 
 getBoard ()
 Retourne les membres du bureau.
 

Description détaillée

Classe représentant une association.

Auteur
Pierre Pattard
Christophe Coevoet

Documentation des constructeurs et destructeur

Bdu_Entity_Association::__construct (   $id,
  $name,
  $description,
  $siteUrl,
  $logoUrl,
Bdu_Util_UnitOfWork  $unitOfWork 
)
Paramètres
integer$id
string$name
string$description
string$siteUrl
string$logoUrl
Bdu_Util_UnitOfWork$unitOfWork

Documentation des fonctions membres

Bdu_Entity_Association::getAllMandates ( )

Retourne la liste de tous les mandats, y compris ceux des anciens membres.

Renvoie
array Tableau d'objets Bdu_Entity_Mandate
Exceptions
Bdu_Exception_WebserviceConnectionFailedsi le webservice n'est pas accessible
Bdu_Exception_AssociationNotFoundsi l'association n'est pas trouvée
Bdu_Entity_Association::getAllStudents (   $retrieve = true)

Retourne la liste de tous les membres (actuels et anciens)

L'argument booléen $retrieve permet de récupérer les données de tous les membres en une seule requête ldap au lieu de faire une requête par élève. Si les propriétés autre que le login ne sont pas utile, utiliser false permettra d'éviter cette requête ldap. En revanche, si les propriétés des étudiants sont utilisées, les récupérer en une fois est beaucoup plus efficace.

Paramètres
boolean$retrieve
Renvoie
array Tableau d'objets Bdu_Entity_Student
Bdu_Entity_Association::getBoard ( )

Retourne les membres du bureau.

Renvoie
array Tableau d'objets Bdu_Entity_Mandate
Exceptions
Bdu_Exception_WebserviceConnectionFailedsi le webservice n'est pas accessible
Bdu_Exception_AssociationNotFoundsi l'association n'est pas trouvée
Bdu_Entity_Association::getCurrentMandates ( )

Retourne la liste de tous les mandats en cours.

Renvoie
array Tableau d'objets Bdu_Entity_Mandate
Exceptions
Bdu_Exception_WebserviceConnectionFailedsi le webservice n'est pas accessible
Bdu_Exception_AssociationNotFoundsi l'association n'est pas trouvée
Bdu_Entity_Association::getCurrentStudents (   $retrieve = true)

Retourne la liste des membres actuels.

L'argument booléen $retrieve permet de récupérer les données de tous les membres en une seule requête ldap au lieu de faire une requête par élève. Si les propriétés autre que le login ne sont pas utile, utiliser false permettra d'éviter cette requête ldap. En revanche, si les propriétés des étudiants sont utilisées, les récupérer en une fois est beaucoup plus efficace.

Paramètres
boolean$retrieve
Renvoie
array Tableau d'objets Bdu_Entity_Student
Bdu_Entity_Association::getDescription ( )

Retourne la description de l'association.

Renvoie
string
Bdu_Entity_Association::getId ( )

Retourne l'identifiant de l'association.

Renvoie
integer
Bdu_Entity_Association::getLogoUrl ( )

Retourne l'url du logo de l'association.

Renvoie
string
Bdu_Entity_Association::getName ( )

Retourne le nom de l'association.

Renvoie
string
Bdu_Entity_Association::getSiteUrl ( )

Retourne l'url du site de l'association.

Renvoie
string