Dave Rolsky > GeoIP2-0.0302 > GeoIP2::Record::Subdivision

Download:
GeoIP2-0.0302.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.0302   Source   Latest Release: GeoIP2-0.040002

NAME ^

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

VERSION ^

version 0.0302

SYNOPSIS ^

  use 5.008;

  use GeoIP2::WebService::Client;

  my $client = GeoIP2::WebService::Client->new(
      user_id     => 42,
      license_key => 'abcdef123456',
  );

  my $omni = $client->omni( ip => '24.24.24.24' );

  my $subdivision_rec = $omni->subdivision();
  say $subdivision_rec->name();

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 Omni end point.

$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 language chosen depends on the languages 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 languages 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 language codes and the values are names. See GeoIP2::WebService::Client for a list of the possible language codes.

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

AUTHORS ^

CONTRIBUTOR ^

Graham Knop <haarg@haarg.org>

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2013 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.

syntax highlighting: