13.12.5 SearchAccount::addRoleFilter()

Cette méthode permet de rechercher les comptes qui possède un rôle.

13.12.5.1 Description

void addRoleFilter( string $roleName )

La méthode permet d'ajouter un filtre à la recherche, l'argument roleName est basé sur l'identifiant (colonne login) du rôle.

Note : Il est possible de rechercher sur plusieurs rôles en utilisant plusieurs fois la méthode.

Note : Le rôle étant propagé par les groupes, les membres des groupes ayant le rôle sont aussi retournés.

Note : Si cette méthode est combinée à la méthode SearchAccount::addGroupFilter cela indique tous les comptes qui appartiennent à un des groupes cités ou à un des rôles cités.

13.12.5.1.1 Avertissements

Aucun

13.12.5.2 Liste des paramètres

(string) roleName
Nom de la référence (colonne login) du rôle de référence.

13.12.5.3 Valeur de retour

void

13.12.5.4 Erreurs / Exceptions

Si jamais la référence du rôle demandé n'existe pas alors une exception de type Dcp\Sacc\Exception est levée.

13.12.5.5 Historique

Aucun

13.12.5.6 Exemple

Avoir la liste des utilisateurs et des groupes ayant le rôle cash:

$searchAccount = new SearchAccount();
$searchAccount->addRoleFilter("cash");
$accountList = $searchAccount->search();
foreach ($accountList as $account) {
    printf("%s (type : %s)\n", $account->login, $account->accounttype);
}

Résultat :

george.abitbol (type : U)
zoo.cashone (type : U)
zoo.cashtwo (type : U)

13.12.5.7 Notes

Seuls les comptes "user" et "groupe" peuvent être retournés avec ce filtre. Les rôles n'ont pas de rôles associé.

13.12.5.8 Voir aussi

×
nouveauté