13.12.6 SearchAccount::getLoginFromDocName()

Cette méthode permet de récupérer un identifiant de compte depuis un nom logique de document.

13.12.6.1 Description

string|null getLoginFromDocName( string $name )

L'identifiant retourné correspond à la colonne login de la table users. La méthode est static, elle peut être utilisée sans instancier d'objet SearchAccount.

13.12.6.1.1 Avertissements

Aucun

13.12.6.2 Liste des paramètres

(string) name
Nom logique du document contenant la référence vers le account.

13.12.6.3 Valeur de retour

string : identifiant du compte (colonne login).

13.12.6.4 Erreurs / Exceptions

S'il n'existe pas de compte associé au nom logique alors null est renvoyé.

13.12.6.5 Historique

Aucun

13.12.6.6 Exemple

print "\nLe nom logique n'existe pas\n";
var_export(SearchAccount::getLoginFromDocName("toto"));
print "\nLe nom logique existe mais le document associé n'est pas lié à un account\n";;
var_export(SearchAccount::getLoginFromDocName("TEST"));
print "\n";
print "Le nom logique existe et est associé à un document qui est associé à un account\n";
var_export(SearchAccount::getLoginFromDocName("ZOO_ROLE_VETO"));

Résultat :

Le nom logique n'existe pas
false
Le nom logique existe mais le document associé n'est pas lié à un account
false
Le nom logique existe et est associé à un document qui est associé à un account
'veto'

13.12.6.7 Notes

Aucunes

13.12.6.8 Voir aussi

×
nouveauté