User::Identity::Archive(3pm)

1User::Identity::ArchiveU(s3e)r Contributed Perl DocumentaUtsieorn::Identity::Archive(3)
2
3
4

NAME

6       User::Identity::Archive - base class for archiving user information
7

INHERITANCE

9        User::Identity::Archive
10          is a User::Identity::Item
11
12        User::Identity::Archive is extended by
13          User::Identity::Archive::Plain
14

SYNOPSIS

16        use User::Identity::Archive::Plain;
17        my $friends = User::Identity::Archive::Plain->new('friends');
18        $friends->from(\*FH);
19        $friends->from('.friends');
20

DESCRIPTION

22       An archive stores collections. It depends on the type of archive how
23       and where that is done.  Some archivers may limit the kinds of
24       selections which can be stored.
25

OVERLOADED

METHODS

28   Constructors
29       User::Identity::Archive->new([NAME], OPTIONS)
30
31        Option     --Defined in     --Default
32        description  User::Identity::Item  undef
33        from                          undef
34        name         User::Identity::Item  <required>
35        parent       User::Identity::Item  undef
36
37           . description => STRING
38
39           . from => FILEHANDLE|FILENAME
40
41           . name => STRING
42
43           . parent => OBJECT
44
45   Attributes
46       $obj->description
47
48           See "Attributes" in User::Identity::Item
49
50       $obj->name([NEWNAME])
51
52           See "Attributes" in User::Identity::Item
53
54   Collections
55       $obj->add(COLLECTION, ROLE)
56
57           See "Collections" in User::Identity::Item
58
59       $obj->addCollection(OBJECT | ([TYPE], OPTIONS))
60
61           See "Collections" in User::Identity::Item
62
63       $obj->collection(NAME)
64
65           See "Collections" in User::Identity::Item
66
67       $obj->find(COLLECTION, ROLE)
68
69           See "Collections" in User::Identity::Item
70
71       $obj->parent([PARENT])
72
73           See "Collections" in User::Identity::Item
74
75       $obj->removeCollection(OBJECT|NAME)
76
77           See "Collections" in User::Identity::Item
78
79       $obj->type
80
81       User::Identity::Archive->type
82
83           See "Collections" in User::Identity::Item
84
85       $obj->user
86
87           See "Collections" in User::Identity::Item
88
89   Access to the archive
90       $obj->from(SOURCE, OPTIONS)
91
92           Read definitions from the specified SOURCE, which usually can be a
93           filehandle or filename.  The syntax used in the information SOURCE
94           is archiver dependent.
95
96           Not all archivers implement "from()", so you may want to check with
97           "UNIVERSAL::can()" beforehand.
98
99           example:
100
101            use User::Identity::Archive::Some;
102            my $a = User::Identity::Archive::Some->new('xyz');
103            $a->from(\*STDIN) if $a->can('from');
104

DIAGNOSTICS

106       Error: $object is not a collection.
107
108           The first argument is an object, but not of a class which extends
109           User::Identity::Collection.
110
111       Error: Cannot load collection module for $type ($class).
112
113           Either the specified $type does not exist, or that module named
114           $class returns compilation errors.  If the type as specified in the
115           warning is not the name of a package, you specified a nickname
116           which was not defined.  Maybe you forgot the 'require' the package
117           which defines the nickname.
118
119       Error: Creation of a collection via $class failed.
120
121           The $class did compile, but it was not possible to create an object
122           of that class using the options you specified.
123
124       Error: Don't know what type of collection you want to add.
125
126           If you add a collection, it must either by a collection object or a
127           list of options which can be used to create a collection object.
128           In the latter case, the type of collection must be specified.
129
130       Warning: No collection $name
131
132           The collection with $name does not exist and can not be created.
133

LICENSE

139       Copyrights 2003,2004,2007-2009 by Mark Overmeer <perl@overmeer.net>.
140       For other contributors see Changes.
141
142       This program is free software; you can redistribute it and/or modify it
143       under the same terms as Perl itself.  See
144       http://www.perl.com/perl/misc/Artistic.html
145
146
147
148perl v5.12.1                      2009-12-24        User::Identity::Archive(3)