13.12.4 SearchAccount::addGroupFilter()
Cette méthode permet de rechercher les comptes qui appartiennent à un groupe.
13.12.4.1 Description
void addGroupFilter( string $groupName )
La méthode permet d'ajouter un filtre à la recherche, le groupName est basé sur le login du groupe.
Note : Il est possible de rechercher sur plusieurs groupes en utilisant plusieurs fois la méthode.
Note : La recherche par groupe prend aussi en compte les sous-groupes du groupe recherché.
Note : Si cette méthode est combinée à la méthode
SearchAccount::addRoleFilter cela filtre tous les comptes
qui appartiennent à un des groupes cités ou à un des rôles cités.
13.12.4.1.1 Avertissements
La recherche est basée sur l'objet account et pas sur l'objet documentaire associé au compte.
Par défaut, la recherche retourne des groupes et des utilisateurs, il est possible
de filtrer le type d'élément recherché à l'aide de
SearchAccount::setTypeFilter.
13.12.4.2 Liste des paramètres
- (string)
groupName - Nom de l'identifiant (colonne
login) du groupe de référence.
13.12.4.3 Valeur de retour
void
13.12.4.4 Erreurs / Exceptions
Si jamais le login de groupe demandé n'existe pas alors une exception de type
Dcp\Sacc\Exception est levée.
13.12.4.5 Historique
Aucun
13.12.4.6 Exemple
Avoir la liste des utilisateurs et des groupes contenus dans le groupe all:
$searchAccount = new SearchAccount(); $searchAccount->addGroupFilter("all"); $accountList = $searchAccount->search(); foreach ($accountList as $account) { printf("%s (type : %s)\n", $account->login, $account->accounttype); }
Résultat :
admin (type : U) care (type : G) gadmin (type : G) george.abitbol (type : U) georges.de.hanovre (type : U) georgette.agutte (type : U) security (type : G) zoo.cashone (type : U) zoo.cashtwo (type : U) zoo.garde (type : U) zoo.veto (type : U)
13.12.4.7 Notes
Un rôle ne peut pas être contenu dans un groupe d'utilisateur.