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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
|
=encoding utf8
=head1 NAME
User::Identity::Item - general base class for User::Identity
=head1 INHERITANCE
User::Identity::Item is extended by
Mail::Identity
User::Identity
User::Identity::Archive
User::Identity::Collection
User::Identity::Location
User::Identity::System
=head1 SYNOPSIS
=head1 DESCRIPTION
The C<User::Identity::Item> base class is extended into useful modules: it
has no use by its own.
=head1 METHODS
=head2 Constructors
=over 4
=item $class-E<gt>B<new>( [$name], %options )
Z<>
-Option --Default
description undef
name <required>
parent undef
=over 2
=item description => STRING
Free format description on the collected item.
=item name => STRING
A simple name for this item. Try to give a useful name in the context of
the item time. Each time when you lookup items, you need to specify
this name, so it should be unique and not to hard to handle in your program.
For instance, when a person is addressed, you usually will give him/her
this a nickname.
=item parent => OBJECT
The encapsulating object: the object which collects this one.
=back
=back
=head2 Attributes
=over 4
=item $obj-E<gt>B<description>()
Free format description on this item. Please do not add
any significance to the content of this field: if you are in need
for an extra attribute, please contact the author of the module to
implement it, or extend the object to suit your needs.
=item $obj-E<gt>B<name>( [$newname] )
The new name of this item. Names are unique within a collection... a
second object with the same name within any collection will destroy the
already existing object with that name.
Changing the name of an item is quite dangerous. You probably want to
call L<User::Identity::Collection::renameRole()|User::Identity::Collection/"Maintaining roles"> instead.
=back
=head2 Collections
=over 4
=item $obj-E<gt>B<add>($collection, $role)
The C<$role> is added to the C<$collection>. The C<$collection> is the name of a
collection, which will be created automatically with L<addCollection()|User::Identity::Item/"Collections"> if
needed. The C<$collection> can also be specified as existing collection object.
The C<$role> is anything what is acceptable to
L<User::Identity::Collection::addRole()|User::Identity::Collection/"Maintaining roles"> of the
collection at hand, and is returned. C<$role> typically is a list of
parameters for one role, or a reference to an array containing these
values.
example:
my $ui = User::Identity->new(...);
my $home = $ui->add(location => [home => street => '27 Roadstreet', ...] );
my $work = $ui->add(location => work, tel => '+31-2231-342-13', ... );
my $travel = User::Identity::Location->new(travel => ...);
$ui->add(location => $travel);
my $system = User::Identity::Collection::System->new(...);
$ui->add($system => 'localhost');
=item $obj-E<gt>B<addCollection>( $object | <[$type], %options> )
Add a new collection of roles to an item. This can be achieved in two ways:
either create an L<User::Identity::Collection|User::Identity::Collection> C<$object> yourself and then
pass that to this method, or supply all the C<%options> needed to create such
an object and it will be created for you. The object which is added is
returned, and can be used for many methods directly.
For C<%options>, see the specific type of collection. Additional options are
listed below.
-Option--Default
type <required>
=over 2
=item type => STRING|CLASS
The nickname of a collection class or the CLASS name itself of the
object to be created. Required if an object has to be created.
Predefined type nicknames are C<email>, C<system>, and C<location>.
=back
example:
my $me = User::Identity->new(...);
my $locs = User::Identity::Collection::Locations->new();
$me->addCollection($locs);
my $email = $me->addCollection(type => 'email');
my $email = $me->addCollection('email');
=item $obj-E<gt>B<collection>($name)
In scalar context the collection object with the C<$name> is returned.
In list context, all the roles within the collection are returned.
example:
my @roles = $me->collection('email'); # list of collected items
my @roles = $me->collection('email')->roles; # same of collected items
my $coll = $me->collection('email'); # a User::Identity::Collection
=item $obj-E<gt>B<parent>( [$parent] )
Returns the parent of an Item (the enclosing item). This may return C<undef>
if the object is stand-alone.
=item $obj-E<gt>B<removeCollection>($object|$name)
Z<>
=item $any-E<gt>B<type>()
Returns a nice symbolic name for the type.
=item $obj-E<gt>B<user>()
Go from this object to its parent, to its parent, and so on, until a
L<User::Identity|User::Identity> is found or the top of the object tree has been
reached.
example:
print $email->user->fullName;
=back
=head2 Searching
=over 4
=item $obj-E<gt>B<find>($collection, $role)
Returns the object with the specified C<$role> within the named collection.
The collection can be specified as name or object.
example:
my $role = $me->find(location => 'work'); # one location
my $role = $me->collection('location')->find('work'); # same
my $email = $me->addCollection('email');
$me->find($email => 'work');
$email->find('work'); # same
=back
=head1 DIAGNOSTICS
=over 4
=item Error: $object is not a collection.
The first argument is an object, but not of a class which extends
L<User::Identity::Collection|User::Identity::Collection>.
Cast by addCollection()
=item Error: Cannot load collection module for $type ($class).
Either the specified C<$type> does not exist, or that module named C<$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.
Cast by addCollection()
=item Error: Creation of a collection via $class failed.
The C<$class> did compile, but it was not possible to create an object
of that class using the options you specified.
Cast by addCollection()
=item Error: Don't know what type of collection you want to add.
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.
Cast by addCollection()
=item Error: Each item requires a name
You have to specify a name for each item. These names need to be
unique within one collection, but feel free to give the same name
to an e-mail address and a location.
Cast by new()
=item Warning: No collection $name
The collection with C<$name> does not exist and can not be created.
Cast by add()
=item Warning: Unknown option $name for a $class
One used option is not defined. Check the manual page of the class to
see which options are accepted.
Cast by new()
=item Warning: Unknown options @names for a $class
More than one option is not defined.
Cast by new()
=back
=head1 SEE ALSO
This module is part of User-Identity version 1.03,
built on September 12, 2025. Website: F<http://perl.overmeer.net/CPAN/>
=head1 LICENSE
For contributors see file ChangeLog.
This software is copyright (c) 2003-2025 by Mark Overmeer.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
|
