User::I...ocations(3)

okay bestie, welcome to User::I...ocations(3) from User Contributed Perl Documentation πŸ’– no cap, this is the manual page for User::Identity::Collection::Locations.

✨ NAME ✨

User::Identity::Collection::Locations β€” a collection of locations πŸ—ΊοΈβœ¨

🧬 INHERITANCE 🧬

User::Identity::Collection::Locations
  is a User::Identity::Collection
  is a User::Identity::Item

🌸 SYNOPSIS 🌸

(this section is literally empty in the original β€” iconic minimalism, no notes) πŸ’€βœ¨

πŸ’– DESCRIPTION πŸ’–

okay so this User::Identity::Collection::Locations object maintains a set User::Identity::Location objects, each describing a physical location. πŸ—ΊοΈπŸ‘‘

Extends DESCRIPTION in User::Identity::Collection.


πŸ¦‹ OVERLOADED πŸ¦‹

Extends OVERLOADED in User::Identity::Collection.

  • overload: "" stringification β€” Inherited, see OVERLOADED in User::Identity::Collection
  • overload: @{} array dereference β€” Inherited, see OVERLOADED in User::Identity::Collection

πŸ› οΈ METHODS πŸ› οΈ

Extends METHODS in User::Identity::Collection.

πŸ‘‘ Constructors

Extends Constructors in User::Identity::Collection.

$class->new( [$name], %options )

-Option     --Defined in                --Default
 description  User::Identity::Item        undef
 item_type    User::Identity::Collection  User::Identity::Location
 name         User::Identity::Item        'locations'
 parent       User::Identity::Item        undef
 roles        User::Identity::Collection  undef
  • description => STRING
  • item_type => CLASS
  • name => STRING
  • parent => OBJECT
  • roles => $role|\@roles

🧬 Attributes

Extends Attributes in User::Identity::Collection.

  • $obj->description() β€” Inherited, see Attributes in User::Identity::Item
  • $obj->itemType() β€” Inherited, see Attributes in User::Identity::Collection
  • $obj->name( [$newname] ) β€” Inherited, see Attributes in User::Identity::Item
  • $obj->roles() β€” Inherited, see Attributes in User::Identity::Collection

πŸ“š Collections

Extends Collections in User::Identity::Collection.

  • $obj->add($collection, $role) β€” Inherited, see Collections in User::Identity::Item
  • $obj->addCollection( $object | <[$type], %options> ) β€” Inherited, see Collections in User::Identity::Item
  • $obj->collection($name) β€” Inherited, see Collections in User::Identity::Item
  • $obj->parent( [$parent] ) β€” Inherited, see Collections in User::Identity::Item
  • $obj->removeCollection($object|$name) β€” Inherited, see Collections in User::Identity::Item
  • $any->type() β€” Inherited, see Collections in User::Identity::Item
  • $obj->user() β€” Inherited, see Collections in User::Identity::Item

πŸ‘‘ Maintaining roles

Extends Maintaining roles in User::Identity::Collection.

  • $obj->addRole($role|([$name], %options)) β€” Inherited, see Maintaining roles in User::Identity::Collection
  • $obj->removeRole($role|$name) β€” Inherited, see Maintaining roles in User::Identity::Collection
  • $obj->renameRole( <$role|$oldname>, $newname ) β€” Inherited, see Maintaining roles in User::Identity::Collection
  • $obj->sorted() β€” Inherited, see Maintaining roles in User::Identity::Collection

πŸ” Searching

Extends Searching in User::Identity::Collection.

  • $obj->find($name|CODE|undef) β€” Inherited, see Searching in User::Identity::Collection

🚨 DIAGNOSTICS 🚨

  • 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. Cast by addRole()
  • 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. Cast by addCollection()
  • Error: cannot rename $from into $to: already exists. Cast by renameRole()
  • Error: cannot rename $from into $to: doesn't exist. Cast by renameRole()
  • Error: nvalid collection $name. The collection with $name does not exist and can not be created. Cast by add()
  • Error: this $object is not a collection. Cast by addCollection()
  • 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. Cast by addRole()

πŸ‘€ SEE ALSO πŸ‘€

This module is part of User-Identity version 4.00, built on December 12, 2025. Website: http://perl.overmeer.net/CPAN/

πŸ“œ LICENSE πŸ“œ

For contributors see file ChangeLog.

This software is copyright (c) 2003-2025 by Mark Overmeer.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.


signed off with perl v5.42.0 on 2026-01-17 β€” this page is User::I...ocations(3) πŸ’– and yes, User-Identity version 4.00, built on December 12, 2025. periodt ✨🫢

πŸ“¦ where this page comes from