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 an 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 selec‐
24       tions which can be stored.
25

OVERLOADED

METHODS

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

DIAGNOSTICS

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

LICENSE

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