13.12.12 SearchAccount::setTypeFilter()
Permet de filtrer pour ne retourner qu'un ou plusieurs types de comptes.
13.12.12.1 Description
void setTypeFilter ( int $type )
Le type utilise la notion de masque binaire. On peut donc rechercher à la fois :
- les utilisateurs,
- les groupes,
- les rôles.
Pour composer une recherche sur plusieurs types, on utilise l'opérateur PHP
binaire |.
13.12.12.1.1 Avertissements
Par défaut, tous les types de comptes sont retournés.
13.12.12.2 Liste des paramètres
- (int)
type -
Le type est un ou une composition des constantes de classes :
- userType : les comptes de type utilisateur,
- groupType : les comptes de type groupe;
- roleType : les comptes de type rôle.
13.12.12.3 Valeur de retour
void
13.12.12.4 Erreurs / Exceptions
Aucune
13.12.12.5 Historique
Aucun
13.12.12.6 Exemple
print "Without any type filter \n-----------------------\n"; $searchAccount = new SearchAccount(); $accountList = $searchAccount->search(); foreach ($accountList as $account) { printf("%s (type : %s)\n", $account->login, $account->accounttype); } print "\nOnly user \n-----------------------\n"; $searchAccount = new SearchAccount(); $searchAccount->setTypeFilter(SearchAccount::userType); $accountList = $searchAccount->search(); foreach ($accountList as $account) { printf("%s (type : %s)\n", $account->login, $account->accounttype); } print "\nGroup and role \n-----------------------\n"; $searchAccount = new SearchAccount(); $searchAccount->setTypeFilter(SearchAccount::groupType | SearchAccount::roleType); $accountList = $searchAccount->search(); foreach ($accountList as $account) { printf("%s (type : %s)\n", $account->login, $account->accounttype); }
Résultat :
Without any type filter ----------------------- admin (type : U) all (type : G) anonymous (type : U) care (type : G) cash (type : R) core_administrator (type : R) gadmin (type : G) security (type : G) surveillant (type : R) veto (type : R) zoo.cashone (type : U) zoo.cashtwo (type : U) zoo.garde (type : U) zoo.veto (type : U)
Only user ----------------------- admin (type : U) anonymous (type : U) zoo.cashone (type : U) zoo.cashtwo (type : U) zoo.garde (type : U) zoo.veto (type : U)
Group and role ----------------------- all (type : G) care (type : G) cash (type : R) core_administrator (type : R) gadmin (type : G) security (type : G) surveillant (type : R) veto (type : R)
13.12.12.7 Notes
Aucune.