Bugzilla::User methods for obtaining user ID info

[Gervase Markham]

Hi everyone,

Bugzilla::User has a variety of methods which return information about
the user:

name():     returns the real name, the DB 'realname' value.

login():    returns the DB 'login_name' value.

email():    returns the value of login() plus the emailsuffix.

identity(): returns the string "name() <login()>".

nick():     returns the part of login before the @ sign.

Is there documentation anywhere about the appropriate context in which
to use each of these?

http://www.bugzilla.org/docs/4.4/en/html/api/Bugzilla/User.html#Other_Methods
does not give much of a clue, although it hints that perhaps login() and
email() are distinct because one could have login names which were not
email-based.

It seems that sometimes in the code and templates, login() is used, and
sometimes email() is used. I would expect perhaps email() to be used
only when we were sending email, but that's not the case.

I would like to get some clarity on which of these should be used in
which context, and see if we can update the code to match. Does anyone
have any insight from history?

Gerv
_______________________________________________
dev-apps-bugzilla mailing list
dev-apps-bugzilla at lists.mozilla.org
https://lists.mozilla.org/listinfo/dev-apps-bugzilla