Scroll to navigation

GeoIP2::Record::Subdivision(3pm) User Contributed Perl Documentation GeoIP2::Record::Subdivision(3pm)

NAME

GeoIP2::Record::Subdivision - Contains data for the subdivision record associated with an IP address

VERSION

version 2.006002

SYNOPSIS

  use 5.008;
  use GeoIP2::WebService::Client;
  my $client = GeoIP2::WebService::Client->new(
      account_id  => 42,
      license_key => 'abcdef123456',
  );
  my $insights = $client->insights( ip => '24.24.24.24' );
  my $subdivision_rec = $insights->most_specific_subdivision();
  print $subdivision_rec->name(), "\n";

DESCRIPTION

This class contains the subdivision-level data associated with an IP address. A subdivision is a sub-country level administrative boundary, such as a province or state.

This record is returned by all the end points except the Country end point.

METHODS

This class provides the following methods:

$subdivision_rec->confidence()

This returns a value from 0-100 indicating MaxMind's confidence that the subdivision is correct.

This attribute is only available from the Insights end point and the GeoIP2 Enterprise database.

$subdivision_rec->geoname_id()

This returns a "geoname_id" for the subdivision.

This attribute is returned by all end points except the Country end point.

$subdivision_rec->iso_code()

This returns a string up to three characters long contain the subdivision portion of the ISO 3166-2 code (<http://en.wikipedia.org/wiki/ISO_3166-2>).

This attribute is returned by all end points except the Country end point.

$subdivision_rec->name()

This returns a name for the subdivision. The locale chosen depends on the "locales" argument that was passed to the record's constructor. This will be passed through from the GeoIP2::WebService::Client object you used to fetch the data that populated this record.

If the record does not have a name in any of the locales you asked for, this method returns "undef".

This attribute is returned by all end points except the Country end point.

$subdivision_rec->names()

This returns a hash reference where the keys are locale codes and the values are names. See GeoIP2::WebService::Client for a list of the possible locale codes.

This attribute is returned by all end points except the Country end point.

SUPPORT

Bugs may be submitted through <https://github.com/maxmind/GeoIP2-perl/issues>.

AUTHORS

  • Dave Rolsky <drolsky@maxmind.com>
  • Greg Oschwald <goschwald@maxmind.com>
  • Mark Fowler <mfowler@maxmind.com>
  • Olaf Alders <oalders@maxmind.com>

COPYRIGHT AND LICENSE

This software is copyright (c) 2013 - 2019 by MaxMind, Inc.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

2022-11-21 perl v5.36.0