|
User::Identity::Archive - base class for archiving user information |
User::Identity::Archive - base class for archiving user information
User::Identity::Archive is a User::Identity::Item
User::Identity::Archive is extended by User::Identity::Archive::Plain
use User::Identity::Archive::Plain;
my $friends = User::Identity::Archive::Plain->new('friends');
$friends->from(\*FH);
$friends->from('.friends');
An archive stores collections. It depends on the type of archive how and where that is done. Some archivers may limit the kinds of selections which can be stored.
User::Identity::Archive->new([NAME], OPTIONS)
Option Defined in Default description L<User::Identity::Item> undef from C<undef> name L<User::Identity::Item> <required> parent L<User::Identity::Item> C<undef>
. description STRING
. from FILEHANDLE|FILENAME
. name STRING
. parent OBJECT
$obj->description
See Attributes in the User::Identity::Item manpage
$obj->name([NEWNAME])
See Attributes in the User::Identity::Item manpage
$obj->add(COLLECTION, ROLE)
See Collections in the User::Identity::Item manpage
$obj->addCollection(OBJECT | ([TYPE], OPTIONS))
See Collections in the User::Identity::Item manpage
$obj->collection(NAME)
See Collections in the User::Identity::Item manpage
$obj->find(COLLECTION, ROLE)
See Collections in the User::Identity::Item manpage
$obj->parent([PARENT])
See Collections in the User::Identity::Item manpage
$obj->removeCollection(OBJECT|NAME)
See Collections in the User::Identity::Item manpage
$obj->type
User::Identity::Archive->type
See Collections in the User::Identity::Item manpage
$obj->user
See Collections in the User::Identity::Item manpage
$obj->from(SOURCE, OPTIONS)
Read definitions from the specified SOURCE, which usually can be a filehandle or filename. The syntax used in the information SOURCE is archiver dependent.
Not all archivers implement from(), so you may want to check with
UNIVERSAL::can() beforehand.
Example:
use User::Identity::Archive::Some;
my $a = User::Identity::Archive::Some->new('xyz');
$a->from(\*STDIN) if $a->can('from');
Error: $object is not a collection.
The first argument is an object, but not of a class which extends User::Identity::Collection.
Error: Cannot load collection module for $type ($class).
Either the specified $type does not exist, or that module named $class returns compilation errors. If the type as specified in the warning is not the name of a package, you specified a nickname which was not defined. Maybe you forgot the 'require' the package which defines the nickname.
Error: Creation of a collection via $class failed.
The $class did compile, but it was not possible to create an object of that class using the options you specified.
Error: Don't know what type of collection you want to add.
If you add a collection, it must either by a collection object or a list of options which can be used to create a collection object. In the latter case, the type of collection must be specified.
Warning: No collection $name
The collection with $name does not exist and can not be created.
See the User::Identity website at http://perl.overmeer.net/userid/ for more details.
User::Identity version 0.90. Written by Mark Overmeer (mark@overmeer.net) See the ChangeLog for other contributors.
Copyright (c) 2003 by the author(s). All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
|
User::Identity::Archive - base class for archiving user information |