User::Identity::Collection::Users(3pm)

1User::Identity::CollectUisoenr::CUosnetrrsi(b3u)ted PerlUsDeorc:u:mIednetnattiitoyn::Collection::Users(3)
2
3
4

NAME

6       User::Identity::Collection::Users - a collection of users
7

INHERITANCE

9        User::Identity::Collection::Users
10          is an User::Identity::Collection
11          is an User::Identity::Item
12

SYNOPSIS

DESCRIPTION

15       The User::Identity::Collection::Users object maintains a set
16       User::Identity objects, each describing a user.
17

OVERLOADED

19       overload: @{}
20
21           See "OVERLOADED" in User::Identity::Collection
22
23       overload: stringification
24
25           See "OVERLOADED" in User::Identity::Collection
26

METHODS

28       Constructors
29
30       User::Identity::Collection::Users->new([NAME], OPTIONS)
31
32        Option     --Defined in     --Default
33        description  User::Identity::Item  undef
34        item_type    User::Identity::Collection  User::Identity
35        name         User::Identity::Item  'people'
36        parent       User::Identity::Item  undef
37        roles        User::Identity::Collection  undef
38
39           . description STRING
40
41           . item_type CLASS
42
43           . name STRING
44
45           . parent OBJECT
46
47           . roles ROLE⎪ARRAY
48
49       Attributes
50
51       $obj->description
52
53           See "Attributes" in User::Identity::Item
54
55       $obj->itemType
56
57           See "Attributes" in User::Identity::Collection
58
59       $obj->name([NEWNAME])
60
61           See "Attributes" in User::Identity::Item
62
63       $obj->roles
64
65           See "Attributes" in User::Identity::Collection
66
67       Collections
68
69       $obj->add(COLLECTION, ROLE)
70
71           See "Collections" in User::Identity::Item
72
73       $obj->addCollection(OBJECT ⎪ ([TYPE], OPTIONS))
74
75           See "Collections" in User::Identity::Item
76
77       $obj->collection(NAME)
78
79           See "Collections" in User::Identity::Item
80
81       $obj->parent([PARENT])
82
83           See "Collections" in User::Identity::Item
84
85       $obj->removeCollection(OBJECT⎪NAME)
86
87           See "Collections" in User::Identity::Item
88
89       $obj->type
90
91       User::Identity::Collection::Users->type
92
93           See "Collections" in User::Identity::Item
94
95       $obj->user
96
97           See "Collections" in User::Identity::Item
98
99       Maintaining roles
100
101       $obj->addRole(ROLE⎪ ( [NAME],OPTIONS ) ⎪ ARRAY-OF-OPTIONS)
102
103           See "Maintaining roles" in User::Identity::Collection
104
105       $obj->removeRole(ROLE⎪NAME)
106
107           See "Maintaining roles" in User::Identity::Collection
108
109       $obj->renameRole(ROLE⎪OLDNAME, NEWNAME)
110
111           See "Maintaining roles" in User::Identity::Collection
112
113       $obj->sorted
114
115           See "Maintaining roles" in User::Identity::Collection
116
117       Searching
118
119       $obj->find(NAME⎪CODE⎪undef)
120
121           See "Searching" in User::Identity::Collection
122

DIAGNOSTICS

124       Error: $object is not a collection.
125
126       The first argument is an object, but not of a class which extends
127       User::Identity::Collection.
128
129       Error: Cannot create a $type to add this to my collection.
130
131       Some options are specified to create a $type object, which is native to
132       this collection.  However, for some reason this failed.
133
134       Error: Cannot load collection module for $type ($class).
135
136       Either the specified $type does not exist, or that module named $class
137       returns compilation errors.  If the type as specified in the warning is
138       not the name of a package, you specified a nickname which was not
139       defined.  Maybe you forgot the 'require' the package which defines the
140       nickname.
141
142       Error: Cannot rename $name into $newname: already exists
143
144       Error: Cannot rename $name into $newname: doesn't exist
145
146       Error: Creation of a collection via $class failed.
147
148       The $class did compile, but it was not possible to create an object of
149       that class using the options you specified.
150
151       Error: Don't know what type of collection you want to add.
152
153       If you add a collection, it must either by a collection object or a
154       list of options which can be used to create a collection object.  In
155       the latter case, the type of collection must be specified.
156
157       Warning: No collection $name
158
159       The collection with $name does not exist and can not be created.
160
161       Error: Wrong type of role for $collection: requires a $expect but got a
162       $type
163
164       Each $collection groups sets of roles of one specific type ($expect).
165       You cannot add objects of a different $type.
166

LICENSE

172       Copyrights 2003,2004,2007 by Mark Overmeer <perl@overmeer.net>.For
173       other contributors see Changes.
174
175       This program is free software; you can redistribute it and/or modify it
176       under the same terms as Perl itself.  See
177       http://www.perl.com/perl/misc/Artistic.html
178
179
180
181perl v5.8.8                       2007-01-0U8ser::Identity::Collection::Users(3)