When an User::Identity
is used as string, it is automatically
translated into the fullName() of the user involved.
my $me = User::Identity->new(...) print $me; # same as print $me->fullName print "I am $me\n"; # also stringification
Create a new user identity, which will contain all data related to a single physical human being. Most user data can only be specified at object construction, because they should never change. A NAME may be specified as first argument, but also as option, one way or the other is required.
Option | Defined in | Default |
---|---|---|
birth | undef | |
charset | $ENV{LC_CTYPE} | |
courtesy | undef | |
description | User::Identity::Item | undef |
firstname | undef | |
formal_name | undef | |
full_name | undef | |
gender | undef | |
initials | undef | |
language | 'en' | |
name | User::Identity::Item | <required> |
nickname | undef | |
parent | User::Identity::Item |
|
prefix | undef | |
surname | undef | |
titles | undef |
Calcuted from the datge of birth to the current moment, as integer. On the birthday, the number is incremented already.
Returns the date in standardized format: YYYYMMDD, easy to sort and
select. This may return undef
, even if the dateOfBirth() contains
a value, simply because the format is not understood. Month or day may
contain '00'
to indicate that those values are not known.
The user's prefered character set, which defaults to the value of LC_CTYPE environment variable.
The courtesy is used to address people in a very formal way. Values are like "Mr.", "Mrs.", "Sir", "Frau", "Heer", "de heer", "mevrouw". This often provides a way to find the gender of someone addressed.
Returns the date of birth, as specified during instantiation.
Returns the first name of the user. If it is not defined explicitly, it is derived from the nickname, and than capitalized if needed.
Returns a formal name for the user. If not defined as instantiation parameter (see new()), it is constructed from other available information, which may result in an incorrect or an incomplete name. The result is built from "courtesy initials prefix surname title".
If this is not specified as value during object construction, it is guessed based on other known values like "firstname prefix surname". If a surname is provided without firstname, the nickname is taken as firstname. When a firstname is provided without surname, the nickname is taken as surname. If both are not provided, then the nickname is used as fullname.
Returns the specified gender of the person, as specified during instantiation, which could be like 'Male', 'm', 'homme', 'man'. There is no smart behavior on this: the exact specified value is returned. Methods isMale(), isFemale(), and courtesy() are smart.
The initials, which may be derived from the first letters of the firstname.
See isMale(): return true if we are sure the user is a woman.
Returns true if we are sure that the user is male. This is specified as gender at instantiation, or derived from the courtesy value. Methods isMale and isFemale are not complementatory: they can both return false for the same user, in which case the gender is undertermined.
Can contain a list or a single language name, as defined by the RFC Examples are 'en', 'en-GB', 'nl-BE'. The default language is 'en' (English).
Returns the user's nickname, which could be used as username, e-mail alias, or such. When no nickname was explicitly specified, the name is used.
The words which are between the firstname (or initials) and the surname.
Returns the surname of person, or undef
if that is not known.
The titles, degrees in education or of other kind. If these are complex, you may need to specify the formal name of the users as well, because smart formatting probably failes.