User::I...ocation(3)

📦
version 4.00 · 9 versions
, in fedora 44

hey bestie! welcome to the User::Identity::Location manpage, from the User Contributed Perl Documentation, section 3. let's get into it 💅

✨ NAME ✨

User::Identity::Location - physical location of a person

💫 INHERITANCE 💫

        User::Identity::Location
          is a User::Identity::Item

🌸 SYNOPSIS 🌸

         use User::Identity;
         use User::Identity::Location;
         my $me   = User::Identity->new(...);
         my $addr = User::Identity::Location->new(...);
         $me->add(location => $addr);

         # Simpler

         use User::Identity;
         my $me   = User::Identity->new(...);
         my $addr = $me->add(location => ...);

🦋 DESCRIPTION 🦋

okay so the User::Identity::Location object is literally holding the description of a physical location of a person: home, work, travel. The locations are collected by a User::Identity::Collection::Locations object.

Nearly all methods can return undef. Some methods produce language or country specific output.

Extends "DESCRIPTION" in User::Identity::Item.

✨ METHODS ✨

Extends "METHODS" in User::Identity::Item.

🎀 Constructors

Extends "Constructors" in User::Identity::Item.

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

Create a new location. You can specify a name as first argument, or in the OPTION list. Without a specific name, the organization is used as name.

            -Option      --Defined in          --Default
             country                             undef
             country_code                        undef
             description   User::Identity::Item  undef
             fax                                 undef
             name          User::Identity::Item  <required>
             organization                        undef
             parent        User::Identity::Item  undef
             pc                                  undef
             phone                               undef
             pobox                               undef
             pobox_pc                            undef
             postal_code                         <value of option pc>
             state                               undef
             street                              undef
  • country => STRING — the country.
  • country_code => STRING — the country code.
  • description => STRING — a description.
  • fax => STRING|ARRAY — one or more fax numbers.
  • name => STRING — the name.
  • organization => STRING — the organization.
  • parent => OBJECT — the parent object.
  • pc => STRING — Short name for postal_code.
  • phone => STRING|ARRAY — one or more phone numbers.
  • pobox => STRING — a Post Office box.
  • pobox_pc => STRING — the PO box postal code.
  • postal_code => STRING — the postal code.
  • state => STRING — the state.
  • street => STRING — the street.

🌟 Attributes

Extends "Attributes" in User::Identity::Item.

  • $obj->city() — The city where the address is located. 🏙️
  • $obj->country() — The country where the address is located. If the name of the country is not known but a country code is defined, the name will be looked-up using Geography::Countries (if installed).
  • $obj->countryCode() — Each country has an ISO standard abbreviation. Specify the country or the country code, and the other will be filled in automatically.
  • $obj->description() — Inherited, see "Attributes" in User::Identity::Item
  • $obj->fax() — One or more fax numbers, like phone().
  • $obj->fullAddress() — Create an address to put on a postal mailing, in the format as normal in the country where it must go to. To be able to achieve that, the country code must be known. If the city is not specified or no street or pobox is given, undef will be returned: an incomplete address.
         » example:

           print $uil->fullAddress;
           print $user->find(location => 'home')->fullAddress;
  • $obj->name( [$newname] ) — Inherited, see "Attributes" in User::Identity::Item
  • $obj->organization() — The organization (for instance company) which is related to this location.
  • $obj->phone() — One or more phone numbers. Please use the international notation, which starts with '+', for instance "+31-26-12131". In scalar context, only the first number is produced. In list context, all numbers are presented.
  • $obj->pobox() — Post Office mail box specification. Use "P.O.Box 314", not simple 314.
  • $obj->poboxPostalCode() — The postal code related to the Post-Office mail box. Defined by new() option "pobox_pc".
  • $obj->postalCode() — The postal code is very country dependent. Also, the location of the code within the formatted string is country dependent.
  • $obj->state() — The state, which is important for some countries but certainly not for the smaller ones. Only set this value when you state has to appear on printed addresses.
  • $obj->street() — Returns the address of this location. Since Perl 5.7.3, you can use unicode in strings, so why not format the address nicely?

🗂️ Collections

Extends "Collections" in User::Identity::Item.

  • $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

🔍 Searching

Extends "Searching" in User::Identity::Item.

  • $obj->find($collection, $role) — Inherited, see "Searching" in User::Identity::Item

🚨 DIAGNOSTICS 🚨

  • 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: 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()

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

and that's the tea, bestie! this page was brought to you by perl v5.42.0, dated 2026-01-17, and the User::I...ocation(3) vibe 💖✨
📦 where this page comes from