libuser-identity-perl 0.93-1 / usr / share / perl5 / User / Identity.pod

=head1 NAME

User::Identity - maintains info about a physical person

=head1 INHERITANCE

 User::Identity
   is a User::Identity::Item

=head1 SYNOPSIS

 use User::Identity;
 my $me = User::Identity->new
  ( 'john'
  , firstname => 'John'
  , surname   => 'Doe'
  );
 print $me->fullName  # prints "John Doe"
 print $me;           # same

=head1 DESCRIPTION

The C<User::Identity> object is created to maintain a set of informational
objects which are related to one user.  The C<User::Identity> module tries to
be smart providing defaults, conversions and often required combinations.

The identities are not implementing any kind of storage, and can therefore
be created by any simple or complex Perl program.  This way, it is more
flexible than an XML file to store the data.  For instance, you can decide
to store the data with Data::Dumper, Storable, DBI, AddressBook
or whatever.  Extension to simplify this task are still to be developed.

If you need more kinds of user information, then please contact the
module author.

=head1 OVERLOADED

$obj-E<gt>B<stringification>

=over 4

When an C<User::Identity> is used as string, it is automatically
translated into the fullName() of the user involved.

example: 

 my $me = User::Identity->new(...)
 print $me;          # same as  print $me->fullName
 print "I am $me\n"; # also stringification

=back

=head1 METHODS

=head2 Constructors

User::Identity-E<gt>B<new>([NAME], OPTIONS)

=over 4

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  undef
 prefix                        undef
 surname                       undef
 titles                        undef

. birth => DATE

. charset => STRING

. courtesy => STRING

. description => STRING

. firstname => STRING

. formal_name => STRING

. full_name => STRING

. gender => STRING

. initials => STRING

. language => STRING

. name => STRING

. nickname => STRING

. parent => OBJECT

. prefix => STRING

. surname => STRING

. titles => STRING

=back

=head2 Attributes

$obj-E<gt>B<age>

=over 4

Calcuted from the datge of birth to the current moment, as integer.  On the
birthday, the number is incremented already.

=back

$obj-E<gt>B<birth>

=over 4

Returns the date in standardized format: YYYYMMDD, easy to sort and
select.  This may return C<undef>, even if the L<dateOfBirth()|User::Identity/"Attributes"> contains
a value, simply because the format is not understood. Month or day may
contain C<'00'> to indicate that those values are not known.

=back

$obj-E<gt>B<charset>

=over 4

The user's prefered character set, which defaults to the value of
LC_CTYPE environment variable.

=back

$obj-E<gt>B<courtesy>

=over 4

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.

=back

$obj-E<gt>B<dateOfBirth>

=over 4

Returns the date of birth, as specified during instantiation.

=back

$obj-E<gt>B<description>

=over 4

See L<User::Identity::Item/"Attributes">

=back

$obj-E<gt>B<firstname>

=over 4

Returns the first name of the user.  If it is not defined explicitly, it
is derived from the nickname, and than capitalized if needed.

=back

$obj-E<gt>B<formalName>

=over 4

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".

=back

$obj-E<gt>B<fullName>

=over 4

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.

=back

$obj-E<gt>B<gender>

=over 4

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.

=back

$obj-E<gt>B<initials>

=over 4

The initials, which may be derived from the first letters of the
firstname.

=back

$obj-E<gt>B<isFemale>

=over 4

See isMale(): return true if we are sure the user is a woman.

=back

$obj-E<gt>B<isMale>

=over 4

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.

=back

$obj-E<gt>B<language>

=over 4

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).

=back

$obj-E<gt>B<name>([NEWNAME])

=over 4

See L<User::Identity::Item/"Attributes">

=back

$obj-E<gt>B<nickname>

=over 4

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.

=back

$obj-E<gt>B<prefix>

=over 4

The words which are between the firstname (or initials) and the surname.

=back

$obj-E<gt>B<surname>

=over 4

Returns the surname of person, or C<undef> if that is not known.

=back

$obj-E<gt>B<titles>

=over 4

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.

=back

=head2 Collections

$obj-E<gt>B<add>(COLLECTION, ROLE)

=over 4

See L<User::Identity::Item/"Collections">

=back

$obj-E<gt>B<addCollection>(OBJECT | ([TYPE], OPTIONS))

=over 4

See L<User::Identity::Item/"Collections">

=back

$obj-E<gt>B<collection>(NAME)

=over 4

See L<User::Identity::Item/"Collections">

=back

$obj-E<gt>B<find>(COLLECTION, ROLE)

=over 4

See L<User::Identity::Item/"Collections">

=back

$obj-E<gt>B<parent>([PARENT])

=over 4

See L<User::Identity::Item/"Collections">

=back

$obj-E<gt>B<removeCollection>(OBJECT|NAME)

=over 4

See L<User::Identity::Item/"Collections">

=back

$obj-E<gt>B<type>

User::Identity-E<gt>B<type>

=over 4

See L<User::Identity::Item/"Collections">

=back

$obj-E<gt>B<user>

=over 4

See L<User::Identity::Item/"Collections">

=back

=head1 DIAGNOSTICS

Error: $object is not a collection.

=over 4

The first argument is an object, but not of a class which extends
L<User::Identity::Collection|User::Identity::Collection>.

=back

Error: Cannot load collection module for $type ($class).

=over 4

Either the specified $type does not exist, or that module named $class returns
compilation errors.  If the type as specified in the warning is not
the name of a package, you specified a nickname which was not defined.
Maybe you forgot the 'require' the package which defines the nickname.

=back

Error: Creation of a collection via $class failed.

=over 4

The $class did compile, but it was not possible to create an object
of that class using the options you specified.

=back

Error: Don't know what type of collection you want to add.

=over 4

If you add a collection, it must either by a collection object or a
list of options which can be used to create a collection object.  In
the latter case, the type of collection must be specified.

=back

Warning: No collection $name

=over 4

The collection with $name does not exist and can not be created.

=back

=head1 SEE ALSO

This module is part of User-Identity distribution version 0.93,
built on December 24, 2009. Website: F<http://perl.overmeer.net/userid/>

=head1 LICENSE

Copyrights 2003,2004,2007-2009 by Mark Overmeer <perl@overmeer.net>. For other contributors see Changes.

This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
See F<http://www.perl.com/perl/misc/Artistic.html>