The Perl Toolchain Summit 2025 Needs You: You can help 🙏 Learn more

VOEGELAS / Geo-Location-IP-0.003 / lib / Geo / Location / IP / Record / City.pm 

            

              
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

              
package Geo::Location::IP::Record::City;
# SPDX-License-Identifier: Artistic-1.0-Perl OR GPL-1.0-or-later
use 5.026;
use warnings;
use utf8;
use Object::Pad;
class Geo::Location::IP::Record::City;
our $VERSION = 0.003;
apply Geo::Location::IP::Role::Record::HasConfidence;
apply Geo::Location::IP::Role::Record::HasGeoNameId;
apply Geo::Location::IP::Role::Record::HasNames;
sub _from_hash ($class, $hash_ref, $locales) {
    return $class->new(
        names      => $hash_ref->{names}      // {},
        confidence => $hash_ref->{confidence} // undef,
        geoname_id => $hash_ref->{geoname_id} // undef,
        locales    => $locales,
    );
}
use overload
    q{""} => \&stringify;
sub stringify {
    my $self = shift;
    return $self->name;
}
1;
__END__
=encoding UTF-8
=head1 NAME
Geo::Location::IP::Record::City - City details
=head1 VERSION
version 0.003
=head1 SYNOPSIS
  use Geo::Location::IP::Database::Reader;
  my $reader = Geo::Location::IP::Database::Reader->new(
    file => '/path/to/City.mmdb',
  );
  eval {
    my $city_model = $reader->city(ip => '1.2.3.4');
    my $city       = $city_model->city;
  };
=head1 DESCRIPTION
This class contains details about the city associated with an IP address.
All fields may be undefined.
=head1 SUBROUTINES/METHODS
=head2 new
  my $city = Geo::Location::IP::Record::City->new(
    names => {
      de => 'Köln',
      en => 'Cologne',
      ja => 'ケルン',
    },
    confidence => 100,
    geoname_id => 2886242,
    locales    => ['jp', 'en'],
  );
Creates a new city record.
=head2 confidence
  my $confidence = $city->confidence;
Returns a value in the range from 0 to 100 that indicates the confidence that
the city is correct.
=head2 geoname_id
  my $geoname_id = $city->geoname_id;
Returns the city's GeoNames identifier as a number.
=head2 name
  my $name = $city->name;
Returns the city's name in the chosen language.
=head2 names
  my %names = %{$city->names};
Returns a hash reference that maps locale codes to localized names.
=for Pod::Coverage DOES META stringify
=head1 DIAGNOSTICS
None.
=head1 CONFIGURATION AND ENVIRONMENT
None.
=head1 DEPENDENCIES
None.
=head1 INCOMPATIBILITIES
None.
=head1 BUGS AND LIMITATIONS
None known.
=head1 AUTHOR
Andreas Vögele E<lt>voegelas@cpan.orgE<gt>
=head1 LICENSE AND COPYRIGHT
Copyright (C) 2025 Andreas Vögele
This module is free software; you can redistribute it and/or modify it under
the same terms as Perl itself.
=cut