OVERLOADED

METHODS

Constructors

$class->new( [NAME], OPTIONS )
Option Defined in Default

abbreviations

[]

description

User::Identity::Item

undef

from

User::Identity::Archive

undef

name

User::Identity::Item

<required>

only

[]

parent

User::Identity::Item

undef

tabstop

8

abbreviations => HASH|ARRAY
Adds a set of abbreviations for collections to the syntax of the plain text archiver. See section Simplified class names for a list of predefined names.
description => STRING
from => FILEHANDLE|FILENAME
name => STRING
only => ARRAY|ABBREV
Lists the only information (as (list of) abbreviations) which should be read. Other information is removed before even checking whether it is a valid abbreviation or not.
parent => OBJECT
tabstop => INTEGER
Sets the default tab-stop width.

Attributes

$obj->abbreviation( NAME, [CLASS] )

Returns the class which is capable of storing information which is grouped as NAME. With CLASS argument, you add (or overrule) the definitions of an abbreviation. The CLASS is automatically loaded.

If CLASS is undef, then the abbreviation is deleted. The class name which is deleted is returned.

$obj->abbreviations

Returns a sorted list of all names which are known as abbreviations.

$obj->defaultTabStop( [INTEGER] )

Returns the width of a tab, optionally after setting it. This must be the same as set in your editor.

$obj->description
See description in User::Identity::Item.
$obj->name( [NEWNAME] )
See name in User::Identity::Item.

Collections

$obj->add( COLLECTION, ROLE )
See add in User::Identity::Item.
$obj->addCollection( OBJECT | ([TYPE], OPTIONS) )
See addCollection in User::Identity::Item.
$obj->collection( NAME )
See collection in User::Identity::Item.
$obj->find( COLLECTION, ROLE )
See find in User::Identity::Item.
$obj->parent( [PARENT] )
See parent in User::Identity::Item.
$obj->removeCollection( OBJECT|NAME )
See removeCollection in User::Identity::Item.
$obj->type
$class->type
See type in User::Identity::Item.
$obj->user
See user in User::Identity::Item.

Access to the archive

$obj->from( FILEHANDLE|FILENAME|ARRAY, OPTIONS )

Read the plain text information from the specified FILEHANDLE, FILENAME, STRING, or ARRAY of lines.

Option Default

tabstop

<default from object>

verbose

0

tabstop => INTEGER
verbose => INTEGER
» Warning: Cannot read archive from $source