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
18       Extends "DESCRIPTION" in User::Identity::Collection.
19

OVERLOADED

21       Extends "OVERLOADED" in User::Identity::Collection.
22
23       overload: @{}
24           Inherited, see "OVERLOADED" in User::Identity::Collection
25
26       overload: stringification
27           Inherited, see "OVERLOADED" in User::Identity::Collection
28

METHODS

30       Extends "METHODS" in User::Identity::Collection.
31
32   Constructors
33       Extends "Constructors" in User::Identity::Collection.
34
35       User::Identity::Collection::Users->new( [$name], %options )
36            -Option     --Defined in                --Default
37             description  User::Identity::Item        undef
38             item_type    User::Identity::Collection  User::Identity
39             name         User::Identity::Item        'people'
40             parent       User::Identity::Item        undef
41             roles        User::Identity::Collection  undef
42
43           description => STRING
44           item_type => CLASS
45           name => STRING
46           parent => OBJECT
47           roles => ROLE|ARRAY
48
49   Attributes
50       Extends "Attributes" in User::Identity::Collection.
51
52       $obj->description()
53           Inherited, see "Attributes" in User::Identity::Item
54
55       $obj->itemType()
56           Inherited, see "Attributes" in User::Identity::Collection
57
58       $obj->name( [$newname] )
59           Inherited, see "Attributes" in User::Identity::Item
60
61       $obj->roles()
62           Inherited, see "Attributes" in User::Identity::Collection
63
64   Collections
65       Extends "Collections" in User::Identity::Collection.
66
67       $obj->add($collection, $role)
68           Inherited, see "Collections" in User::Identity::Item
69
70       $obj->addCollection( $object | <[$type], %options> )
71           Inherited, see "Collections" in User::Identity::Item
72
73       $obj->collection($name)
74           Inherited, see "Collections" in User::Identity::Item
75
76       $obj->parent( [$parent] )
77           Inherited, see "Collections" in User::Identity::Item
78
79       $obj->removeCollection($object|$name)
80           Inherited, see "Collections" in User::Identity::Item
81
82       $obj->type()
83       User::Identity::Collection::Users->type()
84           Inherited, see "Collections" in User::Identity::Item
85
86       $obj->user()
87           Inherited, see "Collections" in User::Identity::Item
88
89   Maintaining roles
90       Extends "Maintaining roles" in User::Identity::Collection.
91
92       $obj->addRole($role| <[$name],%options> | ARRAY)
93           Inherited, see "Maintaining roles" in User::Identity::Collection
94
95       $obj->removeRole($role|$name)
96           Inherited, see "Maintaining roles" in User::Identity::Collection
97
98       $obj->renameRole( <$role|$oldname>, $newname )
99           Inherited, see "Maintaining roles" in User::Identity::Collection
100
101       $obj->sorted()
102           Inherited, see "Maintaining roles" in User::Identity::Collection
103
104   Searching
105       Extends "Searching" in User::Identity::Collection.
106
107       $obj->find($name|CODE|undef)
108           Inherited, see "Searching" in User::Identity::Collection
109

DIAGNOSTICS

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

LICENSE

150       Copyrights 2003-2020 by [Mark Overmeer <markov@cpan.org>]. For other
151       contributors see ChangeLog.
152
153       This program is free software; you can redistribute it and/or modify it
154       under the same terms as Perl itself.  See http://dev.perl.org/licenses/
155
156
157
158perl v5.32.1                      2021-01-2U7ser::Identity::Collection::Users(3)