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->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.

Searching

$obj->find( $collection, $role )
See find in User::Identity::Item.

Access to the archive

$obj->from( <$fh|$filename|ARRAY>, %options )

Read the plain text information from the specified $fh, $filename, STRING, or ARRAY of lines.

Option Default

tabstop

<default from object>

verbose

0

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