GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  USER::IDENTITY::ARCHIVE (3)

.ds Aq ’

NAME

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

CONTENTS

INHERITANCE



 User::Identity::Archive
   is a User::Identity::Item

 User::Identity::Archive is extended by
   User::Identity::Archive::Plain



SYNOPSIS



 use User::Identity::Archive::Plain;
 my $friends = User::Identity::Archive::Plain->new(friends);
 $friends->from(\*FH);
 $friends->from(.friends);



DESCRIPTION

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.

Extends DESCRIPTION in User::Identity::Item.

OVERLOADED

METHODS

Extends METHODS in User::Identity::Item.

    Constructors

Extends Constructors in User::Identity::Item.
User::Identity::Archive-><B>newB>( [NAME], OPTIONS )


 -Option     --Defined in          --Default
  description  User::Identity::Item  undef
  from                               undef
  name         User::Identity::Item  <required>
  parent       User::Identity::Item  undef



description => STRING
from => FILEHANDLE|FILENAME
name => STRING
parent => OBJECT

    Attributes

Extends Attributes in User::Identity::Item.
$obj-><B>descriptionB>() Inherited, see Attributes in User::Identity::Item
$obj-><B>nameB>( [NEWNAME] ) Inherited, see Attributes in User::Identity::Item

    Collections

Extends Collections in User::Identity::Item.
$obj-><B>addB>(COLLECTION, ROLE) Inherited, see Collections in User::Identity::Item
$obj-><B>addCollectionB>(OBJECT | ([TYPE], OPTIONS)) Inherited, see Collections in User::Identity::Item
$obj-><B>collectionB>(NAME) Inherited, see Collections in User::Identity::Item
$obj-><B>findB>(COLLECTION, ROLE) Inherited, see Collections in User::Identity::Item
$obj-><B>parentB>( [PARENT] ) Inherited, see Collections in User::Identity::Item
$obj-><B>removeCollectionB>(OBJECT|NAME) Inherited, see Collections in User::Identity::Item
$obj-><B>typeB>()
User::Identity::Archive-><B>typeB>() Inherited, see Collections in User::Identity::Item
$obj-><B>userB>() Inherited, see Collections in User::Identity::Item

    Access to the archive

$obj-><B>fromB>(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);



DIAGNOSTICS

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 ALSO

This module is part of User-Identity distribution version 0.94, built on January 24, 2014. Website: http://perl.overmeer.net/userid/

LICENSE

Copyrights 2003-2014 by [Mark Overmeer <perl@overmeer.net>]. For other contributors see Changes.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See http://www.perl.com/perl/misc/Artistic.html

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 USER::IDENTITY::ARCHIVE (3) 2014-01-24

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.