OVERLOADED

overload: @{}

When the reference to a collection object is used as array-reference, it will be shown as list of roles.

» Example:
 my $locations = $ui->collection('location');
 foreach my $loc (@$location) ...
 print $location->[0];
overload: stringification

Returns the name of the collection and a sorted list of defined items.

» Example:
 print "$collection\n";  #   location: home, work

METHODS

Constructors

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

description

User::Identity::Item

undef

item_type

<required>

name

User::Identity::Item

<required>

parent

User::Identity::Item

undef

roles

undef

description => STRING
item_type => CLASS
The CLASS which is used to store the information for each of the maintained objects within this collection.
name => STRING
parent => OBJECT
roles => ROLE|ARRAY
Immediately add some roles to this collection. In case of an ARRAY, each element of the array is passed separately to addRole(). So, you may end-up with an ARRAY of arrays each grouping a set of options to create a role.

Attributes

$obj->description
See description in User::Identity::Item.
$obj->itemType

Returns the type of the items collected.

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

Returns all defined roles within this collection. Be warned: the rules are returned in random (hash) order.

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.

Maintaining roles

$obj->addRole( ROLE| ( [NAME],OPTIONS ) | ARRAY-OF-OPTIONS )

Adds a new role to this collection. ROLE is an object of the right type (depends on the extension of this module which type that is) or a list of OPTIONS which are used to create such role. The options can also be passed as reference to an array. The added role is returned.

» Example:
 my $uicl = User::Identity::Collection::Locations->new;

 my $uil  = User::Identity::Location->new(home => ...);
 $uicl->addRole($uil);

 $uicl->addRole( home => address => 'street 32' );
 $uicl->addRole( [home => address => 'street 32'] );

Easier

 $ui      = User::Identity;
 $ui->add(location => 'home', address => 'street 32' );
 $ui->add(location => [ 'home', address => 'street 32' ] );
» Error: Cannot create a $type to add this to my collection.

Some options are specified to create a $type object, which is native to this collection. However, for some reason this failed.

» Error: Wrong type of role for $collection: requires a $expect but got a $type

Each $collection groups sets of roles of one specific type ($expect). You cannot add objects of a different $type.

$obj->removeRole( ROLE|NAME )

The deleted role is returned (if it existed).

$obj->renameRole( ROLE|OLDNAME, NEWNAME )

Give the role a different name, and move it in the collection.

» Error: Cannot rename $name into $newname: already exists
» Error: Cannot rename $name into $newname: doesn't exist
$obj->sorted

Returns the roles sorted by name, alphabetically and case-sensitive.

Searching

$obj->find( NAME|CODE|undef )

Find the object with the specified NAME in this collection. With undef, a randomly selected role is returned.

When a code reference is specified, all collected roles are scanned one after the other (in unknown order). For each role,

 CODE->($object, $collection)

is called. When the CODE returns true, the role is selected. In list context, all selected roles are returned. In scalar context, the first match is returned and the scan is aborted immediately.

» Example:
 my $emails = $ui->collection('emails');
 $emails->find('work');

 sub find_work($$) {
    my ($mail, $emails) = @_;
    $mail->location->name eq 'work';
 }
 my @at_work = $emails->find(\&find_work);
 my @at_work = $ui->find(location => \&find_work);
 my $any     = $ui->find(location => undef );