/usr/share/perl5/User/Identity/Location.pod is in libuser-identity-perl 0.93-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 | =head1 NAME
User::Identity::Location - physical location of a person
=head1 INHERITANCE
User::Identity::Location
is a User::Identity::Item
=head1 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 => ...);
=head1 DESCRIPTION
The C<User::Identity::Location> object contains the description of a physical
location of a person: home, work, travel. The locations are collected
by a L<User::Identity::Collection::Locations|User::Identity::Collection::Locations> object.
Nearly all methods can return C<undef>. Some methods produce language or
country specific output.
=head1 METHODS
=head2 Constructors
User::Identity::Location-E<gt>B<new>([NAME], OPTIONS)
=over 4
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
=over 4
Short name for C<postal_code>.
=back
. phone => STRING|ARRAY
. pobox => STRING
. pobox_pc => STRING
. postal_code => STRING
. state => STRING
. street => STRING
=back
=head2 Attributes
$obj-E<gt>B<city>
=over 4
The city where the address is located.
=back
$obj-E<gt>B<country>
=over 4
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).
=back
$obj-E<gt>B<countryCode>
=over 4
Each country has an ISO standard abbreviation. Specify the country or the
country code, and the other will be filled in automatically.
=back
$obj-E<gt>B<description>
=over 4
See L<User::Identity::Item/"Attributes">
=back
$obj-E<gt>B<fax>
=over 4
One or more fax numbers, like L<phone()|User::Identity::Location/"Attributes">.
=back
$obj-E<gt>B<fullAddress>
=over 4
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;
=back
$obj-E<gt>B<name>([NEWNAME])
=over 4
See L<User::Identity::Item/"Attributes">
=back
$obj-E<gt>B<organization>
=over 4
The organization (for instance company) which is related to this location.
=back
$obj-E<gt>B<phone>
=over 4
One or more phone numbers. Please use the internation notation, which
starts with C<'+'>, for instance C<+31-26-12131>. In scalar context,
only the first number is produced. In list context, all numbers are
presented.
=back
$obj-E<gt>B<pobox>
=over 4
Post Office mail box specification. Use C<"P.O.Box 314">, not simple C<314>.
=back
$obj-E<gt>B<poboxPostalCode>
=over 4
The postal code related to the Post-Office mail box. Defined by new() option
C<pobox_pc>.
=back
$obj-E<gt>B<postalCode>
=over 4
The postal code is very country dependent. Also, the location of the
code within the formatted string is country dependent.
=back
$obj-E<gt>B<state>
=over 4
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.
=back
$obj-E<gt>B<street>
=over 4
Returns the address of this location. Since Perl 5.7.3, you can use
unicode in strings, so why not format the address nicely?
=back
=head2 Collections
$obj-E<gt>B<add>(COLLECTION, ROLE)
=over 4
See L<User::Identity::Item/"Collections">
=back
$obj-E<gt>B<addCollection>(OBJECT | ([TYPE], OPTIONS))
=over 4
See L<User::Identity::Item/"Collections">
=back
$obj-E<gt>B<collection>(NAME)
=over 4
See L<User::Identity::Item/"Collections">
=back
$obj-E<gt>B<find>(COLLECTION, ROLE)
=over 4
See L<User::Identity::Item/"Collections">
=back
$obj-E<gt>B<parent>([PARENT])
=over 4
See L<User::Identity::Item/"Collections">
=back
$obj-E<gt>B<removeCollection>(OBJECT|NAME)
=over 4
See L<User::Identity::Item/"Collections">
=back
$obj-E<gt>B<type>
User::Identity::Location-E<gt>B<type>
=over 4
See L<User::Identity::Item/"Collections">
=back
$obj-E<gt>B<user>
=over 4
See L<User::Identity::Item/"Collections">
=back
=head1 DIAGNOSTICS
Error: $object is not a collection.
=over 4
The first argument is an object, but not of a class which extends
L<User::Identity::Collection|User::Identity::Collection>.
=back
Error: Cannot load collection module for $type ($class).
=over 4
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.
=back
Error: Creation of a collection via $class failed.
=over 4
The $class did compile, but it was not possible to create an object
of that class using the options you specified.
=back
Error: Don't know what type of collection you want to add.
=over 4
If you add a collection, it must either by a collection object or a
list of options which can be used to create a collection object. In
the latter case, the type of collection must be specified.
=back
Warning: No collection $name
=over 4
The collection with $name does not exist and can not be created.
=back
=head1 SEE ALSO
This module is part of User-Identity distribution version 0.93,
built on December 24, 2009. Website: F<http://perl.overmeer.net/userid/>
=head1 LICENSE
Copyrights 2003,2004,2007-2009 by Mark Overmeer <perl@overmeer.net>. For other contributors see Changes.
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
See F<http://www.perl.com/perl/misc/Artistic.html>
|