METHODS

Constructors

$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
country_code => STRING
description => STRING
fax => STRING|ARRAY
name => STRING
organization => STRING
parent => OBJECT
pc => STRING
Short name for postal_code.
phone => STRING|ARRAY
pobox => STRING
pobox_pc => STRING
postal_code => STRING
state => STRING
street => STRING

Attributes

$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
See description 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] )
See name 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

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