API des groupes

De OviWiki
Révision de 5 mars 2009 à 19:51 par Paul (discussion | contributions) (Nouvelle page : == Fonctions == ===bab_getGroupsMembers()=== Retourne un tableau contenant les utilisateurs membres du ou des groupes $ids. *Le tableau contient pour chaque utilisateur son ID ( "id...)

(diff) ← Version précédente | Voir la version courante (diff) | Version suivante → (diff)
Aller à : navigation, rechercher

Fonctions

bab_getGroupsMembers()

Retourne un tableau contenant les utilisateurs membres du ou des groupes $ids.

  • Le tableau contient pour chaque utilisateur son ID ( "id" ), son email ("email") et son nom complet ("name")
function bab_getGroupsMembers($ids)
  • $ids :
    ID du groupe ou un tableau d'id de groupes

bab_isMemberOfGroup()

Vérifie si l'utilisateur est l'utilisateur courant ou l'utilisateur d'ID $userid est membre du groupe $group.

function bab_isMemberOfGroup($group, $userid="")
  • $group :
    ID du groupe ou chaîne contenant le nom du groupe
  • $userid :
    ID de l'utilisateur. Si vide le système utilise l'ID de l'utilisateur courant.


La fonction retourne l'id du groupe si l'utilisateur en fait parti, ou false

bab_attachUserToGroup()

Affecte un utilisateur à un groupe

function bab_attachUserToGroup($iduser, $idgroup)
  • $iduser :
    ID de l'utilisateur à affecter au groupe
  • $idgroup :
    ID du groupe

bab_detachUserFromGroup()

Détache un utilisateur d'un groupe. C'est à dire qu'il ne sera plus membre de ce groupe.

function bab_detachUserFromGroup($iduser, $idgroup)
  • $iduser :
    ID de l'utilisateur a enlever du groupe
  • $idgroup :
    ID du groupe

bab_getGroupName()

Obtenir le nom du groupe en fonction de son ID

function bab_getGroupName($id, $fpn=true)
  • $id :
    Id numérique du groupe
  • $fpn :
    Boolean qui permet de spécifier si le nom retourné contiens les groupes parents, si le paramètre n'est pas indiqué, le chemin complet vers le groupe est retourné.

bab_getGroups()

Obtenir la liste des groupes dans un tableau

function bab_getGroups($parent=BAB_REGISTERED_GROUP, $all=true)

bab_createGroup()

Créer un groupe d'utilisateurs

function bab_createGroup( $name, $description, $managerid, $parent = 1)

bab_updateGroup()

Modifier un groupe d'utilisateurs

function bab_updateGroup( $id, $name, $description, $managerid)

bab_removeGroup()

Supprimer un groupe d'utilisateurs (les utilisateurs ne sont pas supprimés)

function bab_removeGroup($id)