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

DIAGNOSTICS

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

LICENSE

167       Copyrights 2003,2004,2007-2009 by Mark Overmeer <perl@overmeer.net>.
168       For other contributors see Changes.
169
170       This program is free software; you can redistribute it and/or modify it
171       under the same terms as Perl itself.  See
172       http://www.perl.com/perl/misc/Artistic.html
173
174
175
176perl v5.12.1                      2009-12-2U4ser::Identity::Collection::Users(3)