NAME

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

CLASS INHERITANCE

 User::Identity::Location
   is a User::Identity::Collection::Item
   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::Indentity->new(...);
 my $addr = $me->add(location => ...);

DESCRIPTION

The User::Identity::Location object contains 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.

METHODS

Initiation

new [NAME], OPTIONS

(Class method) 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               DEFAULT
 country              undef
 country_code         undef
 description          undef
 fax                  undef
 name                 <required>
 organization         undef
 pobox                undef
 pobox_pc             undef
 postal_code          undef
 state                undef
 street               undef
 telephone            undef
 user                 undef

country => STRING

country_code => STRING

description => STRING

See User::Identity::Item::new(description)

fax => STRING|ARRAY

name => STRING

See User::Identity::Item::new(name)

organization => STRING

pobox => STRING

pobox_pc => STRING

postal_code => STRING

state => STRING

street => STRING

telephone => STRING|ARRAY

user => OBJECT

See User::Identity::Collection::Item::new(user)

Attributes

city

The city where the address is located.

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

countryCode

Each country has an ISO standard abbreviation. Specify the country or the country code, and the other will be filled in automatically.

description

See User::Identity::Item::description()

fax

One or more fax numbers. Like the telephone() method above.

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.

 print $uil->fullAddress;
 print $user->find(location => 'home')->fullAddress;

name

See User::Identity::Item::name()

organization

The organization (for instance company) which is related to this location.

pobox

Post Office mail box specification. Use "P.O.Box 314", not simple 314.

poboxPostalCode

The postal code related to the Post-Office mail box. Defined by new() option pobox_pc.

postalCode

The postal code is very country dependent. Also, the location of the code within the formatted string is country dependent.

state

The state, which is important for some contries but certainly not for the smaller ones. Only set this value when you state has to appear on printed addresses.

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?

telephone

One or more phone numbers. Please use the internation 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.

user [USER]

See User::Identity::Collection::Item::user()

SEE ALSO

See the website at http://perl.overmeer.net/userid/.

AUTHOR

Written by Mark Overmeer (mark@overmeer.net) with the help of many. See the ChangeLog for details.

VERSION

This code is beta, version 0.03.

Copyright (c) 2003 by the authors. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.