1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
|
# ------------------------------------------------------------------------------
# Copyright (C) 2006-2021 British Crown (Met Office) & Contributors.
#
# This file is part of FCM, tools for managing and building source code.
#
# FCM is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# FCM is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with FCM. If not, see <http://www.gnu.org/licenses/>.
# ------------------------------------------------------------------------------
use strict;
use warnings;
package FCM::Admin::User;
use base qw{FCM::Class::HASH};
use overload q{""} => \&get_name;
__PACKAGE__->class({
name => '$',
display_name => '$',
email => '$',
});
1;
__END__
=head1 NAME
FCM::Admin::User
=head1 SYNOPSIS
use FCM::Admin::User;
$user = FCM::Admin::User->new({name => 'bob'});
$user->set_display_name('Robert Smith');
$user->set_email('robert.smith@somewhere.org');
=head1 DESCRIPTION
An object of this class is used to store the data model of a user.
=head1 METHODS
=over 4
=item FCM::Admin::User->new(\%arguments)
Creates a new instance. The keys of the %argument hash may contain "name",
"display_name", and/or "email".
=item $user->get_name()
Returns the name/ID of the user.
=item $user->get_display_name()
Returns the display name of the user.
=item $user->get_email()
Returns the e-mail address of the user.
=item $user->set_name($value)
Sets the name/ID of the user.
=item $user->set_display_name($value)
Sets the display name of the user.
=item $user->set_email($value)
Sets the e-mail address of the user.
=back
=head1 COPYRIGHT
Copyright (C) 2006-2021 British Crown (Met Office) & Contributors.
=cut
|
